Hooks

Hook into a model's lifecycle with events such as creating, created, updating, saved, deleting, restoring, and forceDeleted.

Sutando models dispatch several events, allowing you to hook into the following moments in a model’s lifecycle: creating, created, updating, updated, saving, saved, deleting, deleted, restoring, restored, trashed, forceDeleting and forceDeleted.

Event names ending with -ing are dispatched before any changes to the model are persisted, while events ending with -ed are dispatched after the changes to the model are persisted.

Available hooks

Declaring Hooks

There are currently two ways to programmatically add hooks:

class User extends Model {}

User.creating(user => {
  //
});

class User {
  static booted() {
    this.creating(user => {
      //
    });

    this.created(user => {
      //
    });
  }
}

Hooks and Transactions

User.deleted(async (user, { client }) => {
  const query = user.related('posts');

  if (client) {
    query.transacting(client);
  }

  await query.delete();
});

const trx = await sutando.beginTransaction();

await user.delete({
  client: trx
});

await trx.commit();