Class: CacheTokenStore<IsAsync>

Defined in: schemas/v2/cache/token.ts:10

Extends

• CacheStoreShared<IsAsync, Oauth2StoredToken>

Type Parameters

Type Parameter
IsAsync extends boolean

Constructors

Constructor

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

Defined in: schemas/v2/cache/token.ts:11

Parameters

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

Returns

CacheTokenStore<IsAsync>

Overrides

CacheStoreShared.constructor

Properties

Property	Modifier	Type	Description	Inherited from
binding	public	CacheStoreBinding<IsAsync, Oauth2StoredToken>	-	CacheStoreShared.binding
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.	CacheStoreShared.options

Methods

bulkDelete()

bulkDelete(keys): If<IsAsync, Promise<void>>

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

Parameters

Parameter	Type
keys	string[]

Returns

If<IsAsync, Promise<void>>

Inherited from

CacheStoreShared.bulkDelete

---

bulkGet()

bulkGet(keys): If<IsAsync, Promise<(undefined | { key: string; value: Oauth2StoredToken; })[]>>

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

Parameters

Parameter	Type
keys	string[]

Returns

If<IsAsync, Promise<(undefined | { key: string; value: Oauth2StoredToken; })[]>>

Inherited from

CacheStoreShared.bulkGet

---

bulkPut()

bulkPut(items): If<IsAsync, Promise<void>>

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

Parameters

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

Returns

If<IsAsync, Promise<void>>

Inherited from

CacheStoreShared.bulkPut

---

delete()

delete(key): If<IsAsync, Promise<void>>

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

Parameters

Parameter	Type
key	string

Returns

If<IsAsync, Promise<void>>

Inherited from

CacheStoreShared.delete

---

edit()

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

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

Parameters

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

Returns

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

Inherited from

CacheStoreShared.edit

---

get()

get(key): If<IsAsync, Promise<undefined | Oauth2StoredToken>>

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

Parameters

Parameter	Type
key	string

Returns

If<IsAsync, Promise<undefined | Oauth2StoredToken>>

Inherited from

CacheStoreShared.get

---

put()

put(key, token): If<IsAsync, Promise<void>>

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

Parameters

Parameter	Type
key	string
token	Oauth2StoredToken

Returns

If<IsAsync, Promise<void>>

Inherited from

CacheStoreShared.put

---

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>

Inherited from

CacheStoreShared.createAsync

---

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>

Inherited from

CacheStoreShared.createSync