Skip to content

basalt / auth/src / ApiKeyStore

Interface: ApiKeyStore ​

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

Methods ​

create() ​

> create(record): Promise<void>

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

Parameters ​

record ​

ApiKeyRecord

Returns ​

Promise<void>


findByHash() ​

> findByHash(hash): Promise<ApiKeyRecord | null>

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

Parameters ​

hash ​

string

Returns ​

Promise<ApiKeyRecord | null>


findById() ​

> findById(id): Promise<ApiKeyRecord | null>

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

Parameters ​

id ​

string

Returns ​

Promise<ApiKeyRecord | null>


list() ​

> list(filter): Promise<ApiKeyRecord[]>

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

Active (non-revoked) keys matching the filter.

Parameters ​

filter ​

ApiKeyFilter

Returns ​

Promise<ApiKeyRecord[]>


revoke() ​

> revoke(id, at): Promise<void>

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

Parameters ​

id ​

string

at ​

number

Returns ​

Promise<void>


touch() ​

> touch(id, at): Promise<void>

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

Parameters ​

id ​

string

at ​

number

Returns ​

Promise<void>

Released under the MIT License.