Wildcard Events #

Kuzzle allows you to listen to multiple events with a single listener thanks to wildcards (*).

Name wildcard #

*

You can catch all the actions of a controller by using a wildcard instead of the action name.

Naming Template #

The event name is built using the following template:

<controller>:*

• controller: controller name

Example #

this.pipes = 
  // the listener function is executed every time an
  // event is triggered by the "document" controller
  'document:*': <function to call> 
};

Templated events wildcard #

KuzzleRequest

Wildcards permit listening templated events.

Naming Template #

The event name is built using the following template:

<controller>:<template>*

• controller: API controller name
• template: before, after or error

Example #

this.pipes = 
  // the listener function is executed after every successful
  // API action performed by the "document" controller
  'document:after*': <function to call>
};