Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devsu/loopback-setup-hooks-mixins
Mixins for Loopback, to easily configure operation and remote hooks from the model configuration file.
https://github.com/devsu/loopback-setup-hooks-mixins
Last synced: 2 months ago
JSON representation
Mixins for Loopback, to easily configure operation and remote hooks from the model configuration file.
- Host: GitHub
- URL: https://github.com/devsu/loopback-setup-hooks-mixins
- Owner: devsu
- License: mit
- Created: 2016-12-07T23:05:22.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-12-08T23:40:35.000Z (about 8 years ago)
- Last Synced: 2024-10-06T04:40:03.101Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 12.7 KB
- Stars: 6
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# loopback-setup-hooks-mixins
Mixin for Loopback, to easily configure operation and remote hooks from the model configuration file.
It works with Loopback 2 and Loopback 3.
## Installation
```bash
npm install --save loopback-setup-hooks-mixins
```
## Configuration
First, modify your `server/model-config.json` to include the path to this module:
```json
{
"mixins": [
"loopback/common/mixins",
"loopback/server/mixins",
"../common/mixins",
"./mixins",
"../node_modules/loopback-setup-hooks-mixins"
]
}
```
Then you can [use the mixins](https://loopback.io/doc/en/lb3/Defining-mixins.html#enable-a-model-with-mixins) from your model definition files:
```json
...
"mixins": {
"SetupOperationHooks": {
"source": "./common/models/employee-hooks.js",
"before save": ["doSomething"],
"before delete": ["checkSomething"]
},
"SetupRemoteHooks": {
"source": "./common/models/employee-hooks.js",
"beforeRemote": {
"deleteById": ["checkSomethingElse"],
},
"afterRemote": {
"create": ["doSomethingElse"]
}
}
}
...
```
## Available mixins
- [SetupOperationHooks](#setupoperationhooks)
- [SetupRemoteHooks](#setupremotehooks)
## SetupOperationHooks
Configures the defined operation hooks in the model.
### Options
- source (optional)
- name of the operation hooks (e.g. "before save", "after save", etc.)
### Usage
For each [operation hook](http://loopback.io/doc/en/lb3/Operation-hooks.html) that you want to configure, you will need to define a **string** or an **array** with the name(s) of the method(s) that should be called.
If you define `source` option, it will search the methods in that file, otherwise it will search the methods in the Model.
```json
"mixins": {
"SetupOperationHooks": {
"source": "./common/models/employee-hooks.js",
"before save": "doSomething",
"before delete": ["checkSomething", "doSomethingElse"]
}
}
```
The source file (`employee-hooks.js` in our example) would look like this:
```javascript
const Promise = require('bluebird');
module.exports = {
doSomething,
checkSomething,
doSomethingElse,
};
function doSomething(context) {
return new Promise((resolve, reject) => {
resolve();
});
}
function checkSomething(context) {
return new Promise((resolve, reject) => {
resolve();
});
}
function doSomethingElse(context) {
return new Promise((resolve, reject) => {
resolve();
});
}
```
The example is using promises, but if your prefer you could use the next callback as well.
## SetupRemoteHooks
Configures the defined remote hooks in the model.
### Options
- source (optional)
- beforeRemote
- afterRemote
- afterRemoteError
### Usage
The `beforeRemote`, `afterRemote` and `afterRemoteError` options should have the names of the remote methods you want to apply the hooks to.
Each remote method name is an object property that should contain a **string** or an **array** with the name(s) of the method(s) to be called.
If you define `source`, it will search the methods on that file, otherwise it will search the methods in the Model.
```json
"mixins": {
"SetupRemoteHooks": {
"source": "./common/models/employee-hooks.js",
"beforeRemote": {
"deleteById": ["checkSomething", "logSomething"],
},
"afterRemote": {
"create": "doSomething"
},
"afterRemoteError": {
"create": "doSomethingElse"
}
}
}
```
The source file (`employee-hooks.js` in our example) would look like this:
```javascript
module.exports = {
doSomething,
checkSomething,
logSomething,
};
function doSomething(context, instance, next) {
next();
}
function checkSomething(context, instance, next) {
next();
}
function logSomething(context, instance, next) {
next();
}
```
This example is not using promises, since it looks like they are not supported yet for remote hooks.
## Credits
Created by [c3s4r](https://github.com/c3s4r) for [Devsu](http://devsu.com/).
Copyright Devsu LLC, 2016.
License: MIT