Interface: CacheStoreBinding<IsAsync, Value>

Defined in: schemas/v2/cache/base.ts:55

Type Parameters

Type Parameter
IsAsync extends boolean
Value

Properties

Property	Type
options	CacheStoreBindingOptions

Methods

bulkDelete()?

optional bulkDelete(keys): IfAsync<IsAsync, void>

Defined in: schemas/v2/cache/base.ts:80

Parameters

Parameter	Type
keys	string[]

Returns

IfAsync<IsAsync, void>

---

bulkGet()?

optional bulkGet(keys): IfAsync<IsAsync, (undefined | { key: string; value: Value; })[]>

Defined in: schemas/v2/cache/base.ts:79

Parameters

Parameter	Type
keys	string[]

Returns

IfAsync<IsAsync, (undefined | { key: string; value: Value; })[]>

---

bulkPut()?

optional bulkPut(items): IfAsync<IsAsync, void>

Defined in: schemas/v2/cache/base.ts:75

Parameters

Parameter	Type
items	{ key: string; value: Value; }[]

Returns

IfAsync<IsAsync, void>

---

delete()

delete(key): IfAsync<IsAsync, void>

Defined in: schemas/v2/cache/base.ts:70

Parameters

Parameter	Type
key	string

Returns

IfAsync<IsAsync, void>

---

deleteAll()?

optional deleteAll(): IfAsync<IsAsync, void>

Defined in: schemas/v2/cache/base.ts:82

Returns

IfAsync<IsAsync, void>

---

get()

get(key): IfAsync<IsAsync, undefined | Value>

Defined in: schemas/v2/cache/base.ts:69

Method to retreive the stored value.

Parameters

Parameter	Type	Description
key	string	The key that has information about the item type and id

Returns

IfAsync<IsAsync, undefined | Value>

---

list()

list(options?): IfAsync<IsAsync, { keys: { key: string; metadata: object; }[]; }>

Defined in: schemas/v2/cache/base.ts:71

Parameters

Parameter	Type
options?	{ prefix?: string; }
options.prefix?	string

Returns

IfAsync<IsAsync, { keys: { key: string; metadata: object; }[]; }>

---

put()

put(key, value): IfAsync<IsAsync, void>

Defined in: schemas/v2/cache/base.ts:63

Store the value from the client to an external resource

Parameters

Parameter	Type	Description
key	string	The key that has information about the item type and id
value	Value	The value to store

Returns

IfAsync<IsAsync, void>