Events

Depending on the nature of your app, it may be helpful to know when certain account actions are taken (e.g., for auditing or administrative purposes). To support this, Joystick offers account event hooks that can be defined via the accounts.events option passed in the options object for joystick.app().

Account hooks are called immediately after the corresponding account event takes place.

Example Usage

import joystick from '@joystick.js/node';

joystick.app({
  accounts: {
    events: {
      on_login: ({ token, token_expires_at, user }) => {
        // Handle login event...
      },
      on_signup: ({ token, token_expires_at, user }) => {
        // Handle signup event...
      },
      on_logout: (user = {}) => {
        // Handle logout event...
      },
      on_recover_password: (email_address = '') => {
        // Handle recover password event...
      },
      on_reset_password: ({ token, token_expires_at, user }) => {
        // Handle reset password event...
      },
    },
  },
  routes: {
    // Your routes configuration...
  }
});

Above, we define multiple account event hooks inside accounts.events. Each hook runs automatically after its corresponding account event occurs.

API

Definition

accounts: {
  events: {
    on_login: ({ token, token_expires_at, user }) => void,
    on_signup: ({ token, token_expires_at, user }) => void,
    on_logout: (user: object) => void,
    on_recover_password: (email_address: string) => void,
    on_reset_password: ({ token, token_expires_at, user }) => void
  }
}

Parameters

on_login()

token string required

The login token generated for the user.

token_expires_at string required

The expiration date/time of the login token as an ISO string.

user object required

The logged-in user’s data.

on_signup()

token string required

The signup token generated for the user.

token_expires_at string required

The expiration date/time of the signup token as an ISO string.

user object required

The newly signed up user’s data.

on_logout()

user object required

The user who has logged out.

on_recover_password()

email_address string required

The email address associated with the password recovery request.

on_reset_password()

token string required

The reset password token generated for the user.

token_expires_at string required

The expiration date/time of the reset token as an ISO string.

user object required

The user whose password was reset.