Class Cache

Client for invoking a host-provided cache over the Gestalt transport.

Example

import { Cache } from "@valon-technologies/gestalt";

const cache = new Cache();
await cache.set("session", new TextEncoder().encode("hello"));

Index

Constructors

constructor

Methods

get getMany set setMany delete deleteMany touch

Constructors

constructor

new Cache(name?: string): Cache
Parameters
- Optionalname: string
Returns Cache
- Defined in ../../src/cache.ts:118

Methods

get

get(key: string): Promise<Uint8Array<ArrayBufferLike> | undefined>
Parameters
- key: string
Returns Promise<Uint8Array<ArrayBufferLike> | undefined>
- Defined in ../../src/cache.ts:148

getMany

getMany(keys: string[]): Promise<Record<string, Uint8Array<ArrayBufferLike>>>
Parameters
- keys: string[]
Returns Promise<Record<string, Uint8Array<ArrayBufferLike>>>
- Defined in ../../src/cache.ts:158

set

set(key: string, value: Uint8Array, options?: CacheSetOptions): Promise<void>
Parameters
- key: string
- value: Uint8Array
- Optionaloptions: CacheSetOptions
Returns Promise<void>
- Defined in ../../src/cache.ts:165

setMany

setMany(entries: Iterable<CacheEntry>, options?: CacheSetOptions): Promise<void>
Parameters
- entries: Iterable<CacheEntry>
- Optionaloptions: CacheSetOptions
Returns Promise<void>
- Defined in ../../src/cache.ts:178

delete

delete(key: string): Promise<boolean>
Parameters
- key: string
Returns Promise<boolean>
- Defined in ../../src/cache.ts:189

deleteMany

deleteMany(keys: string[]): Promise<number | bigint>
Parameters
- keys: string[]
Returns Promise<number | bigint>
- Defined in ../../src/cache.ts:196

touch

touch(key: string, ttlMs: number): Promise<boolean>
Parameters
- key: string
- ttlMs: number
Returns Promise<boolean>
- Defined in ../../src/cache.ts:203

Class Cache

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Cache

Methods

get

Parameters

Returns Promise<Uint8Array<ArrayBufferLike> | undefined>

getMany

Parameters

Returns Promise<Record<string, Uint8Array<ArrayBufferLike>>>

set

Parameters

Returns Promise<void>

setMany

Parameters

Returns Promise<void>

delete

Parameters

Returns Promise<boolean>

deleteMany

Parameters

Returns Promise<number | bigint>

touch

Parameters

Returns Promise<boolean>

Settings

On This Page