Options
All
  • Public
  • Public/Protected
  • All
Menu

Module types/hooks

Type aliases

OnAccountDisabledHook

OnAccountDisabledHook<Account>: function

Hook called when account was disabled.

Important! The main purpose of this hook is to invalidate all of the active user sessions.

param

User account that was disabled.

Type parameters

Type declaration

    • (account: Account): Promise<void>
    • Parameters

      • account: Account

      Returns Promise<void>

OnAuthenticationFromDifferentContextHook

OnAuthenticationFromDifferentContextHook<Account>: function

Hook called when authentication has been made from a context that differs from the previous ones.

Important! The main purpose of this hook is to send a notification to user about this via email, sms, push notifications etc.

param

Account on which authentication has been made.

param

Authentication context.

Type parameters

Type declaration

OnForgottenPasswordChangedHook

OnForgottenPasswordChangedHook<Account>: function

Hook called when forgotten password has been changed.

Important! The main purpose of this hook is to invalidate all of the active user sessions.

param

User account password of which has been changed.

Type parameters

Type declaration

    • (account: Account): Promise<void>
    • Parameters

      • account: Account

      Returns Promise<void>

OnPasswordChangedHook

OnPasswordChangedHook<Account>: function

Hook called when account password has been changed.

Important! The main purpose of this hook is to invalidate all of the active user sessions.

param

User account password of which has been changed.

param

Context of the password change.

Type parameters

Type declaration