CacheClient

Extended by

• CloudflareCacheClient
• RedisCacheClient
• ValkeyCacheClient
• UpstashCacheClient

Constructors

Constructor

new CacheClient(options?): CacheClient

Parameters

Parameter	Type
options?	CacheClientOptions

Returns

CacheClient

Properties

Property	Type
options?	CacheClientOptions

Methods

deleteItems()

abstract deleteItems<Item>(keys, options): Promise<void>

Type Parameters

Type Parameter
Item

Parameters

Parameter	Type
keys	`${string}:${string}:item:rev_${string}:id:${string}`[]
options	CacheClientArgs<Item>

Returns

Promise<void>

---

deleteItemsWithDiff()

abstract deleteItemsWithDiff<Item>(keys, options): Promise<(Item | null)[]>

Type Parameters

Type Parameter
Item

Parameters

Parameter	Type
keys	`${string}:${string}:item:rev_${string}:id:${string}`[]
options	CacheClientArgs<Item>

Returns

Promise<(Item | null)[]>

---

deleteQueries()

abstract deleteQueries<QueryMetadata>(indexes, options): Promise<void>

Type Parameters

Type Parameter
QueryMetadata

Parameters

Parameter	Type
indexes	`${string}:${string}:query:${string}:rev_${string}:idx:${string}`[]
options	CacheClientArgs<QueryMetadata>

Returns

Promise<void>

---

getPartialItems()

abstract getPartialItems<Item>(keys, options): Promise<(Item | null)[]>

Type Parameters

Type Parameter
Item

Parameters

Parameter	Type
keys	`${string}:${string}:item:rev_${string}:id:${string}`[]
options	CacheClientArgs<Item>

Returns

Promise<(Item | null)[]>

---

getQuery()

abstract getQuery<QueryMetadata>(key, options): Promise<QueryMetadata | null>

Type Parameters

Type Parameter
QueryMetadata

Parameters

Parameter	Type
key	`${string}:${string}:query:${string}:rev_${string}:id:${string}`
options	CacheClientArgs<QueryMetadata>

Returns

Promise<QueryMetadata | null>

---

saveItems()

abstract saveItems<Item>(items, options, saveOptions?): Promise<void>

Type Parameters

Type Parameter
Item

Parameters

Parameter	Type
items	[`${string}:${string}:item:rev_${string}:id:${string}`, Item][]
options	CacheClientArgs<Item>
saveOptions?	CacheClientSaveOptions

Returns

Promise<void>

---

saveItemsWithDiff()

abstract saveItemsWithDiff<Item>(items, options): Promise<(Item | null)[]>

Type Parameters

Type Parameter
Item

Parameters

Parameter	Type
items	[`${string}:${string}:item:rev_${string}:id:${string}`, Item][]
options	CacheClientArgs<Item>

Returns

Promise<(Item | null)[]>

---

saveQuery()

abstract saveQuery<QueryMetadata>(key, indexes, metadata, options): Promise<void>

Type Parameters

Type Parameter
QueryMetadata

Parameters

Parameter	Type
key	`${string}:${string}:query:${string}:rev_${string}:id:${string}`
indexes	`${string}:${string}:query:${string}:rev_${string}:idx:${string}`[]
metadata	QueryMetadata
options	CacheClientArgs<QueryMetadata>

Returns

Promise<void>