Class CacheProvider

Cache provider implementation consumed by the Gestalt runtime.

Hierarchy (View Summary)

RuntimeProvider
- CacheProvider

Index

Constructors

Properties

kind name displayName description version

Methods

get getMany set setMany delete deleteMany touch resolveName runtimeMetadata configureProvider supportsHealthCheck healthCheck startProvider warnings closeProvider

Constructors

constructor

new CacheProvider(options: CacheProviderOptions): CacheProvider
Parameters
- options: CacheProviderOptions
Returns CacheProvider
Overrides RuntimeProvider.constructor
- Defined in ../../src/cache.ts:227

Properties

`Readonly`kind

kind: "cache" = ...

name

name: string

`Readonly`displayName

displayName: string

`Readonly`description

description: string

`Readonly`version

version: string

Methods

get

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

getMany

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

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:260

setMany

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

delete

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

deleteMany

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

touch

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

resolveName

resolveName(fallback: string): void
Parameters
- fallback: string
Returns void
Inherited from RuntimeProvider.resolveName
- Defined in ../../src/provider.ts:102

runtimeMetadata

runtimeMetadata(): ProviderMetadata
Returns ProviderMetadata
Inherited from RuntimeProvider.runtimeMetadata
- Defined in ../../src/provider.ts:108

configureProvider

configureProvider(name: string, config: Record<string, unknown>): Promise<void>
Parameters
- name: string
- config: Record<string, unknown>
Returns Promise<void>
Inherited from RuntimeProvider.configureProvider
- Defined in ../../src/provider.ts:127

supportsHealthCheck

supportsHealthCheck(): boolean
Returns boolean
Inherited from RuntimeProvider.supportsHealthCheck
- Defined in ../../src/provider.ts:131

healthCheck

healthCheck(): Promise<void>
Returns Promise<void>
Inherited from RuntimeProvider.healthCheck
- Defined in ../../src/provider.ts:135

startProvider

startProvider(): Promise<void>
Returns Promise<void>
Inherited from RuntimeProvider.startProvider
- Defined in ../../src/provider.ts:139

warnings

warnings(): Promise<string[]>
Returns Promise<string[]>
Inherited from RuntimeProvider.warnings
- Defined in ../../src/provider.ts:143

closeProvider

closeProvider(): Promise<void>
Returns Promise<void>
Inherited from RuntimeProvider.closeProvider
- Defined in ../../src/provider.ts:153