disvite
    Preparing search index...

    Interface CacheStore

    Interface representing a cache store for holding guild invite codes and use counts.

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

    Implemented by

    Index

    Methods

    clear delete deleteInvite? get getInviteUses? set setInviteUses?

    Methods

    • Clear all cached invites across all guilds.

      Returns void | Promise<void>

    • Remove a guild's invites from the cache.

      Parameters

      • guildId: string

      Returns void | Promise<void>

    • O(1) removal of single invite code from cache.

      Parameters

      • guildId: string
      • code: string

      Returns void | Promise<void>

    • Retrieve cached invites mapping (invite code -> use count) for a guild.

      Parameters

      • guildId: string

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

    • O(1) fetch of single invite code use count.

      Parameters

      • guildId: string
      • code: string

      Returns number | Promise<number | undefined> | undefined

    • Store invites mapping for a guild.

      Parameters

      • guildId: string
      • invites: Map<string, number>

      Returns void | Promise<void>

    • O(1) update of single invite code use count.

      Parameters

      • guildId: string
      • code: string
      • uses: number

      Returns void | Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods