Class Cache

Cache models the shared Gestalt cache-provider protocol.

Index

Constructors

Methods

connect get getRaw getMany getManyRaw set setRaw setMany setManyRaw delete deleteRaw deleteMany deleteManyRaw touch touchRaw

Constructors

constructor

new Cache(transport: Transport, options?: { timeoutMs?: number }): Cache
Parameters
- transport: Transport
- Optionaloptions: { timeoutMs?: number }
Returns Cache

Methods

`Static`connect

connect(options?: { name?: string; timeoutMs?: number }): Cache
Parameters
- Optionaloptions: { name?: string; timeoutMs?: number }
Returns Cache

get

get(key: string): Promise<Uint8Array<ArrayBufferLike> | undefined>
Parameters
- key: string
Returns Promise<Uint8Array<ArrayBufferLike> | undefined>

getRaw

getRaw(request: { key?: string }): Promise<CacheGetResponse>
Parameters
- request: { key?: string }
Returns Promise<CacheGetResponse>

getMany

getMany(keys: string[]): Promise<{ [key: string]: Uint8Array<ArrayBufferLike> }>
Parameters
- keys: string[]
Returns Promise<{ [key: string]: Uint8Array<ArrayBufferLike> }>

getManyRaw

getManyRaw(request: { keys?: string[] }): Promise<CacheGetManyResponse>
Parameters
- request: { keys?: string[] }
Returns Promise<CacheGetManyResponse>

set

set(key: string, value: Uint8Array, ttl?: number): Promise<void>
Parameters
- key: string
- value: Uint8Array
- Optionalttl: number
Returns Promise<void>

setRaw

setRaw(
    request: {
        key?: string;
        value?: Uint8Array<ArrayBufferLike>;
        ttl?: number;
    },
): Promise<void>
Parameters
- request: { key?: string; value?: Uint8Array<ArrayBufferLike>; ttl?: number }
  - Optionalkey?: string
  - Optionalvalue?: Uint8Array<ArrayBufferLike>
  - Optionalttl?: number
    ttl applies an optional expiration to the entry.
Returns Promise<void>

setMany

setMany(
entries: { key?: string; value?: Uint8Array<ArrayBufferLike> }[],
ttl?: number,
): Promise<void>
Parameters
- entries: { key?: string; value?: Uint8Array<ArrayBufferLike> }[]
- Optionalttl: number
Returns Promise<void>

setManyRaw

setManyRaw(
    request: {
        entries?: { key?: string; value?: Uint8Array<ArrayBufferLike> }[];
        ttl?: number;
    },
): Promise<void>
Parameters
- request: {
  entries?: { key?: string; value?: Uint8Array<ArrayBufferLike> }[];
  ttl?: number;
  }
Returns Promise<void>

delete

delete(key: string): Promise<boolean>
Parameters
- key: string
Returns Promise<boolean>

deleteRaw

deleteRaw(request: { key?: string }): Promise<CacheDeleteResponse>
Parameters
- request: { key?: string }
Returns Promise<CacheDeleteResponse>

deleteMany

deleteMany(keys: string[]): Promise<bigint>
Parameters
- keys: string[]
Returns Promise<bigint>

deleteManyRaw

deleteManyRaw(request: { keys?: string[] }): Promise<CacheDeleteManyResponse>
Parameters
- request: { keys?: string[] }
Returns Promise<CacheDeleteManyResponse>

touch

touch(key: string, ttl?: number): Promise<boolean>
Parameters
- key: string
- Optionalttl: number
Returns Promise<boolean>

touchRaw

touchRaw(request: { key?: string; ttl?: number }): Promise<CacheTouchResponse>
Parameters
- request: { key?: string; ttl?: number }
Returns Promise<CacheTouchResponse>