onBeforePatchQuery()

This hook/event is called before the patch query is executed by Axe API.

For example; let's assume that you try to patch a user by a user id. This hook/event is called before the Axe API fetches the record to be patched.

It can be used in the PATCH handler.

app/v1/Hooks/User/onBeforePatchQuery.ts

import { IBeforePatchQueryContext } from "axe-api";

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

IBeforePatchQueryContext

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.