Interface CacheService

A pre-configured, storage agnostic cache service suitable for use by Backstage plugins.

See the service documentation for more details.

interface CacheService {
    delete(key: string): Promise<void>;
    get<TValue extends JsonValue>(key: string): Promise<TValue | undefined>;
    set(
        key: string,
        value: JsonValue,
        options?: CacheServiceSetOptions,
    ): Promise<void>;
    withOptions(options: CacheServiceOptions): CacheService;
}

Index

Methods

delete get set withOptions

Methods

delete

delete(key: string): Promise<void>
Removes the given key from the cache store.
Parameters
- key: string
Returns Promise<void>
- Defined in packages/backend-plugin-api/src/services/definitions/CacheService.ts:75

get

get<TValue extends JsonValue>(key: string): Promise<TValue | undefined>
Reads data from a cache store for the given key. If no data was found, returns undefined.
Type Parameters
- TValue extends JsonValue
Parameters
- key: string
Returns Promise<TValue | undefined>
- Defined in packages/backend-plugin-api/src/services/definitions/CacheService.ts:59

set

set(
    key: string,
    value: JsonValue,
    options?: CacheServiceSetOptions,
): Promise<void>
Writes the given data to a cache store, associated with the given key. An optional TTL may also be provided, otherwise it defaults to the TTL that was provided when the client was instantiated.
Parameters
- key: string
- value: JsonValue
- Optionaloptions: CacheServiceSetOptions
Returns Promise<void>
- Defined in packages/backend-plugin-api/src/services/definitions/CacheService.ts:66

withOptions

withOptions(options: CacheServiceOptions): CacheService
Creates a new CacheService instance with the given options.
Parameters
- options: CacheServiceOptions
Returns CacheService
- Defined in packages/backend-plugin-api/src/services/definitions/CacheService.ts:80