Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-09 16:13:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

types(Options): add types for cacheWithLimits (#6095)

Browse Source
This commit is contained in:
DTrombett
2021-07-16 13:20:38 +02:00
committed by GitHub
parent 576eee8de2
commit 8db6df3d1e
3 changed files with 35 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/util/Options.js
View File

@@ -22,7 +22,7 @@
* @typedef {Function} CacheFactory
* @param {Function} manager The manager class the cache is being requested from.
* @param {Function} holds The class that the cache will hold.
* @returns {Collection} Cache instance that follows collection interface.
* @returns {Collection} A Collection used to store the cache of the manager.
*/
/**
@@ -34,8 +34,7 @@
* @property {number} [shardCount=1] The total amount of shards used by all processes of this bot
* (e.g. recommended shard count, shard count of the ShardingManager)
* @property {CacheFactory} [makeCache] Function to create a cache.
* (-1 or Infinity for unlimited - don't do this without message sweeping, otherwise memory usage will climb
* indefinitely)
* You can use your own function, or the {@link Options} class to customize the Collection used for the cache.
* @property {number} [messageCacheLifetime=0] How long a message should stay in the cache until it is considered
* sweepable (in seconds, 0 for forever)
* @property {number} [messageSweepInterval=0] How frequently to remove messages from the cache that are older than

33
typings/index.d.ts vendored
View File

@@ -366,7 +366,7 @@ export class ClientUser extends User {
export class Options extends null {
private constructor();
public static createDefaultOptions(): ClientOptions;
public static cacheWithLimits(limits?: Record<string, number>): CacheFactory;
public static cacheWithLimits(limits?: CacheWithLimitOptions): CacheFactory;
public static cacheEverything(): CacheFactory;
}
@@ -2739,7 +2739,36 @@ export type BitFieldResolvable<T extends string, N extends number | bigint> =
export type BufferResolvable = Buffer | string;
export type CacheFactory = <T>(manager: { name: string }, holds: { name: string }) => Collection<Snowflake, T>;
export type CachedManagerTypes = keyof CacheFactoryArgs;
export type CacheFactory = <T extends CachedManagerTypes>(
...args: CacheFactoryArgs[T]
) => Collection<Snowflake, CacheFactoryArgs[T][1]>;
export interface CacheFactoryArgs {
ApplicationCommandManager: [manager: typeof ApplicationCommandManager, holds: typeof ApplicationCommand];
BaseGuildEmojiManager: [manager: typeof BaseGuildEmojiManager, holds: typeof GuildEmoji];
ChannelManager: [manager: typeof ChannelManager, holds: typeof Channel];
GuildChannelManager: [manager: typeof GuildChannelManager, holds: typeof GuildChannel];
GuildManager: [manager: typeof GuildManager, holds: typeof Guild];
GuildMemberManager: [manager: typeof GuildMemberManager, holds: typeof GuildMember];
GuildBanManager: [manager: typeof GuildBanManager, holds: typeof GuildBan];
MessageManager: [manager: typeof MessageManager, holds: typeof Message];
PermissionOverwriteManager: [manager: typeof PermissionOverwriteManager, holds: typeof PermissionOverwrites];
PresenceManager: [manager: typeof PresenceManager, holds: typeof Presence];
ReactionManager: [manager: typeof ReactionManager, holds: typeof MessageReaction];
ReactionUserManager: [manager: typeof ReactionUserManager, holds: typeof User];
RoleManager: [manager: typeof RoleManager, holds: typeof Role];
StageInstanceManager: [manager: typeof StageInstanceManager, holds: typeof StageInstance];
ThreadManager: [manager: typeof ThreadManager, holds: typeof ThreadChannel];
ThreadMemberManager: [manager: typeof ThreadMemberManager, holds: typeof ThreadMember];
UserManager: [manager: typeof UserManager, holds: typeof User];
VoiceStateManager: [manager: typeof VoiceStateManager, holds: typeof VoiceState];
}
export type CacheWithLimitOptions = {
[K in CachedManagerTypes]?: number;
};
export interface ChannelCreationOverwrites {
allow?: PermissionResolvable;

2
typings/index.ts
View File

@@ -53,6 +53,8 @@ const client: Client = new Client({
intents: Intents.FLAGS.GUILDS,
makeCache: Options.cacheWithLimits({
MessageManager: 200,
// @ts-expect-error
Message: 100,
}),
});