fix(checkContext): type as array (#636)

Author: fratzinger

docs/utilities.md

@@ -118,16 +118,16 @@ Restrict a hook to run for certain methods and method types.
 
 - **Arguments**
   - `{Object} context`
-  - `{String} [ type ]`
-  - `{Array< String >} [ methods ]`
+  - `{String | Array< String >} [ type ]`
+  - `{String | Array< String >} [ methods ]`
   - `{String} [ label ]`
 
-| Argument  |       Type        | Default       | Description                                                     |
-| --------- | :---------------: | ------------- | --------------------------------------------------------------- |
-| `context` |     `Object`      |               | The hook context.                                               |
-| `type`    |     `String`      | all types     | The service type allowed - before, after.                       |
-| `methods` | `Array< String >` | all methods   | The service methods allowed - find, get, update, patch, remove. |
-| `label`   |     `String`      | `'anonymous'` | Name of hook to use with `throw`.                               |
+| Argument  | Type                       | Default       | Description                                                     |
+| --------- | :------------------------: | ------------- | --------------------------------------------------------------- |
+| `context` |          `Object`          |               | The hook context.                                               |
+| `type`    | `String | Array< String >` | all types     | The service type allowed - before, after, error.                |
+| `methods` | `String | Array< String >` | all methods   | The service methods allowed - find, get, update, patch, remove. |
+| `label`   |         `String`           | `'anonymous'` | Name of hook to use with `throw`.                               |
 
 - **Example**
 

lib/services/check-context.js

@@ -2,8 +2,11 @@
 const stndMethods = ['find', 'get', 'create', 'update', 'patch', 'remove'];
 
 module.exports = function (context, type = null, methods = [], label = 'anonymous') {
-  if (type && context.type !== type) {
-    throw new Error(`The '${label}' hook can only be used as a '${type}' hook.`);
+  if (type) {
+    const types = Array.isArray(type) ? type : [type]; // safe enough for allowed values
+    if (!types.includes(context.type)) {
+      throw new Error(`The '${label}' hook can only be used as a '${type}' hook.`);
+    }
   }
 
   if (!methods) { return; }

tests/services/check-context.test.js

@@ -38,6 +38,16 @@ describe('services checkContext', () => {
     assert.equal(checkContext(hook, null), undefined);
   });
 
+  it('handles expected type as array', () => {
+    hook.type = 'before';
+    assert.equal(checkContext(hook, ['before', 'after']), undefined);
+  });
+
+  it('handles unexpected type as array', () => {
+    hook.type = 'error';
+    assert.throws(() => { checkContext(hook, ['before', 'after']); });
+  });
+
   it('handles expected method as string', () => {
     hook.method = 'create';
     assert.equal(checkContext(hook, null, 'create'), undefined);