UpstashCacheClient

Extends

• CacheClient

Constructors

Constructor

new UpstashCacheClient(redisOptions, options?): UpstashCacheClient

Parameters

Parameter	Type
redisOptions	Omit<RedisConfigNodejs, "automaticDeserialization">
options?	UpstashCacheClientOptions

Returns

UpstashCacheClient

Overrides

CacheClient.constructor

Properties

Property	Modifier	Type	Inherited from
maxCommandKeysLimit	protected	number	‐
maxPipelineCommandLimit	protected	number	‐
maxPipelineSizeLimit	protected	number	‐
redis	public	Redis	‐
scripts	protected	RedisScripts	‐
options?	public	CacheClientOptions	CacheClient.options

Methods

deleteItems()

deleteItems(keys): Promise<void>

Parameters

Parameter	Type
keys	`${string}:${string}:item:rev_${string}:id:${string}`[]

Returns

Promise<void>

Overrides

CacheClient.deleteItems

---

deleteItemsWithDiff()

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)[]>

Overrides

CacheClient.deleteItemsWithDiff

---

deleteQueries()

deleteQueries(indexes): Promise<void>

Parameters

Parameter	Type
indexes	`${string}:${string}:query:${string}:rev_${string}:idx:${string}`[]

Returns

Promise<void>

Overrides

CacheClient.deleteQueries

---

getPartialItems()

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)[]>

Overrides

CacheClient.getPartialItems

---

getQuery()

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>

Overrides

CacheClient.getQuery

---

saveItems()

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

Type Parameters

Type Parameter
Item

Parameters

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

Returns

Promise<void>

Overrides

CacheClient.saveItems

---

saveItemsWithDiff()

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)[]>

Overrides

CacheClient.saveItemsWithDiff

---

saveQuery()

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>

Overrides

CacheClient.saveQuery