Class: CacheStoreShared<IsAsync, Value>

Defined in: schemas/v2/cache/shared.ts:15

Extended by

• CacheStore
• CacheTokenStore

Type Parameters

Type Parameter
IsAsync extends boolean
Value

Constructors

Constructor

new CacheStoreShared<IsAsync, Value>(async, binding?, options?): CacheStoreShared<IsAsync, Value>

Defined in: schemas/v2/cache/shared.ts:28

Parameters

Parameter	Type
async	IsAsync
binding?	CacheStoreBinding<IsAsync, Value>
options?	CacheStoreSharedOptions

Returns

CacheStoreShared<IsAsync, Value>

Properties

Property	Modifier	Type	Description
binding	public	CacheStoreBinding<IsAsync, Value>	-
options	public	Required<CacheStoreSharedOptions>	Options for the cache. Can be used to control how the cache behaves on edits or other options for custom cache items.

Methods

bulkDelete()

bulkDelete(keys): IfAsync<IsAsync, void>

Defined in: schemas/v2/cache/shared.ts:99

Parameters

Parameter	Type
keys	string[]

Returns

IfAsync<IsAsync, void>

---

bulkGet()

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

Defined in: schemas/v2/cache/shared.ts:83

Parameters

Parameter	Type
keys	string[]

Returns

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

---

bulkPut()

bulkPut(items): IfAsync<IsAsync, void>

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

Parameters

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

Returns

IfAsync<IsAsync, void>

---

delete()

delete(key): IfAsync<IsAsync, void>

Defined in: schemas/v2/cache/shared.ts:42

Parameters

Parameter	Type
key	string

Returns

IfAsync<IsAsync, void>

---

edit()

edit(key, value): If<IsAsync, Promise<undefined | Value>, undefined | Value>

Defined in: schemas/v2/cache/shared.ts:54

Parameters

Parameter	Type
key	string
value	Partial<Value> | (item) => Value

Returns

If<IsAsync, Promise<undefined | Value>, undefined | Value>

---

get()

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

Defined in: schemas/v2/cache/shared.ts:50

Parameters

Parameter	Type
key	string

Returns

IfAsync<IsAsync, undefined | Value>

---

put()

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

Defined in: schemas/v2/cache/shared.ts:46

Parameters

Parameter	Type
key	string
token	Value

Returns

IfAsync<IsAsync, void>

---

createAsync()

static createAsync<Value, Store>(store, binding?, options?): InstanceType<Store>

Defined in: schemas/v2/cache/shared.ts:121

Type Parameters

Type Parameter
Value
Store extends typeof CacheStoreShared

Parameters

Parameter	Type
store	Store
binding?	CacheStoreBinding<true, Value>
options?	Partial<Store["prototype"]["options"]>

Returns

InstanceType<Store>

---

createSync()

static createSync<Value, Store>(store, binding?, options?): InstanceType<Store>

Defined in: schemas/v2/cache/shared.ts:113

Type Parameters

Type Parameter
Value
Store extends typeof CacheStoreShared

Parameters

Parameter	Type
store	Store
binding?	CacheStoreBinding<false, Value>
options?	Partial<Store["prototype"]["options"]>

Returns

InstanceType<Store>