Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oskang09/fastify-cote
Fastify Cote decorator & helper for reply mechanism plugins
https://github.com/oskang09/fastify-cote
Last synced: about 2 months ago
JSON representation
Fastify Cote decorator & helper for reply mechanism plugins
- Host: GitHub
- URL: https://github.com/oskang09/fastify-cote
- Owner: Oskang09
- Created: 2019-04-23T08:10:31.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-23T16:02:18.000Z (about 2 years ago)
- Last Synced: 2023-03-02T23:22:38.255Z (almost 2 years ago)
- Language: JavaScript
- Size: 38.1 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# fastify-cote
Fastify plugin for work with Cote easier by adding decorator & helpers for reply-mechanism.
# Installation
Using npm:
```
$ npm i --save fastify-cote
```
# Registering Plugins
```javascript
const fastify = require('fastify')();
const fastify_cote = require('fastify-cote');
const CoteRequester = require('cote').Requester;
const CoteResponder = require('cote').Responder;
fastify.register(fastify_cote, {
requester: {
decorator: 'getRequest',
instances: {
first: new CoteResponder({ name: 'request' }),
server: new CoteResponder({ name: 'request' })
}
},
responder: {
instance: 'runService' || new CoteResponder({ name: 'respond' }),
decorator: 'run',
actions: {
updateUser: {
event: 'user.update',
listener: async function (payload) {
// code for update user
// access fastify instance using `this`
}
}
}
}
});
```
# Explaination
```javascript
module.exports = {
requester: {
// Can only be 'string', you would access using `fastify.getRequester(name);`
decorator: 'getRequester',
instances: {
// Must be key, `cote.requester` instances
first: new CoteResponder({ name: 'request' }),
server: new CoteResponder({ name: 'request' })
},
/*
When trying access requester with these denifition using
> const response = await fastify.getRequester('first').send({
> type: 'event',
> payload: {
> ...data
> }
> });
*/
},
responder: {
// Can be `string` or `cote.responder` instances
instance: 'respond' || new CoteResponder({ name: 'respond' }),
// Can only be 'string', you would access using `fastify.run(action, payload);`
decorator: 'runService',
actions: {
// A custom name for let you access faster or easier when using `decorator`
updateUser : {
// Target server-side event name when requesting
event: 'update.user',
// Run action when someone `requesting` this or accessing using `fastify.run();`
listener: async function (payload) {
// access fastify instance using `this`
}
}
}
/*
When trying access responder with these denifition using
> const response = await fastify.runService('updateUser', { name: 'oska' });
Responder will receive the whole object as payload
* when accessing using requester, 'payload' only passed into listener.
*/
}
};
```
# Changelog
- 0.0.1 Release
- 0.0.2 Update requester method to async or non-async
- 0.0.3 Fix missing services issues
- 0.0.4 Fix emmiter issues
- 0.0.5 Planning new & better structure after tested
- 0.1.0 Better and new structure
- 0.1.1 Fix minor issues
- 0.1.5 Added multiple requester
- 0.1.6 Fix minor issues
- 0.1.8 Invalid passing listener
- 0.1.9 Missing payload when run service
# Maintainers
- [Oskang09](https://github.com/Oskang09)