Skip to content

ActivityPlug API / @activityplug/server / OAuthStateStore

Interface: OAuthStateStore ​

Defined in: packages/server/src/storage/contracts.ts:76

Extends ​

Properties ​

expiryMode? ​

readonly optional expiryMode?: SecurityStateExpiryMode

Defined in: packages/server/src/storage/contracts.ts:4

Inherited from ​

SecurityStateExpiryMetadata.expiryMode

Methods ​

claim() ​

claim(stateHash, leaseUntil): Promise<OAuthStateClaim | null>

Defined in: packages/server/src/storage/contracts.ts:78

Parameters ​

stateHash ​

string

leaseUntil ​

string

Returns ​

Promise<OAuthStateClaim | null>


consume() ​

consume(claim): Promise<boolean>

Defined in: packages/server/src/storage/contracts.ts:80

Parameters ​

claim ​

OAuthStateClaim

Returns ​

Promise<boolean>


create() ​

create(record): Promise<boolean>

Defined in: packages/server/src/storage/contracts.ts:77

Parameters ​

record ​

OAuthStateRecord

Returns ​

Promise<boolean>


deleteExpired() ​

deleteExpired(now?, limit?): Promise<number>

Defined in: packages/server/src/storage/contracts.ts:81

Parameters ​

now? ​

Date

limit? ​

number

Returns ​

Promise<number>


release() ​

release(claim): Promise<boolean>

Defined in: packages/server/src/storage/contracts.ts:79

Parameters ​

claim ​

OAuthStateClaim

Returns ​

Promise<boolean>