Skip to content

CacheKeys

@blobs/sdk v0.1.0


@blobs/sdk / cache / CacheKeys

const CacheKeys: object

Defined in: cache/CacheKey.ts:35

Convenience builders for common cache keys keyed by resource.

Use these instead of constructing keys ad-hoc so that callers and invalidators agree on the exact key shape. Note: this object exists in addition to the namespaced helpers in cache/keys.ts — prefer those when you need cross-resource consistency without a RequestAction prefix.

Type Declaration

blob

blob: (id) => string

Key for a single blob fetched by id.

Parameters

id

string

Returns

string

blobsList

blobsList: () => string

Key for the default LIST /blobs response.

Returns

string

blobsQuery

blobsQuery: (query) => string

Key for a QUERY /blobs?<query> response.

Parameters

query

string

Returns

string

user

user: (id) => string

Key for a single user fetched by id.

Parameters

id

string

Returns

string

userProfile

userProfile: () => string

Key for the current user’s profile response.

Returns

string

usersList

usersList: () => string

Key for the LIST /users response.

Returns

string

currentUser

currentUser: () => string

Key for the currently-authenticated user (/auth/me).

Returns

string

settings

settings: () => string

Key for the bag of all settings.

Returns

string

setting

setting: (key) => string

Key for a single setting by key.

Parameters

key

string

Returns

string

media

media: (id) => string

Key for a single media item by id.

Parameters

id

string

Returns

string

mediaList

mediaList: () => string

Key for the LIST /media response.

Returns

string