mitt - npm Package Compare versions
Comparing version 1.0.0 to 1.0.1
| { | ||
| "name": "mitt", | ||
| "amdName": "mitt", | ||
| "version": "1.0.0", | ||
| "version": "1.0.1", | ||
| "description": "Tiny ~200b functional event emitter / pubsub.", | ||
@@ -27,3 +27,3 @@ "jsnext:main": "src/index.js", | ||
| ], | ||
| "homepage": "httsp://github.com/developit/mitt", | ||
| "homepage": "https://github.com/developit/mitt", | ||
| "authors": [ | ||
@@ -37,8 +37,2 @@ "Jason Miller <jason@developit.ca>" | ||
| ], | ||
| "babel": { | ||
| "presets": [ | ||
| "es2015", | ||
| "stage-0" | ||
| ] | ||
| }, | ||
| "eslintConfig": { | ||
@@ -69,3 +63,3 @@ "parser": "babel-eslint", | ||
| "npm-run-all": "^2.1.1", | ||
| "pretty-bytes": "^4.0.2", | ||
| "pretty-bytes-cli": "^2.0.0", | ||
| "rimraf": "^2.5.2", | ||
@@ -72,0 +66,0 @@ "rollup": "^0.41.4", |
@@ -1,16 +0,51 @@ | ||
| # `mitt` | ||
| <p align="center"> | ||
| <img src="https://i.imgur.com/BqsX9NT.png" width="256" height="256" alt="mitt"> | ||
| <br> | ||
| <b>Mitt</b>: tiny 200b functional event emitter / pubsub. | ||
| <br> | ||
| <a href="https://www.npmjs.org/package/mitt"><img src="https://img.shields.io/npm/v/mitt.svg?style=flat" alt="npm"></a> <a href="https://travis-ci.org/developit/mitt"><img src="https://travis-ci.org/developit/mitt.svg?branch=master" alt="travis"></a> | ||
| </p> | ||
| [](https://www.npmjs.org/package/mitt) | ||
| [](https://travis-ci.org/developit/mitt) | ||
| ## Why Mitt? | ||
| **Tiny (~200b) functional event emitter / pubsub.** | ||
| - **Microscopic:** weighs less than 200 bytes gzipped | ||
| - **Useful:** a wildcard `"*"` event type listens to all events | ||
| - **Familiar:** same names & ideas as [Node's EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) | ||
| - **Functional:** methods don't rely on `this` | ||
| - **Great Name:** somehow [mitt](https://npm.im/mitt) wasn't taken | ||
| **It's tiny:** no dependencies and only **190 bytes** when gzipped _(250b without)_. | ||
| > Mitt was made for the browser, but works in any JavaScript runtime. It has no dependencies and supports IE9+. | ||
| ## Examples & Demos | ||
| <a href="http://codepen.io/developit/pen/rjMEwW?editors=0110"> | ||
| <b>Preact + Mitt Codepen Demo</b> | ||
| <br> | ||
| <img src="https://i.imgur.com/CjBgOfJ.png" width="278" alt="preact + mitt preview"> | ||
| </a> | ||
| * * * | ||
| ## Installation | ||
| ## Usage | ||
| ```sh | ||
| npm install --save mitt | ||
| After installing via `npm install --save mitt`: | ||
| ```js | ||
| import mitt from 'mitt' | ||
| let emitter = mitt() | ||
| // listen to an event | ||
| emitter.on('foo', e => console.log('foo', e) ) | ||
| // listen to all events | ||
| emitter.on('*', (type, e) => console.log(type, e) ) | ||
| // fire an event | ||
| emitter.emit('foo', { a: 'b' }) | ||
| // working with handler references: | ||
| function onFoo() {} | ||
| emitter.on('foo', onFoo) // listen | ||
| emitter.off('foo', onFoo) // unlisten | ||
| ``` | ||
@@ -17,0 +52,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by10.77%
11479
- Number of lines in readme file
- increased by63.64%
90
No dependency changes