levitate.djs v0.1.6

levitate.djs

A module for discord.js which allows you to choose what gets cached and what not. It uses discord.js' structuring system + overriding some of the managers. This module is experimental and also barely tested. There may be a better way of doing this in the future!

Install

npm i levitate.djs

Features

• Option to not cache bots / certain IDs / any members in guild.members
• Option to not cache bots / certain IDs in client.users
• Option to not cache voice / text channels / categories in client.channels and guild.channels
• Option to not cache emojis in client.emojis and guild.emojis
• Option to not cache message reactions in message.reactions
• Custom cache types (LimitedCollection comes out of the box)
• Remove specific properties of the guild object

Usage

const LevitatingClient = require("levitate.djs");

const client = new LevitatingClient(options, djsOptions);

API

LevitateClient

Extends Discord.Client.

constructor

Creating a client would look like this:

const client = new Client({
   members: {
    ignoreBots: true, 
    ignoreIDs: [], 
    cache: true 
   },
   channels: {
      ignoreVoice: true, 
      ignoreCategories: true, 
      ignoreText: false 
   },
   users: {
      ignoreBots: true, 
      ignoreIDs: ["356819274691510293"],
   },
   ignoreEmojis: true, 
   ignorePresences: true  
});

Custom Caches

levitate.djs provides 1 custom cache type: LimitedCollection. It's similar to discord.js' limited collection.

Example usage:

const client = new Client({
   members: {
    ignoreBots: true, // Doesn't cache any bots, but the "message" event WILL fire when bots send messages!
    cacheType: Client.LimitedCollection.generate(limit, id, iterable)
   }
});

limit is how many pairs the collection can hold. If id is provided, the specified ID will never get deleted from the collection to make space for other objects. This was mainly added to never uncache the bot itself.

Message#mentions

If you aren't caching any users/members/channels then it's likely that message.mentions.users/members/channels will be empty. Levitate.djs replaces the mentions object with a new one which looks like this:

{
   users: [],
   roles: [],
   channels: [],
   everyone: true|false
}

users contains an array of user objects, which themselves contain a member property. Roles contains an array of role IDs, since roles stay cached you can get the role object via guild.roles.cache.get. channels contains an array of the mentioned channels id.

Side Effects

There will most likely be side effects. Some obvious side effects:

• If ignorePresences is set to true, data in GuildMember#presence will likely be outdated, and may not even exist.
• If members.cache is set to false, Guild.owner will always be null.
• If ignoreEmojis is set to true, you won't be able to get any emoji objects from events or the caches, same with ignorePresences

There are a lot more. If you have a basic text chat bot, I suggest using this configuration:

const client = new Client({
   members: {
    ignoreBots: true, // Set this to true if your bot doesn't interact with other bots, doesn't use their information. Don't use this if you have a "server info" command or similar
   },
   channels: {
      ignoreVoice: true, // If your bot only uses text channels, it should ignore voice ones
      ignoreCategories: true, // If you bot doesn't take advantage of the `channel.parent` property, keep this to true
   },
   users: {
      ignoreBots: true, // Set this to true if your bot doesn't interact with other bots, doesn't use their information. Don't use this if you have a "server info" command or similar
   },
   ignoreEmojis: true, // Leave this to true if your bot doesn't use any custom emojis / doesn't have any custom emojis related statistics.
   ignorePresences: true,
   ignoreProps: ["afkChannelID", ".applicationID", "banner", "description", "embedChannelID", "embedEnabled", "memberCount", "features", "nameAcronym", "premiumSubscriptionCount", "systemChannelID", "vanityURLCode", "verificationLevel", "verified", "voice", "voiceStates", "widgetChannelID", "region", "defaultMessageNotifications"]
});