mitt vs nanoevents
Event Handling Libraries Comparison
1 Year
mittnanoeventsSimilar Packages:
What's Event Handling Libraries?

Event handling libraries in JavaScript provide a way to create, manage, and respond to events in a structured manner. These libraries help in building applications that require communication between different parts of the code, allowing for better organization and decoupling of components. They are particularly useful in scenarios like handling user interactions, managing asynchronous operations, or implementing publish-subscribe patterns. mitt is a tiny, simple, and fast event emitter with a minimal API, while nanoevents is a lightweight and efficient event emitter that supports multiple listeners per event and provides a more modern API.

Package Weekly Downloads Trend
Github Stars Ranking
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
mitt9,238,61711,11526.4 kB202 years agoMIT
nanoevents151,3981,5155.43 kB05 months agoMIT
Feature Comparison: mitt vs nanoevents

Size and Performance

  • mitt:

    mitt is extremely lightweight, with a minified size of around 200 bytes. Its simple design ensures fast performance, making it ideal for performance-sensitive applications where every byte counts.

  • nanoevents:

    nanoevents is also very small (about 300 bytes minified), but it offers more features like support for multiple listeners per event. The trade-off in size is minimal compared to the added functionality, making it a great choice for modern applications.

API Design

  • mitt:

    mitt provides a very simple and intuitive API for emitting and listening to events. It has a minimalistic design with just a few methods, making it easy to learn and use without any complex documentation.

  • nanoevents:

    nanoevents offers a more modern API that supports multiple listeners per event. It is slightly more complex than mitt, but the added functionality is well-documented and easy to understand, making it accessible for developers.

Multiple Listeners

  • mitt:

    mitt supports only a single listener per event by default. If you add a new listener for the same event, it will overwrite the previous one. This keeps the API simple but limits flexibility.

  • nanoevents:

    nanoevents allows multiple listeners for the same event, enabling more flexible event handling. You can add as many listeners as you want, and they will all be called when the event is emitted, which is useful for more complex applications.

Memory Management

  • mitt:

    mitt does not have built-in memory management features. If you need to remove listeners, you have to do it manually, which can lead to memory leaks if not handled properly.

  • nanoevents:

    nanoevents provides better memory management by allowing you to easily remove listeners. It also includes a mechanism to prevent memory leaks, making it a safer choice for long-running applications.

Ease of Use: Code Examples

  • mitt:

    Simple Event Handling with mitt

    import mitt from 'mitt';
    const emitter = mitt();
    
    // Single listener
    emitter.on('event', () => console.log('Event triggered!'));
    emitter.emit('event');
    
    // Manual listener removal
    const handler = () => console.log('Another event!');
    emitter.on('event', handler);
    emitter.off('event', handler);
    
  • nanoevents:

    Multiple Listeners with nanoevents

    import { NanoEvents } from 'nanoevents';
    const emitter = new NanoEvents();
    
    // Adding multiple listeners
    const unsubscribe1 = emitter.on('event', () => console.log('Listener 1')); 
    const unsubscribe2 = emitter.on('event', () => console.log('Listener 2'));
    
    // Emitting the event
    emitter.emit('event');
    
    // Removing a listener
    unsubscribe1();
    
How to Choose: mitt vs nanoevents
  • mitt:

    Choose mitt if you need a minimalistic event emitter with a small footprint and straightforward API. It is ideal for projects where simplicity and performance are priorities, and you don’t need advanced features like multiple listeners or namespaces.

  • nanoevents:

    Choose nanoevents if you want a lightweight event emitter that supports multiple listeners per event and provides better memory management. It is suitable for applications that require more flexibility in event handling without adding significant overhead.

README for mitt

mitt
npm build status gzip size

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
  • Functional: methods don't rely on this
  • Great Name: somehow mitt wasn't taken

Mitt was made for the browser, but works in any JavaScript runtime. It has no dependencies and supports IE9+.

Table of Contents

Install

This project uses node and npm. Go check them out if you don't have them locally installed.

$ npm install --save mitt

Then with a module bundler like rollup or webpack, use as you would anything else:

// using ES6 modules
import mitt from 'mitt'

// using CommonJS modules
var mitt = require('mitt')

The UMD build is also available on unpkg:

<script src="https://unpkg.com/mitt/dist/mitt.umd.js"></script>

You can find the library on window.mitt.

Usage

import mitt from 'mitt'

const 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' })

// clearing all events
emitter.all.clear()

// working with handler references:
function onFoo() {}
emitter.on('foo', onFoo)   // listen
emitter.off('foo', onFoo)  // unlisten

Typescript

Set "strict": true in your tsconfig.json to get improved type inference for mitt instance methods.

import mitt from 'mitt';

type Events = {
  foo: string;
  bar?: number;
};

const emitter = mitt<Events>(); // inferred as Emitter<Events>

emitter.on('foo', (e) => {}); // 'e' has inferred type 'string'

emitter.emit('foo', 42); // Error: Argument of type 'number' is not assignable to parameter of type 'string'. (2345)

Alternatively, you can use the provided Emitter type:

import mitt, { Emitter } from 'mitt';

type Events = {
  foo: string;
  bar?: number;
};

const emitter: Emitter<Events> = mitt<Events>();

Examples & Demos

Preact + Mitt Codepen Demo
preact + mitt preview

API

Table of Contents

mitt

Mitt: Tiny (~200b) functional event emitter / pubsub.

Returns Mitt

all

A Map of event names to registered handler functions.

on

Register an event handler for the given type.

Parameters

  • type (string | symbol) Type of event to listen for, or '*' for all events
  • handler Function Function to call in response to given event

off

Remove an event handler for the given type. If handler is omitted, all handlers of the given type are removed.

Parameters

  • type (string | symbol) Type of event to unregister handler from, or '*'
  • handler Function? Handler function to remove

emit

Invoke all handlers for the given type. If present, '*' handlers are invoked after type-matched handlers.

Note: Manually firing '*' handlers is not supported.

Parameters

  • type (string | symbol) The event type to invoke
  • evt Any? Any value (object is recommended and powerful), passed to each handler

Contribute

First off, thanks for taking the time to contribute! Now, take a moment to be sure your contributions make sense to everyone else.

Reporting Issues

Found a problem? Want a new feature? First of all see if your issue or idea has already been reported. If don't, just open a new clear and descriptive issue.

Submitting pull requests

Pull requests are the greatest contributions, so be sure they are focused in scope, and do avoid unrelated commits.

  • Fork it!
  • Clone your fork: git clone https://github.com/<your-username>/mitt
  • Navigate to the newly cloned directory: cd mitt
  • Create a new branch for the new feature: git checkout -b my-new-feature
  • Install the tools necessary for development: npm install
  • Make your changes.
  • Commit your changes: git commit -am 'Add some feature'
  • Push to the branch: git push origin my-new-feature
  • Submit a pull request with full remarks documenting your changes.

License

MIT License © Jason Miller