Interface CacheStore

Interface representing a generic store for caching guild invite use counts.

interface CacheStore {
    clear(): void | Promise<void>;
    delete(guildId: string): void | Promise<void>;
    get(
        guildId: string,
    ):
        | Map<string, number>
        | Promise<Map<string, number> | undefined>
        | undefined;
    set(guildId: string, invites: Map<string, number>): void | Promise<void>;
}

Implemented by

InMemoryCacheStore

Index

Methods

clear delete get set

Methods

clear

clear(): void | Promise<void>
Clear all cached invites across all guilds.

Returns void | Promise<void>
- Defined in src/types.ts:75

delete

delete(guildId: string): void | Promise<void>
Remove a guild's invites from the cache.
Parameters
- guildId: string
Returns void | Promise<void>
- Defined in src/types.ts:70

get

get(
    guildId: string,
):
    | Map<string, number>
    | Promise<Map<string, number> | undefined>
    | undefined
Retrieve cached invites mapping (invite code -> use count) for a guild.
Parameters
- guildId: string
Returns Map<string, number> | Promise<Map<string, number> | undefined> | undefined
- Defined in src/types.ts:60

set

set(guildId: string, invites: Map<string, number>): void | Promise<void>
Store invites mapping for a guild.
Parameters
- guildId: string
- invites: Map<string, number>
Returns void | Promise<void>
- Defined in src/types.ts:65

Interface CacheStore

Implemented by

Index

Methods

Methods

clear

Returns void | Promise<void>

delete

Parameters

Returns void | Promise<void>

get

Parameters

Returns Map<string, number> | Promise<Map<string, number> | undefined> | undefined

set

Parameters

Returns void | Promise<void>

Settings

On This Page