Skip to content

basalt / auth/src / AuthTokenStore

Interface: AuthTokenStore ​

Defined in: auth/src/stores.ts:184

Stores single-use, expiring tokens for verification and reset flows.

Methods ​

create() ​

> create(record): Promise<void>

Defined in: auth/src/stores.ts:185

Parameters ​

record ​

AuthTokenRecord

Returns ​

Promise<void>


deleteForUser() ​

> deleteForUser(userId, purpose): Promise<void>

Defined in: auth/src/stores.ts:196

Invalidate outstanding tokens of a purpose for a user before issuing a new one.

Parameters ​

userId ​

string

purpose ​

AuthTokenPurpose

Returns ​

Promise<void>


find() ​

> find(token): Promise<AuthTokenRecord | null>

Defined in: auth/src/stores.ts:186

Parameters ​

token ​

string

Returns ​

Promise<AuthTokenRecord | null>


markUsed() ​

> markUsed(token): Promise<boolean | void>

Defined in: auth/src/stores.ts:194

Consumes the token. MUST be a compare-and-swap: mark it used only if it is still unused, and return whether THIS call did the consuming — false means a concurrent caller got there first. Returning void keeps the pre-CAS behaviour (the caller then trusts its earlier read), so third-party stores written against the old contract keep working, without the race protection.

Parameters ​

token ​

string

Returns ​

Promise<boolean | void>

Released under the MIT License.