onBeforePatch()

This hook/event is called the before patching a new record.

It can be used in the PATCH handler.

app/v1/Hooks/User/onBeforePatch.ts

import { IBeforePatchContext } from "axe-api";

export default async (parameters: IBeforePatchContext) => {
  // do something in here
};

IBeforePatchContext

The following parameters can be used in the hook/event function;

Parameter	Description
req	AxeRequest
res	AxeResponse
model	Current model instance. For example; User
database	Database connection instance. For example Knex.js
relation	The relation definition if the route is a related route (For example api/v1/users/:userId/posts).
parentModel	The parent model instance if the route is a related route (For example api/v1/users/:userId/posts).
query	The Knex.js' query instance.
item	The current record.
formData	The data has been sent by HTTP client to create or update row.