Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glentiki/seneca-fire-and-forget
A Seneca.js decorator that adds a fire-and-forget method.
https://github.com/glentiki/seneca-fire-and-forget
Last synced: about 2 hours ago
JSON representation
A Seneca.js decorator that adds a fire-and-forget method.
- Host: GitHub
- URL: https://github.com/glentiki/seneca-fire-and-forget
- Owner: GlenTiki
- License: mit
- Created: 2016-01-11T17:43:41.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-01-12T17:43:04.000Z (almost 9 years ago)
- Last Synced: 2025-01-05T09:20:33.708Z (1 day ago)
- Language: JavaScript
- Homepage:
- Size: 11.7 KB
- Stars: 9
- Watchers: 4
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# A [Seneca.js][] *decorator* that adds a fire-and-forget method.
# Seneca-fire-and-forget
[![npm version][npm-badge]][npm-url]
[![Build Status][travis-badge]][travis-url]
[![Coverage Status][coverage-badge]][coverage-url]
[![Dependency Status][david-badge]][david-url]
[![Gitter chat][gitter-badge]][gitter-url]
This is a plugin for Seneca that adds a simple `.fire(pattern[, cb])` method to
your Seneca instance. This acts in a fire-and-forget manner, so this will
swallow any errors from the act you called. _The callback is optional._
- lead maintainer: [Glen Keane][lead]
## Example
```javascript
var seneca = require('seneca')()
seneca.use(require('fire-and-forget'))
// A basic pattern to use
seneca.add({ role: 'foo' }, (args, done) => {
// maybe save args.name in a database?
done(null, { msg: `hey ${args.name}!` })
})
// Expected use!, no reply is expected, so callback can be excluded
seneca.fire({ role: 'foo', name: 'glen' })
// Don't actually need to worry about any error here...
seneca.fire({ role: 'bar', name: 'glen' })
// Firing and using the reply data
seneca.fire({ role: 'foo', name: 'glen' }, (err, reply) => {
if (err) {
//maybe handle an error if it happens?
}
console.log(reply.msg)
})
// Firing, but no reply to be expected
seneca.fire({ role: 'bar', name: 'glen' }, (err, reply) => {
if (err) {
//maybe handle an error if it happens?
}
console.log(reply.msg)
})
```
## API
```javascript
seneca.fire(args[, callback])
```
### `args`
your standard `seneca` argument object/pattern, which you would expect to call any function with.
### `callback` **(optional)**
Function which can be called, taking two arguments:
- **Error**: This is any error which was generated when calling the pattern (eg. act_not_found).
- **Result**: This is the result returned by the `seneca` function for the pattern you pass in.
## Contributing
This module follows the general [Senecajs org][senecaOrg] contribution guidelines, and encourages open participation. If you feel you can help in any way, or discover any Issues, feel free to [create an issue][issue] or [create a pull request][pr]!
If you wish to read more on our guidelines, feel free to
- Checkout the concise [contribution file][contrib]
- Checkout our much more indepth [contributing guidelines][contribGuide]
## License
Copyright Glen Keane and other contributors 2016, Licensed under [MIT][].
[Seneca.js]: https://www.npmjs.com/package/seneca
[senecaOrg]: https://github.com/senecajs/
[issue]: https://github.com/senecajs/seneca-fire-and-forget/issues
[pr]:https://github.com/senecajs/seneca-fire-and-forget/pulls
[MIT]: ./LICENSE
[contrib]: ./CONTRIBUTING.md
[contribGuide]: http://senecajs.org/contribute/
[npm-badge]: https://img.shields.io/npm/v/seneca-fire-and-forget.svg
[npm-url]: https://npmjs.com/package/seneca-fire-and-forget
[travis-badge]: https://api.travis-ci.org/senecajs/seneca-fire-and-forget.svg
[travis-url]: https://travis-ci.org/senecajs/seneca-fire-and-forget
[coverage-badge]:https://coveralls.io/repos/senecajs/seneca-fire-and-forget/badge.svg?branch=master&service=github
[coverage-url]: https://coveralls.io/github/senecajs/seneca-fire-and-forget?branch=master
[david-badge]: https://david-dm.org/senecajs/seneca-fire-and-forget.svg
[david-url]: https://david-dm.org/senecajs/seneca-fire-and-forget
[gitter-badge]: https://badges.gitter.im/senecajs/seneca.svg
[gitter-url]: https://gitter.im/senecajs/seneca
[lead]: https://github.com/thekemkid