Class BaseCacheManager<T>

constructor

• new BaseCacheManager<T>(
      client: Client,
      options: { structureType: StaticManagerType<T> },
  ): BaseCacheManager<T>

  Creates a cache manager.

  Type Parameters

  • T

  Parameters

  • client: Client

    The client instance.
  • options: { structureType: StaticManagerType<T> }

    The options for the cache manager.

    • structureType: StaticManagerType<T>

      The structure type for the cache manager.

  Returns BaseCacheManager<T>

  Throws

Staticrules

size

• get size(): number

  Returns the size of the cache.

  Returns number

_intervalCallback

• _intervalCallback(): { i: StructureIdentifiers }

  The callback for expiring buckets.

  Returns { i: StructureIdentifiers }

  Method

#_callFetches

• "#_callFetches"(id: string): Promise<null | T>

  Calls all the custom fetches.

  Parameters

  • id: string

    The ID to fetch.

  Returns Promise<null | T>

  Method

  Async

#_callRules

• "#_callRules"(value: unknown): void

  Calls the rules on a value.

  Parameters

  • value: unknown

    The value to call the rules on.

  Returns void

  Method

#addToExpiryBucket

• "#addToExpiryBucket"(key: string, expiry: number): void

  Adds a key to the expiry bucket.

  Parameters

  • key: string

    The key to add to the expiry bucket.
  • expiry: number

    The expiry time in seconds.

  Returns void

  Method

#clearStaleBuckets

• "#clearStaleBuckets"(): void

  Clears stale buckets.

  Returns void

  Method

clear

• clear(): void

  Clears the cache.

  Returns void

  Method

delete

• delete(key: string): boolean

  Deletes a key from the cache.

  Parameters

  • key: string

    The key to delete.

  Returns boolean

  Whether the key was deleted or not.

  Method

expireBucket

• expireBucket(bucket: string): void

  Expires a bucket.

  Parameters

  • bucket: string

    The bucket to expire.

  Returns void

  Method

fetchFromRules

• fetchFromRules(key: string): Promise<null | T>

  Fetches a value from the rules cache.

  Parameters

  • key: string

    The key to fetch.

  Returns Promise<null | T>

  The fetched value.

  Method

  Throws

  Async

fetchWithRules

• fetchWithRules(key: string): Promise<null | T>

  Fetches a value from the cache or from the rules cache.

  Parameters

  • key: string

    The key to fetch.

  Returns Promise<null | T>

  The fetched value.

  Method

  Async

  Throws

flagForDeletion

• flagForDeletion(key: string): null | NonNullable<T>

  Parameters

  • key: string

  Returns null | NonNullable<T>

forEach

• forEach(callbackfn: unknown): void

  Calls a function on each item in the cache.

  Parameters

  • callbackfn: unknown

  Returns void

  Method

get

• get(key: string): null | NonNullable<T>

  Gets a value from the cache.

  Parameters

  • key: string

    The key to get.

  Returns null | NonNullable<T>

  The value from the cache.

  Method

  Throws

has

• has(key: string): boolean

  Checks if a key exists in the cache.

  Parameters

  • key: string

    The key to check.

  Returns boolean

  Whether the key exists or not.

  Method

  Throws

map

• map(
      callbackfn: (
          value: [string, T],
          index: number,
          array: [string, T][],
      ) => unknown,
  ): T[]

  Parameters

  • callbackfn: (value: [string, T], index: number, array: [string, T][]) => unknown

  Returns T[]

set

• set(key: string, value: T, expiry?: number): void

  Sets a value in the cache.

  Parameters

  • key: string

    The key to set.
  • value: T

    The value to set.
  • expiry: number = 0

    The expiry time in seconds.

  Returns void

  The value that was set.

  Method

  Throws

toJSON

• toJSON(format?: JsonTypes): any[]

  Returns the JSON representation of this structure.

  Parameters

  • Optionalformat: JsonTypes

    The format to return the data in.

  Returns any[]

  Method