diff options
| author | Jason Miller <[email protected]> | 2017-01-14 21:48:51 -0500 |
|---|---|---|
| committer | Jason Miller <[email protected]> | 2017-01-14 21:48:51 -0500 |
| commit | e77a42cdeca3f4c484f82a335a8a2bb8382d4fcc (patch) | |
| tree | 612f883228b2db7343df71151427480f82b35206 /README.md | |
Initial commit! 🚀
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..2b6974e --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +# `mitt` + +[](https://www.npmjs.org/package/mitt) +[](https://travis-ci.org/developit/mitt) + +**Tiny (~200b) functional event emitter / pubsub.** + +**It's tiny:** no dependencies and only **190 bytes** when gzipped _(250b without)_. + +* * * + +## Installation + +```sh +npm install --save mitt +``` + +* * * + +## API + +### mitt + +Mitt: Tiny (~200b) functional event emitter / pubsub. + +Returns **Mitt** + +#### on + +Register an event handler for the given type. + +**Parameters** + +- `type` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Type of event to listen for, or `"*"` for all events +- `handler` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Function to call in response to the given event + +#### off + +Remove an event handler for the given type. + +**Parameters** + +- `type` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Type of event to unregister `handler` from, or `"*"` +- `handler` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Handler function to remove + +#### emit + +Invoke all handlers for the given type. +If present, `"*"` handlers are invoked prior to type-matched handlers. + +**Parameters** + +- `type` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The event type to invoke +- `event` **\[Any]** An event object, passed to each handler |
