| Argument |
Type |
Description |
Required |
name |
String or Array of Strings |
Hook name, for example 'save'. Or an array of names, see example below. |
Yes |
method |
Function |
Callback to be executed after all before hooks finished execution successfully. options is passed as first argument |
Yes |
options |
Object |
Will be passed to all before hooks as reference, so they can mutate it |
No, defaults to empty object ({}) |
Resolves with whatever `method` returns or resolves with.
Rejects with error that is thrown or rejected with by
1. Any of the before hooks, whichever rejects / throws first
2. `method`
3. Any of the after hooks, whichever rejects / throws first
Simple Example
```js
hookCollection(
"save",
function (record) {
return store.save(record);
},
record
);
// shorter: hookCollection('save', store.save, record)
hookCollection.before("save", function addTimestamps(record) {
const now = new Date().toISOString();
if (record.createdAt) {
record.updatedAt = now;
} else {
record.createdAt = now;
}
});
```
Example defining multiple hooks at once.
```js
hookCollection(
["add", "save"],
function (record) {
return store.save(record);
},
record
);
hookCollection.before("add", function addTimestamps(record) {
if (!record.type) {
throw new Error("type property is required");
}
});
hookCollection.before("save", function addTimestamps(record) {
if (!record.type) {
throw new Error("type property is required");
}
});
```
Defining multiple hooks is helpful if you have similar methods for which you want to define separate hooks, but also an additional hook that gets called for all at once. The example above is equal to this:
```js
hookCollection(
"add",
function (record) {
return hookCollection(
"save",
function (record) {
return store.save(record);
},
record
);
},
record
);
```
### hookCollection.before()
Add before hook for given name.
```js
hookCollection.before(name, method);
```