Class: CacheStoreShared<IsAsync, Value, C>

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

Extended by

• CacheStore
• CacheTokenStore

Type Parameters

Type Parameter	Default type
IsAsync extends boolean	-
Value	-
C extends Record<string, unknown>	{ key: string; }

Constructors

Constructor

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

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

Parameters

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

Returns

CacheStoreShared<IsAsync, Value, C>

Properties

Property	Modifier	Type	Description
binding	public	CacheStoreBinding<IsAsync, Value>	-
options	public	Required<CacheStoreSharedOptions<C>>	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:139

Parameters

Parameter	Type
keys	C[]

Returns

IfAsync<IsAsync, void>

---

bulkGet()

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

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

Parameters

Parameter	Type
keys	C[]

Returns

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

---

bulkPut()

bulkPut(items): IfAsync<IsAsync, void>

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

Parameters

Parameter	Type
items	C & { value: Value; }[]

Returns

IfAsync<IsAsync, void>

---

delete()

delete(...args): IfAsync<IsAsync, void>

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

Parameters

Parameter	Type
...args	ObjValueTuple<C>

Returns

IfAsync<IsAsync, void>

---

deleteAll()

deleteAll(): IfAsync<IsAsync, void>

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

Returns

IfAsync<IsAsync, void>

---

edit()

edit(...args): If<IsAsync, Promise<undefined | Value>, undefined | Value>

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

Parameters

Parameter	Type
...args	[...ObjValueTuple<C, TuplifyUnion<keyof C, LastOf<keyof C>, [keyof C] extends [never] ? true : false>, []>[], Partial<Value> | (item) => Value]

Returns

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

---

get()

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

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

Parameters

Parameter	Type
...args	ObjValueTuple<C>

Returns

IfAsync<IsAsync, undefined | Value>

---

put()

put(...args): IfAsync<IsAsync, void>

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

Parameters

Parameter	Type
...args	[...ObjValueTuple<C>[], Value]

Returns

IfAsync<IsAsync, void>

---

createAsync()

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

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

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:154

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>