onfire.js/README.md

onfire.js is a mini (~500 b) version for event-emitter.

# onfire.js

> nano version (~ 500b) for event-emitter.

[![Build Status](https://travis-ci.org/hustcc/onfire.js.svg?branch=master)](https://travis-ci.org/hustcc/onfire.js)
[![npm](https://img.shields.io/npm/v/onfire.js.svg)](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).