mitt README

The project's README from github.com/developit/mitt. As one markdown file: README.md.

mitt
npm build status gzip size

Mitt

Tiny 200b functional event emitter / pubsub.

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

off

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

Parameters

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

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.

License

MIT License © Jason Miller

mitt (developit/mitt)

Searching Database…

11.9K ·GitHub
Mitt
Что это?Mitt — это крошечная функциональная библиотека для генерации и подписки на события (event emitter / pubsub) для JavaScript, весящая менее 200 байт в сжатом виде gzip.
Это класс EventEmitter, как в Node, или что-то другое?Это функциональный подход, а не классовый: методы не используют 'this', поэтому обработчики не нужно привязывать (bind). При этом названия методов и идеи повторяют EventEmitter из Node.
Как добавить её в проект?Установите через npm и соберите вместе с модульным сборщиком, например rollup или webpack, либо загрузите готовую UMD-сборку напрямую с unpkg, где она доступна как window.mitt.
Нужны ли какие-то другие библиотеки, чтобы её использовать?Нет, у неё нет зависимостей, и она работает в любой среде выполнения JavaScript, включая IE9+.
Есть ли подводные камни с обработчиком всех событий (wildcard)?Обработчики с подстановочным знаком '*' вызываются после обработчиков, подписанных на конкретный тип события, когда вы генерируете событие, и вручную вызвать обработчики '*' нельзя.
Работает ли она только в браузере?Изначально её создавали для браузера, но поскольку у неё нет зависимостей, она работает в любой среде выполнения JavaScript.
Как подписаться сразу на все события?Зарегистрируйте обработчик для специального типа события '*', который работает как подстановочный знак и получает каждое генерируемое событие.
Есть ли особая поддержка TypeScript?Да: задайте strict: true в tsconfig.json для улучшенного вывода типов или используйте готовый тип Emitter напрямую.
Как удалить обработчик?Вызовите off(type, handler); если не указать handler, все обработчики для этого типа события будут удалены сразу.
Почему проект называется mitt?Согласно README, автору просто понравилось, что имя 'mitt' ещё не было занято как название пакета.
What are similar projects?ky, fullcalendar, node-redis, hubot, fastclick, Chart.js, chakra-ui, tiptap
Which topics is it in?event, pubsub, npm, frontend, nodejs, library, typescript, javascript, web, developer-tools, mit, open-source
Creator
developit
Size
0.2 MB
Stars
11.9K
Updated
CommitJul 04Release3.0.1Jul 04
Age
9y
Commits · 90 Days