Class default

This class represents an 'Multi User API With Credentials' authentication workflow.

Hierarchy (View Summary)

default
- default

Index

Constructors

Properties

onLogin onLogout

Methods

erase isRegistered login loginOrRegister logout logoutAndErase register

Constructors

constructor

new default(options: Partial<AuthenticatorOptions>): default
Parameters
- options: Partial<AuthenticatorOptions>
Returns default
Inherited from default.constructor
- Defined in models/Authenticator/Authenticator.ts:95

Properties

onLogin

onLogin: OEvent<(instanceName: string, secret: string, email: string) => void> = ...

This event will be triggered right AFTER the instance was initialised

onLogout

onLogout: OEvent<() => void> = ...

This event will be triggered right BEFORE the instance was closed

Methods

erase

erase(instanceName: string, email: string): Promise<void>
Erases the instance. This function will:
- deletes the instance
Parameters
- instanceName: string
- email: string
Returns Promise<void>
- Defined in models/Authenticator/MultiUser.ts:184

isRegistered

isRegistered(email: string, instanceName: string): Promise<boolean>
Checks if the user exists or not.
Parameters
- email: string
- instanceName: string
Returns Promise<boolean>
- Defined in models/Authenticator/MultiUser.ts:176

login(email: string, secret: string, instanceName: string): Promise<void>
Logins the user. This function will:
- trigger the 'login' event
- will check if the instance exists
  - if yes, it will initialize the instance, import modules, register recipes, trigger onLogin and wait for all the listeners to finish and trigger 'login_success' event
  - if no, it will trigger 'login_failure' event
Parameters
- email: string
- secret: string
- instanceName: string
Returns Promise<void>
- Defined in models/Authenticator/MultiUser.ts:119

loginOrRegister

loginOrRegister(
    email: string,
    secret: string,
    instanceName: string,
): Promise<void>
This function will login or register based on the instance existence.
Parameters
- email: string
- secret: string
- instanceName: string
Returns Promise<void>
- Defined in models/Authenticator/MultiUser.ts:163

logout

logout(): Promise<void>
Logouts the user. This function will:
- trigger the 'logout' event
- trigger onLogout and wait for all the listeners to finish
- close the instance
- trigger the 'logout_done' event if it is successfully
Returns Promise<void>
Inherited from default.logout
- Defined in models/Authenticator/Authenticator.ts:119

logoutAndErase

logoutAndErase(): Promise<void>
Erases the current instance. This function will:
- trigger the 'logout' & onLogout events
- delete the instance
- trigger 'logout_done' event
Returns Promise<void>
Overrides default.logoutAndErase
- Defined in models/Authenticator/MultiUser.ts:194

register

register(
    email: string,
    secret: string,
    instanceName: string,
    secretEncryptionKey?: string | Uint8Array<ArrayBufferLike>,
    secretSignKey?: string | Uint8Array<ArrayBufferLike>,
): Promise<void>
Registers the user. Register acts as a login if the instance does not exist yet.
Parameters
- email: string
- secret: string
- instanceName: string
- OptionalsecretEncryptionKey: string | Uint8Array<ArrayBufferLike>
- OptionalsecretSignKey: string | Uint8Array<ArrayBufferLike>
Returns Promise<void>
- Defined in models/Authenticator/MultiUser.ts:36