Interface ICache

Cache adapter for storing validated access token claims.

Implement this interface to persist validated claims in an external store such as Redis, Memcached, or an in-memory cache.

interface ICache {
    delete(key: string): Promise<void>;
    get(key: string): Promise<AccessTokenClaims | null | undefined>;
    set(
        key: string,
        claims: AccessTokenClaims,
        expiresAt: number,
    ): Promise<void>;
}

Index

delete get set

delete

delete(key: string): Promise<void>
Removes an entry from the cache.
Parameters
- key: string
  The cache key to delete.
Returns Promise<void>
- Defined in packages/node-backend/src/types.ts:164

get

get(key: string): Promise<AccessTokenClaims | null | undefined>
Retrieves cached claims by key.
Parameters
- key: string
  The cache key.
Returns Promise<AccessTokenClaims | null | undefined>
The cached claims, or null/undefined if the entry does not exist or has expired.
- Defined in packages/node-backend/src/types.ts:158

set

set(key: string, claims: AccessTokenClaims, expiresAt: number): Promise<void>
Stores validated claims in the cache.
Parameters
- key: string
  The cache key (access token).
- claims: AccessTokenClaims
  The validated access token claims to cache.
- expiresAt: number
  The token's expiration time as a Unix epoch timestamp (seconds).
Returns Promise<void>
- Defined in packages/node-backend/src/types.ts:151

Interface ICache

Index

delete

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<AccessTokenClaims | null | undefined>

set

Parameters

Returns Promise<void>

Settings

On This Page