Documentation for wildcard events

package.json

@@ -29,6 +29,7 @@
     "js-cookie": "^2.1.4",
     "lunr": "^2.3.6",
     "moment": "^2.24.0",
+    "mqtt": "^3.0.0",
     "node-sass": "^4.11.0",
     "prompt-confirm": "^2.0.4",
     "read-yaml": "^1.1.0",

src/.vuepress/util.js

@@ -148,10 +148,10 @@ function sortPagesByOrderAndTitle(p1, p2) {
   const o1 = get(p1, 'frontmatter.order', null);
   const o2 = get(p2, 'frontmatter.order', null);
 
-  if ((o1 === null || typeof o1 === 'undefined') && o2) {
+  if ((o1 === null || typeof o1 === 'undefined') && !isNaN(o2)) {
     return 1;
   }
-  if ((o2 === null || typeof o2 === 'undefined') && o1) {
+  if ((o2 === null || typeof o2 === 'undefined') && !isNaN(o1)) {
     return -1;
   }
   if (o1 === o2) {

src/core/1/plugins/plugins/events/wildcard-events/index.md

@@ -0,0 +1,86 @@
+---
+type: page
+code: false
+title: Wildcard Events
+order: 250
+---
+
+# Wildcard Events
+
+Kuzzle allows you to listen to multiple events with a single listener thanks to wildcards (`*`).
+
+---
+
+## Single wildcard
+
+| Arguments | Type                                                           | Description                |
+| --------- | -------------------------------------------------------------- | -------------------------- |
+| `request` | <pre><a href=/plugins/1/constructors/request>Request</a></pre> | The normalized API request |
+
+With a single wildcard you can listen to all the events triggered by Kuzzle.
+
+#### Example
+
+```javascript
+this.pipes = 
+  // listener function will be triggered at each event
+  '*': <function to call> 
+};
+```
+
+---
+
+## Name wildcard
+
+| Arguments | Type                                                           | Description                |
+| --------- | -------------------------------------------------------------- | -------------------------- |
+| `request` | <pre><a href=/plugins/1/constructors/request>Request</a></pre> | The normalized API request |
+
+You can also use wildcards to replace only the name of an event.
+
+### Naming Template
+
+The event name is built using the following template:
+
+`<controller>:*`
+
+- `controller`: API controller name
+
+#### Example
+
+```javascript
+this.pipes = 
+  // listener function will trigger at each
+  // events triggered in the document namespace
+  'document:*': <function to call> 
+};
+```
+
+---
+
+## Templated events wildcard
+
+| Arguments | Type                                                           | Description                |
+| --------- | -------------------------------------------------------------- | -------------------------- |
+| `request` | <pre><a href=/plugins/1/constructors/request>Request</a></pre> | The normalized API request |
+
+Wildcards permit listenening 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
+
+```javascript
+this.pipes = 
+  // listener function will trigger after each
+  // events triggered in the document namespace
+  'document:after*': <function to call>
+};
+```