Skip to content
On this page

onBeforeAll()

This hook/event is called the before fetching all items.

It can be used in the ALL handler.

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

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

IHookParameters

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

ParameterDescription
requestRequest object of Expresss
responseResponse object of Expresss
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.
conditionsThe conditions which has been send by the HTTP client to filter data.

Released under the MIT License.