@sodiumlabs/plume-url

Plume URL.js

About

@sodiumlabs/plume-url is a module that allows you to easily use Plume URL.

Installation

npm install @sodiumlabs/plume-url

Links

• Plume URL
• Plume URL documentation
• Module documentation
• Discord server
• GitHub
• npm
• Sodium Labs

Examples

If you are developing a Discord bot using discord.js, here is how to use Plume URL:

const { Client } = require("discord.js");
const { PlumeURL } = require("@sodiumlabs/plume-url");

// Your discord.js client
const client = new Client({
    /* ... */
});

// Attach PlumeURL to your client
client.plumeURL = new PlumeURL({ apiKey: "YOUR-API-KEY" });

You can now use Plume URL anywhere in your bot.
For example, in a slash command:

const userId = "619838036846575617";

// Create a new URL
const data = await client.plumeURL.createURL({
    url: "https://google.com",
    customId: userId, // The custom ID allows your users to retrieve their URLs later
});
console.log(data);

// Search for the URLs you created
// You can filter by custom ID if needed
const urls = await client.plumeURL.search({ limit: 5, customId: userId });
console.log(urls);

Documentation

Plume URL provides two main resources for documentation:

• API Reference:
  Plume URL Documentation
  This documentation covers all available endpoints, types, and detailed comments for the API.

• Module Reference:
  Module Documentation
  This documentation explains how to use the @sodiumlabs/plume-url npm package, with all available methods and types.

For most use cases, you'll want to refer to the PlumeURL class page, which lists all available methods for interacting with the API through this module.

Help

If you don't understand something in the documentation, are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official Discord Server.