https://github.com/elliothux/eventproxy
🍺 A ease-to-use event proxy within 1.5KB
https://github.com/elliothux/eventproxy
eventemitter eventproxy js nodejs
Last synced: 8 months ago
JSON representation
🍺 A ease-to-use event proxy within 1.5KB
- Host: GitHub
- URL: https://github.com/elliothux/eventproxy
- Owner: elliothux
- Created: 2018-02-10T14:31:57.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-17T04:57:31.000Z (over 7 years ago)
- Last Synced: 2025-02-18T23:03:25.078Z (8 months ago)
- Topics: eventemitter, eventproxy, js, nodejs
- Language: JavaScript
- Homepage:
- Size: 1.95 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A ease-to-use event proxy within 1.5KB
## Install
`npm install event-proxy.js`
## Basic Usage
```js
import EventProxy from 'event-proxy.js';
const event = new EventProxy();
const sayHello = (name) => console.log(`Hello ${name}`);
event.on('hello', sayHello);
event.emit('hello', 'Joe'); // Log "Hello Joe"
event.cancel('hello', sayHello);
event.emit('hello', 'Joe'); // Nothing Happened
event.once('hello', sayHello);
event.emit('hello', 'Joe'); // Log "Hello Joe"
event.emit('hello', 'Joe'); // Nothing Happened
```
## API
* **on(eventName, handler)**: Add an event Listener
* **once(eventName, handler)**: Add a disposable event Listener
* **emit(eventName, [...args])**: Trigger an event
* **cancel(eventName, handler)**: Remove the handler of the event
* **cancelOnce(eventName, handler)**: Remove the disposable handler of the event
* **cancelAll(eventName)**: Remove all handlers of the event
* **cancelAllOnce(eventName)**: Remove all disposable handlers of the event