https://github.com/arve0/feathers-custom-methods
add custom methods to your feathersjs services
https://github.com/arve0/feathers-custom-methods
Last synced: 20 days ago
JSON representation
add custom methods to your feathersjs services
- Host: GitHub
- URL: https://github.com/arve0/feathers-custom-methods
- Owner: arve0
- Created: 2017-11-07T00:34:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-10T02:39:41.000Z (over 6 years ago)
- Last Synced: 2025-04-07T22:51:11.750Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/feathers-custom-methods
- Size: 19.5 KB
- Stars: 16
- Watchers: 3
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# feathers-custom-methods
Add custom methods to your services. For example:
```js
emailService.send(address, subject, content)
```
## Install
```
npm i feathers-custom-methods
```
## Usage
Server side, configure the plugin and implement the method:
```js
const customMethods = require('feathers-custom-methods')
app.configure(customMethods({
methods: {
email: ['send'] // allow calling app.service('email').send client side
}
}))
app.service('email').send = function (address, subject, content) {
// implement the method
// or implement it through a custom service:
// const emailService = {
// send(address, subject, content) { /* implementation */ }
// }
// app.use('/email', emailService)
}
```
Client side, configure the client plugin:
```js
import customMethods from 'feathers-custom-methods/client'
app.configure(customMethods({
methods: {
email: ['send']
}
}))
```
Now you can use `send` as a method on the `email` service client side:
```js
app.service('email').send(address, subject, content)
.then(response => {
// handle response
}).catch(err => {
// handle error
})
```
The code above will call `app.service('email').send` server side with the same arguments.
## HTTP requests
feathers-custom-methods uses the [create](https://docs.feathersjs.com/api/services.html#createdata-params) method to send data from client to server. In other words, the call `service.send(arg1, arg2)` is equivalent to:
```js
service.create({
method: 'send',
arguments: [arg1, arg2]
})
```
Which means that you can call custom methods through HTTP requests like this:
```
curl -X POST -H "Content-Type:application/json" -d '{ "method": "send", "arguments": ["[email protected]", "subject", "content"] }' http://localhost:3030/email
```
## Development
```
npm test # will start node test.js
```
The test will open in a browser window. When the test ends, you must navigate back to the terminal. For more information, see [test.js](test.js) and [index.html](index.html).
## License
MIT