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<{ key: string; }>

Returns

CacheTokenStore<IsAsync>

Overrides

CacheStoreShared.constructor

Properties

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

Methods

bulkDelete()

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

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

Parameters

Parameter	Type
keys	{ key: string; }[]

Returns

If<IsAsync, Promise<void>>

Inherited from

CacheStoreShared.bulkDelete

---

bulkGet()

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

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

Parameters

Parameter	Type
keys	{ key: string; }[]

Returns

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

Inherited from

CacheStoreShared.bulkGet

---

bulkPut()

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

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

Parameters

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

Returns

If<IsAsync, Promise<void>>

Inherited from

CacheStoreShared.bulkPut

---

delete()

delete(...args): If<IsAsync, Promise<void>>

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

Parameters

Parameter	Type
...args	[string]

Returns

If<IsAsync, Promise<void>>

Inherited from

CacheStoreShared.delete

---

deleteAll()

deleteAll(): If<IsAsync, Promise<void>>

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

Returns

If<IsAsync, Promise<void>>

Inherited from

CacheStoreShared.deleteAll

---

edit()

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

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

Parameters

Parameter	Type
...args	[string, Partial<Oauth2StoredToken> | ((item) => Oauth2StoredToken)]

Returns

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

Inherited from

CacheStoreShared.edit

---

get()

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

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

Parameters

Parameter	Type
...args	[string]

Returns

If<IsAsync, Promise<Oauth2StoredToken | undefined>>

Inherited from

CacheStoreShared.get

---

isAsync()

isAsync(): boolean

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

Returns

boolean

whether this cache is using an async binding.

Inherited from

CacheStoreShared.isAsync

---

put()

put(...args): If<IsAsync, Promise<void>>

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

Parameters

Parameter	Type
...args	[string, 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:169

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

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