https://github.com/azu/eventmit
Simple EventEmitter. A single event object per an event.
https://github.com/azu/eventmit
browser eventemitter events nodejs pubsub
Last synced: 23 days ago
JSON representation
Simple EventEmitter. A single event object per an event.
- Host: GitHub
- URL: https://github.com/azu/eventmit
- Owner: azu
- License: mit
- Created: 2020-05-29T15:57:57.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-12T00:21:18.000Z (4 months ago)
- Last Synced: 2025-03-29T05:07:42.941Z (about 1 month ago)
- Topics: browser, eventemitter, events, nodejs, pubsub
- Language: TypeScript
- Homepage:
- Size: 255 KB
- Stars: 61
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# eventmit [](https://github.com/azu/eventmit/actions?query=workflow%3A"test")
A single event object per an event.
## Feature
- A single event object per an event
- Tiny code base - less 1kb
- Written by TypeScript
## Install
Install with [npm](https://www.npmjs.com/):
npm install eventmit
Requirement: ECMAScript 2015 because this library use [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set).
## Usage
Create an eventmit object and register handler and invoke handlers.
```ts
import { eventmit } from "eventmit";
const event = eventmit<{ key: string }>();
// Register handler
event.on((value) => {
console.log(1, value);
});
event.on((value) => {
console.log(2, value);
});
// Invoke handler
event.emit({
key: "value"
});
// Unregister handler
event.offAll();
```
## API
```ts
export declare type EventmitHandler = (value: T) => any;
export declare type Eventmitter = {
/**
* Register an event handler
*/
on: (handler: EventmitHandler) => void;
/**
* Remove an event handler
*/
off: (handler: EventmitHandler) => void;
/**
* Remove all event handlers
*/
offAll: () => void;
/**
* Invoke all handlers
*/
emit: (value: T) => void;
};
export declare const eventmit: () => Eventmitter;
```
## ECMAScript Modules
You can import `eventmit` as ES Modules.
```js
import { eventmit } from "https://unpkg.com/eventmit?module";
const event = eventmit();
// Register handler
event.on((value) => {
console.log(value);
});
// Invoke handler
event.emit("value");
```
It means that eventmit work on Browser and [Deno](https://deno.land/).
### Import at Deno
If you are using Deno, import `eventmit` from a URL.
For example, using a CDN:
```typescript
import { eventmit } from "https://cdn.skypack.dev/eventmit?dts";
```
## Changelog
See [Releases page](https://github.com/azu/eventmit/releases).
## Running tests
Install devDependencies and Run `npm test`:
npm test
## Contributing
Pull requests and stars are always welcome.
For bugs and feature requests, [please create an issue](https://github.com/azu/eventmit/issues).
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## Author
- [github/azu](https://github.com/azu)
- [twitter/azu_re](https://twitter.com/azu_re)
## License
MIT © azu
## Related
- [developit/mitt: 🥊 Tiny 200 byte functional event emitter / pubsub.](https://github.com/developit/mitt)
- Support multiple event type