Class Authenticatable

Base class for entities that can be authenticated.

Hierarchy

Authenticatable

Implements

Rehydratable

Implemented by

ORMUser

Index

Constructors

constructor

Methods

Constructors

constructor

new Authenticatable(): Authenticatable

Returns Authenticatable

Methods

Abstract dehydrate

dehydrate(): Promise<JSONState>

Implementation of Rehydratable.dehydrate
- Defined in src/auth/types.ts:23
Dehydrate this class' state and get it.

Returns Promise<JSONState>

JSONState|Promise

Abstract getDisplay

getDisplay(): string

- Defined in src/auth/types.ts:18
Get the human-readable identifier of the user.

Returns string

Abstract getIdentifier

getIdentifier(): AuthenticatableIdentifier

- Defined in src/auth/types.ts:15
Get the repository-unique identifier of the user.

Returns AuthenticatableIdentifier

Abstract getUniqueIdentifier

getUniqueIdentifier(): AuthenticatableIdentifier

- Defined in src/auth/types.ts:12
Get the globally-unique identifier of the user.

Returns AuthenticatableIdentifier

Abstract rehydrate

rehydrate(state: JSONState): Awaitable<void>

Implementation of Rehydratable.rehydrate
- Defined in src/auth/types.ts:25
Rehydrate a state into this class.

Parameters
- state: JSONState
Returns Awaitable<void>

void|Promise

Abstract validateCredential

validateCredential(credential: string): Awaitable<boolean>

- Defined in src/auth/types.ts:21
Attempt to validate a credential of the user.

Parameters
- credential: string
Returns Awaitable<boolean>

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.