https://github.com/verywow/js-simple-events
Yet another simple event management system
https://github.com/verywow/js-simple-events
event-management events js management-system simple typescript
Last synced: about 2 months ago
JSON representation
Yet another simple event management system
- Host: GitHub
- URL: https://github.com/verywow/js-simple-events
- Owner: VeryWow
- Created: 2018-03-25T11:15:04.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-08-29T16:48:10.000Z (almost 2 years ago)
- Last Synced: 2025-04-22T18:12:40.182Z (about 2 months ago)
- Topics: event-management, events, js, management-system, simple, typescript
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/js-simple-events
- Size: 29.3 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# js-simple-events
> Yet another simple event management system
`npm i -S js-simple-events`
## About
This is just a simple class that helps to manage events in a simple way without dependencies. It also supports TypeScript!
And it's really light - <1kb in size!
## Methods
Method | Params | Description
-------- | ----------------- | ----------------------------------------------------------------
`emit` | `event, payload` | Emit the event with the given payload.
`fire` | `event, payload` | _Alias for `emit`_
`on` | `event, callback` | Listen for the event with the given callback.
`listen` | `event, callback` | _Alias for `on`_
`once` | `event, callback` | Listen for the event once, after handling - remove the listener.
`off` | `event, callback` | Remove event listener(s) for the event.
`remove` | `event, callback` | _Alias for `off`_
## Examples
```js
// Import and initialize
import EventManager from 'js-simple-events'
const eventManager = new EventManager();
// Define handlers
const eventHandler = (payload) => console.log('Yay, events work!', payload);
eventManager.on('test', eventHandler);
eventManager.once('test', () => console.log('This will be called just once!'));
// Emit events
eventManager.emit('test', 'Hello!');
// -> Yay, events work! Hello!
// -> This will be called just once!
eventManager.emit('test', 'Hello!');
// -> Yay, events work! Hello!
// (The 'once' handler isn't fired)
```
## Plugins
### [For Vue.js](https://github.com/kaskar2008/vue-simple-events)