register() #

Available since 2.8.0

Registers a new hook on an event.

This method can only be used before the application is started.

Copied to clipboard!

register(event: string, handler: ClusterEventHandler): void

Argument	Type	Description
event	string	Event name
handler	ClusterEventHandler	Function to execute when the event is triggered

Usage #

Copied to clipboard!

app.hook.register('request:onError', (request: KuzzleRequest) => {
  app.log.error(error)
});

Strong typing #

It's possible to specify the arguments with whom the handler will be called.

Copied to clipboard!

type EventGenericDocumentAfterWrite = {
  name: 'generic:document:afterWrite';

  args: [Document[], KuzzleRequest];
}

app.hook.register<EventGenericDocumentAfterWrite>(
  'generic:document:afterWrite',
  async (documents: Document[], request: KuzzleRequest) => {
    app.log.error(documents);
  });