Interface RestCacheStore

Async cache store used by CachedRestBackend.

The interface is deliberately small so implementations can be backed by IndexedDB, the browser Cache API, local storage, memory, or test fixtures.

interface RestCacheStore {
    delete(key: string): Promise<void>;
    deletePrefix(prefix: string): Promise<void>;
    get<T>(key: string): Promise<RestResponse<T> | undefined>;
    set<T>(key: string, response: RestResponse<T>): Promise<void>;
}

Index

Methods

delete deletePrefix get set

Methods

delete

delete(key: string): Promise<void>
Delete one cached REST response.
Parameters
- key: string
  
  Exact cache key to remove.
Returns Promise<void>

deletePrefix

deletePrefix(prefix: string): Promise<void>
Delete cached REST responses whose keys start with the prefix.

CachedRestBackend uses prefixes such as GET /api/users to invalidate collection and entity entries after successful writes.
Parameters
- prefix: string
Returns Promise<void>

get

get<T>(key: string): Promise<RestResponse<T> | undefined>
Read a cached REST response by deterministic key.
Type Parameters
- T
Parameters
- key: string
  
  Opaque cache key supplied by CachedRestBackend.
Returns Promise<RestResponse<T> | undefined>

set

set<T>(key: string, response: RestResponse<T>): Promise<void>
Store a REST response by deterministic key.
Type Parameters
- T
Parameters
- key: string
  
  Opaque cache key supplied by CachedRestBackend.
- response: RestResponse<T>
  
  Response to persist.
Returns Promise<void>

Interface RestCacheStore

Index

Methods

Methods

delete

Parameters

Returns Promise<void>

deletePrefix

Parameters

Returns Promise<void>

get

Type Parameters

Parameters

Returns Promise<RestResponse<T> | undefined>

set

Type Parameters

Parameters

Returns Promise<void>

Settings

On This Page