Skip to content

onBeforeUpdateQuery()

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

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

It can be used in the UPDATE handler.

ts
import { IContext } from "axe-api";

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

IContext

TIP

See the IContext reference to learn more.

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

ParameterDescription
reqAxeRequest
resAxeResponse
modelCurrent model instance. For example; User
databaseDatabase connection instance. For example Knex.js
relationThe relation definition if the route is a related route (For example api/v1/users/:userId/posts).
parentModelThe parent model instance if the route is a related route (For example api/v1/users/:userId/posts).
queryThe Knex.js' query instance.

Released under the MIT License.