You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
59 lines
1.1 KiB
59 lines
1.1 KiB
3 years ago
|
# onfire.js
|
||
|
|
|
||
|
|
> nano version (~ 500b) for event-emitter.
|
||
|
|
|
||
|
|
[](https://travis-ci.org/hustcc/onfire.js)
|
||
|
|
[](https://www.npmjs.com/package/onfire.js)
|
||
|
|
|
||
|
|
|
||
|
|
[中文文档](./README_zh.md) | [English Doc](./README.md)
|
||
|
|
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
> npm i --save onfire.js
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
import EE from 'onfire.js';
|
||
|
|
|
||
|
|
const ee = new EE();
|
||
|
|
|
||
|
|
ee.on('mouseover', () => {});
|
||
|
|
|
||
|
|
ee.once('click', () => {});
|
||
|
|
|
||
|
|
ee.fire('click', 1, 'hello', true);
|
||
|
|
|
||
|
|
ee.off('click');
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
Simple and similar with `event-emitter`.
|
||
|
|
|
||
|
|
|
||
|
|
- `on(eventName: string, callback: Function)`: listen an event.
|
||
|
|
- `once(eventName: string, callback: Function)`: listen a event only once.
|
||
|
|
- `fire(eventName: string, ...parameters: any[])`: emit / trigger an event with parameters.
|
||
|
|
- `off(eventName?: string, callback?: Function)`: unsubscribe an event.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Used
|
||
|
|
|
||
|
|
- Events subscribe and dispatcher.
|
||
|
|
- `Cross-component communication` for React / Vue / Angular.
|
||
|
|
- System event mechanism.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT@[hustcc](https://github.com/hustcc).
|