Class Authenticatable`Abstract`

Base class for entities that can be authenticated.

Hierarchy

Authenticatable

Implements

Rehydratable

Implemented by

ORMUser

Index

Constructors

Methods

dehydrate getDisplay getIdentifier getUniqueIdentifier rehydrate validateCredential

Constructors

constructor

new Authenticatable(): Authenticatable
Returns Authenticatable

Methods

`Abstract` dehydrate

dehydrate(): Promise<JSONState>
Dehydrate this class' state and get it.

Returns
JSONState|Promise

Returns Promise<JSONState>
Implementation of Rehydratable.dehydrate
- Defined in src/auth/types.ts:23

`Abstract` getDisplay

getDisplay(): string
Get the human-readable identifier of the user.

Returns string
- Defined in src/auth/types.ts:18

`Abstract` getIdentifier

getIdentifier(): AuthenticatableIdentifier
Get the repository-unique identifier of the user.

Returns AuthenticatableIdentifier
- Defined in src/auth/types.ts:15

`Abstract` getUniqueIdentifier

getUniqueIdentifier(): AuthenticatableIdentifier
Get the globally-unique identifier of the user.

Returns AuthenticatableIdentifier
- Defined in src/auth/types.ts:12

`Abstract` rehydrate

rehydrate(state: JSONState): Awaitable<void>
Rehydrate a state into this class.

Returns
void|Promise
Parameters
- state: JSONState
Returns Awaitable<void>
Implementation of Rehydratable.rehydrate
- Defined in src/auth/types.ts:25

`Abstract` validateCredential

validateCredential(credential: string): Awaitable<boolean>
Attempt to validate a credential of the user.
Parameters
- credential: string
Returns Awaitable<boolean>
- Defined in src/auth/types.ts:21