Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imcuttle/node-await-event-emitter
await events library like EventEmitter
https://github.com/imcuttle/node-await-event-emitter
async await event-emitter events nodejs
Last synced: 7 days ago
JSON representation
await events library like EventEmitter
- Host: GitHub
- URL: https://github.com/imcuttle/node-await-event-emitter
- Owner: imcuttle
- License: mit
- Created: 2018-01-21T11:18:41.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-08-23T23:42:07.000Z (11 months ago)
- Last Synced: 2024-06-18T15:37:24.295Z (18 days ago)
- Topics: async, await, event-emitter, events, nodejs
- Language: TypeScript
- Size: 1.51 MB
- Stars: 21
- Watchers: 2
- Forks: 8
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: License
Lists
- awesome-stars - node-await-event-emitter - await events library like EventEmitter (TypeScript)
- awesome-stars - node-await-event-emitter - await events library like EventEmitter (JavaScript)
- awesome-stars - imcuttle/node-await-event-emitter - await events library like EventEmitter (TypeScript)
README
# await-event-emitter
**Note: node-await-event-emitter is just implements the series processing, If you need parallel case, Please use the package [tapable](https://www.npmjs.com/package/tapable) which is used by webpack.**
Await events library like EventEmitter
[](https://travis-ci.org/imcuttle/node-await-event-emitter)
[](https://codecov.io/github/imcuttle/node-await-event-emitter?branch=master)
[](https://www.npmjs.com/package/await-event-emitter)
[](https://www.npmjs.com/package/await-event-emitter)
## Why?
The concept of Webpack plugin has lots of lifecycle hooks, they implement this via EventEmitter.
In the primitive [events](https://nodejs.org/dist/latest/docs/api/events.html) module on nodejs, the usage as follows
```javascript
const EventEmitter = require('events')
const emitter = new EventEmitter()
emitter
.on('event', () => {
// do something *synchronously*
})
.emit('event', '...arguments')
```
The listener must be **synchronous**, that is way i wrote it.
And await-event-emitter support synchronous emitter magically :smile:
## Installation
```bash
npm install --save await-event-emitter
```
## Usage
```javascript
const AwaitEventEmitter = require('await-event-emitter').default
const emitter = new AwaitEventEmitter()
const tick = () =>
new Promise((resolve) => {
setTimeout(() => {
console.log('tick')
resolve()
}, 1000)
})
emitter.on('event', async () => {
// wait to print
await tick()
})
async function run() {
// NOTE: it's important to `await` the reset process
await emitter.emit('event', '...arguments')
await emitter.emit('event', 'again')
// support emit it synchronously
emitter.emitSync('event', 'again')
}
run()
```
## API
### Class `AwaitEventEmitter`
- `addListener(event, listener)` : AwaitEventEmitter
alias: `on`
- `once(event, listener)`
- `prependListener(event, listener)` : AwaitEventEmitter
alias: `prepend`
- `prependOnceListener(event, listener)` : AwaitEventEmitter
alias: `prependOnce`
- `removeListener(event, listener)` : AwaitEventEmitter
alias: `off`
- `listeners(event)` : []
- `emit(event, ...args)` : Promise.resolve(boolean)
emit listeners asynchronously, we recommended await it resolved the result
- `emitSync(event, ...args)` : boolean
emit listeners synchronously
## Test
```bash
npm test
```
## Contributing
- Fork it!
- Create your new branch:
`git checkout -b feature-new` or `git checkout -b fix-which-bug`
- Start your magic work now
- Make sure npm test passes
- Commit your changes:
`git commit -am 'feat: some description (close #123)'` or `git commit -am 'fix: some description (fix #123)'`
- Push to the branch: `git push`
- Submit a pull request :)
## Authors
This library is written and maintained by imcuttle, [email protected].
## License
MIT - [imcuttle](https://github.com/imcuttle) 🐟