emittery 0.4.0 → 0.6.0

package/index.d.ts

@@ -0,0 +1,324 @@
+/**
+Emittery accepts strings and symbols as event names.
+
+Symbol event names can be used to avoid name collisions when your classes are extended, especially for internal events.
+*/
+type EventName = string | symbol;
+
+declare class Emittery {
+	/**
+	In TypeScript, it returns a decorator which mixins `Emittery` as property `emitteryPropertyName` and `methodNames`, or all `Emittery` methods if `methodNames` is not defined, into the target class.
+
+	@example
+	```
+	import Emittery = require('emittery');
+
+	@Emittery.mixin('emittery')
+	class MyClass {}
+
+	const instance = new MyClass();
+
+	instance.emit('event');
+	```
+	*/
+	static mixin(emitteryPropertyName: string, methodNames?: readonly string[]): Function;
+
+	/**
+	Fires when an event listener was added.
+
+	An object with `listener` and `eventName` (if `on` or `off` was used) is provided as event data.
+
+	@example
+	```
+	import Emittery = require('emittery');
+
+	const emitter = new Emittery();
+
+	emitter.on(Emittery.listenerAdded, ({listener, eventName}) => {
+		console.log(listener);
+		//=> data => {}
+
+		console.log(eventName);
+		//=> '🦄'
+	});
+
+	emitter.on('🦄', data => {
+		// Handle data
+	});
+	```
+	*/
+	static readonly listenerAdded: unique symbol;
+
+	/**
+	Fires when an event listener was removed.
+
+	An object with `listener` and `eventName` (if `on` or `off` was used) is provided as event data.
+
+	@example
+	```
+	import Emittery = require('emittery');
+
+	const emitter = new Emittery();
+
+	const off = emitter.on('🦄', data => {
+		// Handle data
+	});
+
+	emitter.on(Emittery.listenerRemoved, ({listener, eventName}) => {
+		console.log(listener);
+		//=> data => {}
+
+		console.log(eventName);
+		//=> '🦄'
+	});
+
+	off();
+	```
+	*/
+	static readonly listenerRemoved: unique symbol;
+
+	/**
+	Subscribe to an event.
+
+	Using the same listener multiple times for the same event will result in only one method call per emitted event.
+
+	@returns An unsubscribe method.
+	*/
+	on(eventName: typeof Emittery.listenerAdded | typeof Emittery.listenerRemoved, listener: (eventData: Emittery.ListenerChangedData) => void): Emittery.UnsubscribeFn
+	on(eventName: EventName, listener: (eventData?: unknown) => void): Emittery.UnsubscribeFn;
+
+	/**
+	Get an async iterator which buffers data each time an event is emitted.
+
+	Call `return()` on the iterator to remove the subscription.
+
+	@example
+	```
+	import Emittery = require('emittery');
+
+	const emitter = new Emittery();
+	const iterator = emitter.events('🦄');
+
+	emitter.emit('🦄', '🌈1'); // Buffered
+	emitter.emit('🦄', '🌈2'); // Buffered
+
+	iterator
+		.next()
+		.then(({value, done}) => {
+			// done === false
+			// value === '🌈1'
+			return iterator.next();
+		})
+		.then(({value, done}) => {
+			// done === false
+			// value === '🌈2'
+			// Revoke subscription
+			return iterator.return();
+		})
+		.then(({done}) => {
+			// done === true
+		});
+	```
+
+	In practice you would usually consume the events using the [for await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of) statement. In that case, to revoke the subscription simply break the loop.
+
+	@example
+	```
+	import Emittery = require('emittery');
+
+	const emitter = new Emittery();
+	const iterator = emitter.events('🦄');
+
+	emitter.emit('🦄', '🌈1'); // Buffered
+	emitter.emit('🦄', '🌈2'); // Buffered
+
+	// In an async context.
+	for await (const data of iterator) {
+		if (data === '🌈2') {
+			break; // Revoke the subscription when we see the value `🌈2`.
+		}
+	}
+	```
+	*/
+	events(eventName: EventName): AsyncIterableIterator<unknown>
+
+	/**
+	Remove an event subscription.
+	*/
+	off(eventName: EventName, listener: (eventData?: unknown) => void): void;
+
+	/**
+	Subscribe to an event only once. It will be unsubscribed after the first
+	event.
+
+	@returns The event data when `eventName` is emitted.
+	*/
+	once(eventName: typeof Emittery.listenerAdded | typeof Emittery.listenerRemoved): Promise<Emittery.ListenerChangedData>
+	once(eventName: EventName): Promise<unknown>;
+
+	/**
+	Trigger an event asynchronously, optionally with some data. Listeners are called in the order they were added, but executed concurrently.
+
+	@returns A promise that resolves when all the event listeners are done. *Done* meaning executed if synchronous or resolved when an async/promise-returning function. You usually wouldn't want to wait for this, but you could for example catch possible errors. If any of the listeners throw/reject, the returned promise will be rejected with the error, but the other listeners will not be affected.
+	*/
+	emit(eventName: EventName, eventData?: unknown): Promise<void>;
+
+	/**
+	Same as `emit()`, but it waits for each listener to resolve before triggering the next one. This can be useful if your events depend on each other. Although ideally they should not. Prefer `emit()` whenever possible.
+
+	If any of the listeners throw/reject, the returned promise will be rejected with the error and the remaining listeners will *not* be called.
+
+	@returns A promise that resolves when all the event listeners are done.
+	*/
+	emitSerial(eventName: EventName, eventData?: unknown): Promise<void>;
+
+	/**
+	Subscribe to be notified about any event.
+
+	@returns A method to unsubscribe.
+	*/
+	onAny(listener: (eventName: EventName, eventData?: unknown) => unknown): Emittery.UnsubscribeFn;
+
+	/**
+	Get an async iterator which buffers a tuple of an event name and data each time an event is emitted.
+
+	Call `return()` on the iterator to remove the subscription.
+
+	In the same way as for `events`, you can subscribe by using the `for await` statement.
+
+	@example
+	```
+	import Emittery = require('emittery');
+
+	const emitter = new Emittery();
+	const iterator = emitter.anyEvent();
+
+	emitter.emit('🦄', '🌈1'); // Buffered
+	emitter.emit('🌟', '🌈2'); // Buffered
+
+	iterator.next()
+		.then(({value, done}) => {
+			// done is false
+			// value is ['🦄', '🌈1']
+			return iterator.next();
+		})
+		.then(({value, done}) => {
+			// done is false
+			// value is ['🌟', '🌈2']
+			// revoke subscription
+			return iterator.return();
+		})
+		.then(({done}) => {
+			// done is true
+		});
+	```
+	*/
+	anyEvent(): AsyncIterableIterator<unknown>
+
+	/**
+	Remove an `onAny` subscription.
+	*/
+	offAny(listener: (eventName: EventName, eventData?: unknown) => void): void;
+
+	/**
+	Clear all event listeners on the instance.
+
+	If `eventName` is given, only the listeners for that event are cleared.
+	*/
+	clearListeners(eventName?: EventName): void;
+
+	/**
+	The number of listeners for the `eventName` or all events if not specified.
+	*/
+	listenerCount(eventName?: EventName): number;
+
+	/**
+	Bind the given `methodNames`, or all `Emittery` methods if `methodNames` is not defined, into the `target` object.
+
+	@example
+	```
+	import Emittery = require('emittery');
+
+	const object = {};
+
+	new Emittery().bindMethods(object);
+
+	object.emit('event');
+	```
+	*/
+	bindMethods(target: object, methodNames?: readonly string[]): void;
+}
+
+declare namespace Emittery {
+	/**
+	Removes an event subscription.
+	*/
+	type UnsubscribeFn = () => void;
+	type EventNameFromDataMap<EventDataMap> = Extract<keyof EventDataMap, EventName>;
+
+	/**
+	Maps event names to their emitted data type.
+	*/
+	interface Events {
+		// Blocked by https://github.com/microsoft/TypeScript/issues/1863, should be
+		// `[eventName: EventName]: unknown;`
+	}
+
+	/**
+	The data provided as `eventData` when listening for `Emittery.listenerAdded` or `Emittery.listenerRemoved`.
+	*/
+	interface ListenerChangedData {
+		/**
+		The listener that was added or removed.
+		*/
+		listener: (eventData?: unknown) => void;
+
+		/**
+		The name of the event that was added or removed if `.on()` or `.off()` was used, or `undefined` if `.onAny()` or `.offAny()` was used.
+		*/
+		eventName?: EventName;
+	}
+
+	/**
+	Async event emitter.
+
+	You must list supported events and the data type they emit, if any.
+
+	@example
+	```
+	import Emittery = require('emittery');
+
+	const emitter = new Emittery.Typed<{value: string}, 'open' | 'close'>();
+
+	emitter.emit('open');
+	emitter.emit('value', 'foo\n');
+	emitter.emit('value', 1); // TS compilation error
+	emitter.emit('end'); // TS compilation error
+	```
+	*/
+	class Typed<EventDataMap extends Events, EmptyEvents extends EventName = never> extends Emittery {
+		on<Name extends EventNameFromDataMap<EventDataMap>>(eventName: Name, listener: (eventData: EventDataMap[Name]) => void): Emittery.UnsubscribeFn;
+		on<Name extends EmptyEvents>(eventName: Name, listener: () => void): Emittery.UnsubscribeFn;
+
+		events<Name extends EventNameFromDataMap<EventDataMap>>(eventName: Name): AsyncIterableIterator<EventDataMap[Name]>;
+
+		once<Name extends EventNameFromDataMap<EventDataMap>>(eventName: Name): Promise<EventDataMap[Name]>;
+		once<Name extends EmptyEvents>(eventName: Name): Promise<void>;
+
+		off<Name extends EventNameFromDataMap<EventDataMap>>(eventName: Name, listener: (eventData: EventDataMap[Name]) => void): void;
+		off<Name extends EmptyEvents>(eventName: Name, listener: () => void): void;
+
+		onAny(listener: (eventName: EventNameFromDataMap<EventDataMap> | EmptyEvents, eventData?: EventDataMap[EventNameFromDataMap<EventDataMap>]) => void): Emittery.UnsubscribeFn;
+		anyEvent(): AsyncIterableIterator<[EventNameFromDataMap<EventDataMap>, EventDataMap[EventNameFromDataMap<EventDataMap>]]>;
+
+		offAny(listener: (eventName: EventNameFromDataMap<EventDataMap> | EmptyEvents, eventData?: EventDataMap[EventNameFromDataMap<EventDataMap>]) => void): void;
+
+		emit<Name extends EventNameFromDataMap<EventDataMap>>(eventName: Name, eventData: EventDataMap[Name]): Promise<void>;
+		emit<Name extends EmptyEvents>(eventName: Name): Promise<void>;
+
+		emitSerial<Name extends EventNameFromDataMap<EventDataMap>>(eventName: Name, eventData: EventDataMap[Name]): Promise<void>;
+		emitSerial<Name extends EmptyEvents>(eventName: Name): Promise<void>;
+	}
+}
+
+export = Emittery;

package/index.js

@@ -2,11 +2,16 @@
 
 const anyMap = new WeakMap();
 const eventsMap = new WeakMap();
+const producersMap = new WeakMap();
+const anyProducer = Symbol('anyProducer');
 const resolvedPromise = Promise.resolve();
 
+const listenerAdded = Symbol('listenerAdded');
+const listenerRemoved = Symbol('listenerRemoved');
+
 function assertEventName(eventName) {
-	if (typeof eventName !== 'string') {
-		throw new TypeError('eventName must be a string');
+	if (typeof eventName !== 'string' && typeof eventName !== 'symbol') {
+		throw new TypeError('eventName must be a string or a symbol');
 	}
 }
 
@@ -25,22 +30,183 @@ function getListeners(instance, eventName) {
 	return events.get(eventName);
 }
 
+function getEventProducers(instance, eventName) {
+	const key = typeof eventName === 'string' ? eventName : anyProducer;
+	const producers = producersMap.get(instance);
+	if (!producers.has(key)) {
+		producers.set(key, new Set());
+	}
+
+	return producers.get(key);
+}
+
+function enqueueProducers(instance, eventName, eventData) {
+	const producers = producersMap.get(instance);
+	if (producers.has(eventName)) {
+		for (const producer of producers.get(eventName)) {
+			producer.enqueue(eventData);
+		}
+	}
+
+	if (producers.has(anyProducer)) {
+		const item = Promise.all([eventName, eventData]);
+		for (const producer of producers.get(anyProducer)) {
+			producer.enqueue(item);
+		}
+	}
+}
+
+function iterator(instance, eventName) {
+	let isFinished = false;
+	let flush = () => {};
+	let queue = [];
+
+	const producer = {
+		enqueue(item) {
+			queue.push(item);
+			flush();
+		},
+		finish() {
+			isFinished = true;
+			flush();
+		}
+	};
+
+	getEventProducers(instance, eventName).add(producer);
+
+	return {
+		async next() {
+			if (!queue) {
+				return {done: true};
+			}
+
+			if (queue.length === 0) {
+				if (isFinished) {
+					queue = undefined;
+					return this.next();
+				}
+
+				await new Promise(resolve => {
+					flush = resolve;
+				});
+
+				return this.next();
+			}
+
+			return {
+				done: false,
+				value: await queue.shift()
+			};
+		},
+
+		async return(value) {
+			queue = undefined;
+			getEventProducers(instance, eventName).delete(producer);
+			flush();
+
+			return arguments.length > 0 ?
+				{done: true, value: await value} :
+				{done: true};
+		},
+
+		[Symbol.asyncIterator]() {
+			return this;
+		}
+	};
+}
+
+function defaultMethodNamesOrAssert(methodNames) {
+	if (methodNames === undefined) {
+		return allEmitteryMethods;
+	}
+
+	if (!Array.isArray(methodNames)) {
+		throw new TypeError('`methodNames` must be an array of strings');
+	}
+
+	for (const methodName of methodNames) {
+		if (!allEmitteryMethods.includes(methodName)) {
+			if (typeof methodName !== 'string') {
+				throw new TypeError('`methodNames` element must be a string');
+			}
+
+			throw new Error(`${methodName} is not Emittery method`);
+		}
+	}
+
+	return methodNames;
+}
+
+const isListenerSymbol = symbol => symbol === listenerAdded || symbol === listenerRemoved;
+
 class Emittery {
+	static mixin(emitteryPropertyName, methodNames) {
+		methodNames = defaultMethodNamesOrAssert(methodNames);
+		return target => {
+			if (typeof target !== 'function') {
+				throw new TypeError('`target` must be function');
+			}
+
+			for (const methodName of methodNames) {
+				if (target.prototype[methodName] !== undefined) {
+					throw new Error(`The property \`${methodName}\` already exists on \`target\``);
+				}
+			}
+
+			function getEmitteryProperty() {
+				Object.defineProperty(this, emitteryPropertyName, {
+					enumerable: false,
+					value: new Emittery()
+				});
+				return this[emitteryPropertyName];
+			}
+
+			Object.defineProperty(target.prototype, emitteryPropertyName, {
+				enumerable: false,
+				get: getEmitteryProperty
+			});
+
+			const emitteryMethodCaller = methodName => function (...args) {
+				return this[emitteryPropertyName][methodName](...args);
+			};
+
+			for (const methodName of methodNames) {
+				Object.defineProperty(target.prototype, methodName, {
+					enumerable: false,
+					value: emitteryMethodCaller(methodName)
+				});
+			}
+
+			return target;
+		};
+	}
+
 	constructor() {
 		anyMap.set(this, new Set());
 		eventsMap.set(this, new Map());
+		producersMap.set(this, new Map());
 	}
 
 	on(eventName, listener) {
 		assertEventName(eventName);
 		assertListener(listener);
 		getListeners(this, eventName).add(listener);
+
+		if (!isListenerSymbol(eventName)) {
+			this.emit(listenerAdded, {eventName, listener});
+		}
+
 		return this.off.bind(this, eventName, listener);
 	}
 
 	off(eventName, listener) {
 		assertEventName(eventName);
 		assertListener(listener);
+
+		if (!isListenerSymbol(eventName)) {
+			this.emit(listenerRemoved, {eventName, listener});
+		}
+
 		getListeners(this, eventName).delete(listener);
 	}
 
@@ -54,13 +220,20 @@ class Emittery {
 		});
 	}
 
+	events(eventName) {
+		assertEventName(eventName);
+		return iterator(this, eventName);
+	}
+
 	async emit(eventName, eventData) {
 		assertEventName(eventName);
 
+		enqueueProducers(this, eventName, eventData);
+
 		const listeners = getListeners(this, eventName);
 		const anyListeners = anyMap.get(this);
 		const staticListeners = [...listeners];
-		const staticAnyListeners = [...anyListeners];
+		const staticAnyListeners = isListenerSymbol(eventName) ? [] : [...anyListeners];
 
 		await resolvedPromise;
 		return Promise.all([
@@ -104,28 +277,52 @@ class Emittery {
 	onAny(listener) {
 		assertListener(listener);
 		anyMap.get(this).add(listener);
+		this.emit(listenerAdded, {listener});
 		return this.offAny.bind(this, listener);
 	}
 
+	anyEvent() {
+		return iterator(this);
+	}
+
 	offAny(listener) {
 		assertListener(listener);
+		this.emit(listenerRemoved, {listener});
 		anyMap.get(this).delete(listener);
 	}
 
 	clearListeners(eventName) {
 		if (typeof eventName === 'string') {
 			getListeners(this, eventName).clear();
+
+			const producers = getEventProducers(this, eventName);
+
+			for (const producer of producers) {
+				producer.finish();
+			}
+
+			producers.clear();
 		} else {
 			anyMap.get(this).clear();
+
 			for (const listeners of eventsMap.get(this).values()) {
 				listeners.clear();
 			}
+
+			for (const producers of producersMap.get(this).values()) {
+				for (const producer of producers) {
+					producer.finish();
+				}
+
+				producers.clear();
+			}
 		}
 	}
 
 	listenerCount(eventName) {
 		if (typeof eventName === 'string') {
-			return anyMap.get(this).size + getListeners(this, eventName).size;
+			return anyMap.get(this).size + getListeners(this, eventName).size +
+				getEventProducers(this, eventName).size + getEventProducers(this).size;
 		}
 
 		if (typeof eventName !== 'undefined') {
@@ -138,10 +335,35 @@ class Emittery {
 			count += value.size;
 		}
 
+		for (const value of producersMap.get(this).values()) {
+			count += value.size;
+		}
+
 		return count;
 	}
+
+	bindMethods(target, methodNames) {
+		if (typeof target !== 'object' || target === null) {
+			throw new TypeError('`target` must be an object');
+		}
+
+		methodNames = defaultMethodNamesOrAssert(methodNames);
+
+		for (const methodName of methodNames) {
+			if (target[methodName] !== undefined) {
+				throw new Error(`The property \`${methodName}\` already exists on \`target\``);
+			}
+
+			Object.defineProperty(target, methodName, {
+				enumerable: false,
+				value: this[methodName].bind(this)
+			});
+		}
+	}
 }
 
+const allEmitteryMethods = Object.getOwnPropertyNames(Emittery.prototype).filter(v => v !== 'constructor');
+
 // Subclass used to encourage TS users to type their events.
 Emittery.Typed = class extends Emittery {};
 Object.defineProperty(Emittery.Typed, 'Typed', {
@@ -149,4 +371,17 @@ Object.defineProperty(Emittery.Typed, 'Typed', {
 	value: undefined
 });
 
+Object.defineProperty(Emittery, 'listenerAdded', {
+	value: listenerAdded,
+	writable: false,
+	enumerable: true,
+	configurable: false
+});
+Object.defineProperty(Emittery, 'listenerRemoved', {
+	value: listenerRemoved,
+	writable: false,
+	enumerable: true,
+	configurable: false
+});
+
 module.exports = Emittery;

package/license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/package.json

@@ -1,30 +1,25 @@
 {
 	"name": "emittery",
-	"version": "0.4.0",
+	"version": "0.6.0",
 	"description": "Simple and modern async event emitter",
 	"license": "MIT",
 	"repository": "sindresorhus/emittery",
+	"funding": "https://github.com/sindresorhus/emittery?sponsor=1",
 	"author": {
 		"name": "Sindre Sorhus",
 		"email": "sindresorhus@gmail.com",
-		"url": "sindresorhus.com"
+		"url": "https://sindresorhus.com"
 	},
 	"engines": {
-		"node": ">=6"
+		"node": ">=10"
 	},
 	"scripts": {
-		"build": "babel --out-file=legacy.js index.js",
-		"build:watch": "npm run build -- --watch",
-		"prepare": "npm run build",
-		"test": "xo && tsc --noEmit && nyc ava"
+		"test": "xo && nyc ava && tsd"
 	},
 	"files": [
-		"Emittery.d.ts",
 		"index.js",
-		"legacy.js",
-		"legacy.d.ts"
+		"index.d.ts"
 	],
-	"typings": "./Emittery.d.ts",
 	"keywords": [
 		"event",
 		"emitter",
@@ -47,26 +42,20 @@
 		"observer",
 		"trigger",
 		"await",
-		"promise"
+		"promise",
+		"typescript",
+		"ts",
+		"typed"
 	],
 	"devDependencies": {
-		"@types/node": "^10.1.2",
-		"ava": "*",
-		"babel-cli": "^6.26.0",
-		"babel-core": "^6.26.0",
-		"babel-plugin-transform-async-to-generator": "^6.24.1",
-		"codecov": "^3.0.0",
-		"delay": "^3.0.0",
-		"glob": "^7.1.2",
-		"nyc": "^12.0.2",
-		"ts-node": "^6.0.3",
-		"typescript": "^2.9.0",
-		"xo": "*"
-	},
-	"babel": {
-		"plugins": [
-			"transform-async-to-generator"
-		]
+		"@types/node": "^13.7.5",
+		"ava": "^2.4.0",
+		"codecov": "^3.1.0",
+		"delay": "^4.3.0",
+		"nyc": "^15.0.0",
+		"p-event": "^4.1.0",
+		"tsd": "^0.11.0",
+		"xo": "^0.25.4"
 	},
 	"nyc": {
 		"reporter": [

package/readme.md

@@ -2,14 +2,11 @@
 
 > Simple and modern async event emitter
 
-[![Build Status](https://travis-ci.org/sindresorhus/emittery.svg?branch=master)](https://travis-ci.org/sindresorhus/emittery) [![codecov](https://codecov.io/gh/sindresorhus/emittery/branch/master/graph/badge.svg)](https://codecov.io/gh/sindresorhus/emittery)
+[![Build Status](https://travis-ci.org/sindresorhus/emittery.svg?branch=master)](https://travis-ci.org/sindresorhus/emittery) [![codecov](https://codecov.io/gh/sindresorhus/emittery/branch/master/graph/badge.svg)](https://codecov.io/gh/sindresorhus/emittery) [![](https://badgen.net/bundlephobia/minzip/emittery)](https://bundlephobia.com/result?p=emittery)
 
-It's only ~200 bytes minified and gzipped. [I'm not fanatic about keeping the size at this level though.](https://github.com/sindresorhus/emittery/pull/5#issuecomment-347479211)
-
-It's works in Node.js and the browser (using a bundler).
-
-Emitting events asynchronously is important for production code where you want the least amount of synchronous operations.
+It works in Node.js and the browser (using a bundler).
 
+Emitting events asynchronously is important for production code where you want the least amount of synchronous operations. Since JavaScript is single-threaded, no other code can run while doing synchronous operations. For Node.js, that means it will block other requests, defeating the strength of the platform, which is scalability through async. In the browser, a synchronous operation could potentially cause lags and block user interaction.
 
 ## Install
 
@@ -17,27 +14,34 @@ Emitting events asynchronously is important for production code where you want t
 $ npm install emittery
 ```
 
-
 ## Usage
 
 ```js
 const Emittery = require('emittery');
+
 const emitter = new Emittery();
 
 emitter.on('🦄', data => {
 	console.log(data);
-	// '🌈'
 });
 
-emitter.emit('🦄', '🌈');
+const myUnicorn = Symbol('🦄');
+
+emitter.on(myUnicorn, data => {
+	console.log(`Unicorns love ${data}`);
+});
+
+emitter.emit('🦄', '🌈'); // Will trigger printing '🌈'
+emitter.emit(myUnicorn, '🦋');  // Will trigger printing 'Unicorns love 🦋'
 ```
 
-### Node.js 6
+## API
 
-The above only works in Node.js 8 or newer. For older Node.js versions you can use `require('emittery/legacy')`.
+### eventName
 
+Emittery accepts strings and symbols as event names.
 
-## API
+Symbol event names can be used to avoid name collisions when your classes are extended, especially for internal events.
 
 ### emitter = new Emittery()
 
@@ -49,6 +53,38 @@ Returns an unsubscribe method.
 
 Using the same listener multiple times for the same event will result in only one method call per emitted event.
 
+##### Custom subscribable events
+
+Emittery exports some symbols which represent custom events that can be passed to `Emitter.on` and similar methods.
+
+- `Emittery.listenerAdded` - Fires when an event listener was added.
+- `Emittery.listenerRemoved` - Fires when an event listener was removed.
+
+```js
+const Emittery = require('emittery');
+
+const emitter = new Emittery();
+
+emitter.on(Emittery.listenerAdded, ({listener, eventName}) => {
+	console.log(listener);
+	//=> data => {}
+
+	console.log(eventName);
+	//=> '🦄'
+});
+
+emitter.on('🦄', data => {
+	// Handle data
+});
+```
+
+###### Listener data
+
+- `listener` - The listener that was added.
+- `eventName` - The name of the event that was added or removed if `.on()` or `.off()` was used, or `undefined` if `.onAny()` or `.offAny()` was used.
+
+Only events that are not of this type are able to trigger these events.
+
 ##### listener(data)
 
 #### off(eventName, listener)
@@ -64,6 +100,10 @@ Subscribe to an event only once. It will be unsubscribed after the first event.
 Returns a promise for the event data when `eventName` is emitted.
 
 ```js
+const Emittery = require('emittery');
+
+const emitter = new Emittery();
+
 emitter.once('🦄').then(data => {
 	console.log(data);
 	//=> '🌈'
@@ -72,13 +112,65 @@ emitter.once('🦄').then(data => {
 emitter.emit('🦄', '🌈');
 ```
 
-#### emit(eventName, [data])
+#### events(eventName)
 
-Trigger an event asynchronously, optionally with some data. Listeners are called in the order they were added, but execute concurrently.
+Get an async iterator which buffers data each time an event is emitted.
 
-Returns a promise for when all the event listeners are done. *Done* meaning executed if synchronous or resolved when an async/promise-returning function. You usually wouldn't want to wait for this, but you could for example catch possible errors. If any of the listeners throw/reject, the returned promise will be rejected with the error, but the other listeners will not be affected.
+Call `return()` on the iterator to remove the subscription.
 
-#### emitSerial(eventName, [data])
+```js
+const Emittery = require('emittery');
+
+const emitter = new Emittery();
+const iterator = emitter.events('🦄');
+
+emitter.emit('🦄', '🌈1'); // Buffered
+emitter.emit('🦄', '🌈2'); // Buffered
+
+iterator
+	.next()
+	.then(({value, done}) => {
+		// done === false
+		// value === '🌈1'
+		return iterator.next();
+	})
+	.then(({value, done}) => {
+		// done === false
+		// value === '🌈2'
+		// Revoke subscription
+		return iterator.return();
+	})
+	.then(({done}) => {
+		// done === true
+	});
+```
+
+In practice, you would usually consume the events using the [for await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of) statement. In that case, to revoke the subscription simply break the loop.
+
+```js
+const Emittery = require('emittery');
+
+const emitter = new Emittery();
+const iterator = emitter.events('🦄');
+
+emitter.emit('🦄', '🌈1'); // Buffered
+emitter.emit('🦄', '🌈2'); // Buffered
+
+// In an async context.
+for await (const data of iterator) {
+	if (data === '🌈2') {
+		break; // Revoke the subscription when we see the value '🌈2'.
+	}
+}
+```
+
+#### emit(eventName, data?)
+
+Trigger an event asynchronously, optionally with some data. Listeners are called in the order they were added, but executed concurrently.
+
+Returns a promise that resolves when all the event listeners are done. *Done* meaning executed if synchronous or resolved when an async/promise-returning function. You usually wouldn't want to wait for this, but you could for example catch possible errors. If any of the listeners throw/reject, the returned promise will be rejected with the error, but the other listeners will not be affected.
+
+#### emitSerial(eventName, data?)
 
 Same as above, but it waits for each listener to resolve before triggering the next one. This can be useful if your events depend on each other. Although ideally they should not. Prefer `emit()` whenever possible.
 
@@ -96,33 +188,93 @@ Returns a method to unsubscribe.
 
 Remove an `onAny` subscription.
 
+#### anyEvent()
+
+Get an async iterator which buffers a tuple of an event name and data each time an event is emitted.
+
+Call `return()` on the iterator to remove the subscription.
+
+```js
+const Emittery = require('emittery');
+
+const emitter = new Emittery();
+const iterator = emitter.anyEvent();
+
+emitter.emit('🦄', '🌈1'); // Buffered
+emitter.emit('🌟', '🌈2'); // Buffered
+
+iterator.next()
+	.then(({value, done}) => {
+		// done === false
+		// value is ['🦄', '🌈1']
+		return iterator.next();
+	})
+	.then(({value, done}) => {
+		// done === false
+		// value is ['🌟', '🌈2']
+		// Revoke subscription
+		return iterator.return();
+	})
+	.then(({done}) => {
+		// done === true
+	});
+```
+
+In the same way as for `events`, you can subscribe by using the `for await` statement
+
 #### clearListeners()
 
 Clear all event listeners on the instance.
 
 If `eventName` is given, only the listeners for that event are cleared.
 
-#### listenerCount([eventName])
+#### listenerCount(eventName?)
 
 The number of listeners for the `eventName` or all events if not specified.
 
-## TypeScript
+#### bindMethods(target, methodNames?)
 
-Definition for `emittery` and `emittery/legacy` are included. Use `import Emittery = require('emittery')` or `import Emittery = require('emittery/legacy')` to load the desired implementation.
+Bind the given `methodNames`, or all `Emittery` methods if `methodNames` is not defined, into the `target` object.
 
-The default `Emittery` class does not let you type allowed event names and their associated data. However you can use `Emittery.Typed` with generics:
+```js
+import Emittery = require('emittery');
+
+const object = {};
+
+new Emittery().bindMethods(object);
+
+object.emit('event');
+```
+
+## TypeScript
+
+The default `Emittery` class does not let you type allowed event names and their associated data. However, you can use `Emittery.Typed` with generics:
 
 ```ts
 import Emittery = require('emittery');
 
-const ee = new Emittery.Typed<{value: string}, 'open' | 'close'>();
+const emitter = new Emittery.Typed<{value: string}, 'open' | 'close'>();
 
-ee.emit('open');
-ee.emit('value', 'foo\n');
-ee.emit('value', 1); // TS compilation error
-ee.emit('end'); // TS compilation error
+emitter.emit('open');
+emitter.emit('value', 'foo\n');
+emitter.emit('value', 1); // TS compilation error
+emitter.emit('end'); // TS compilation error
 ```
 
+### Emittery.mixin(emitteryPropertyName, methodNames?)
+
+A decorator which mixins `Emittery` as property `emitteryPropertyName` and `methodNames`, or all `Emittery` methods if `methodNames` is not defined, into the target class.
+
+```ts
+import Emittery = require('emittery');
+
+@Emittery.mixin('emittery')
+class MyClass {}
+
+const instance = new MyClass();
+
+instance.emit('event');
+```
 
 ## Scheduling details
 
@@ -130,7 +282,6 @@ Listeners are not invoked for events emitted *before* the listener was added. Re
 
 Note that when using `.emitSerial()`, a slow listener will delay invocation of subsequent listeners. It's possible for newer events to overtake older ones.
 
-
 ## FAQ
 
 ### How is this different than the built-in `EventEmitter` in Node.js?
@@ -170,12 +321,6 @@ emitter.on('🦄', ([foo, bar]) => {
 emitter.emit('🦄', [foo, bar]);
 ```
 
-
 ## Related
 
 - [p-event](https://github.com/sindresorhus/p-event) - Promisify an event by waiting for it to be emitted
-
-
-## License
-
-MIT © [Sindre Sorhus](https://sindresorhus.com)

package/Emittery.d.ts

@@ -1,131 +0,0 @@
-export = Emittery;
-
-declare class Emittery {
-	/**
-	 * Subscribe to an event.
-	 *
-	 * Returns an unsubscribe method.
-	 *
-	 * Using the same listener multiple times for the same event will result
-	 * in only one method call per emitted event.
-	 */
-	on(eventName: string, listener: (eventData?: any) => any): Emittery.UnsubscribeFn;
-
-	/**
-	 * Remove an event subscription.
-	 */
-	off(eventName: string, listener: (eventData?: any) => any): void;
-
-	/**
-	 * Subscribe to an event only once. It will be unsubscribed after the first
-	 * event.
-	 *
-	 * Returns a promise for the event data when `eventName` is emitted.
-	 */
-	once(eventName: string): Promise<any>;
-
-	/**
-	 * Trigger an event asynchronously, optionally with some data. Listeners
-	 * are called in the order they were added, but execute concurrently.
-	 *
-	 * Returns a promise for when all the event listeners are done. *Done*
-	 * meaning executed if synchronous or resolved when an
-	 * async/promise-returning function. You usually wouldn't want to wait for
-	 * this, but you could for example catch possible errors. If any of the
-	 * listeners throw/reject, the returned promise will be rejected with the
-	 * error, but the other listeners will not be affected.
-	 *
-	 * Returns a promise for when all the event listeners are done.
-	 */
-	emit(eventName: string, eventData?: any): Promise<void>;
-
-	/**
-	 * Same as `emit()`, but it waits for each listener to resolve before
-	 * triggering the next one. This can be useful if your events depend on each
-	 * other. Although ideally they should not. Prefer `emit()` whenever
-	 * possible.
-	 *
-	 * If any of the listeners throw/reject, the returned promise will be
-	 * rejected with the error and the remaining listeners will *not* be called.
-	 *
-	 * Returns a promise for when all the event listeners are done.
-	 */
-	emitSerial(eventName: string, eventData?: any): Promise<void>;
-
-	/**
-	 * Subscribe to be notified about any event.
-	 *
-	 * Returns a method to unsubscribe.
-	 */
-	onAny(listener: (eventName: string, eventData?: any) => any): Emittery.UnsubscribeFn;
-
-	/**
-	 * Remove an `onAny` subscription.
-	 */
-	offAny(listener: (eventName: string, eventData?: any) => any): void;
-
-	/**
-	 * Clear all event listeners on the instance.
-	 *
-	 * If `eventName` is given, only the listeners for that event are cleared.
-	 */
-	clearListeners(eventName?: string): void;
-
-	/**
-	 * The number of listeners for the `eventName` or all events if not
-	 * specified.
-	 */
-	listenerCount(eventName?: string): number;
-}
-
-declare namespace Emittery {
-	/**
-	 * Removes an event subscription.
-	 */
-	type UnsubscribeFn = () => void;
-
-	/**
-	 * Maps event names to their emitted data type.
-	 */
-	interface Events {
-		[eventName: string]: any;
-	}
-
-	/**
-	 * Async event emitter.
-	 *
-	 * Must list supported events and the data type they emit, if any.
-	 *
-	 * For example:
-	 *
-	 * ```ts
-	 * import Emittery = require('emittery');
-	 *
-	 * const ee = new Emittery.Typed<{value: string}, 'open' | 'close'>();
-	 *
-	 * ee.emit('open');
-	 * ee.emit('value', 'foo\n');
-	 * ee.emit('value', 1); // TS compilation error
-	 * ee.emit('end'); // TS compilation error
-	 * ```
-	 */
-	class Typed<EventDataMap extends Events, EmptyEvents extends string = never> extends Emittery {
-		on<Name extends Extract<keyof EventDataMap, string>>(eventName: Name, listener: (eventData: EventDataMap[Name]) => any): Emittery.UnsubscribeFn;
-		on<Name extends EmptyEvents>(eventName: Name, listener: () => any): Emittery.UnsubscribeFn;
-
-		once<Name extends Extract<keyof EventDataMap, string>>(eventName: Name): Promise<EventDataMap[Name]>;
-		once<Name extends EmptyEvents>(eventName: Name): Promise<void>;
-
-		off<Name extends Extract<keyof EventDataMap, string>>(eventName: Name, listener: (eventData: EventDataMap[Name]) => any): void;
-		off<Name extends EmptyEvents>(eventName: Name, listener: () => any): void;
-
-		onAny(listener: (eventName: Extract<keyof EventDataMap, string> | EmptyEvents, eventData?: EventDataMap[Extract<keyof EventDataMap, string>]) => any): Emittery.UnsubscribeFn;
-		offAny(listener: (eventName: Extract<keyof EventDataMap, string> | EmptyEvents, eventData?: EventDataMap[Extract<keyof EventDataMap, string>]) => any): void;
-
-		emit<Name extends Extract<keyof EventDataMap, string>>(eventName: Name, eventData: EventDataMap[Name]): Promise<void>;
-		emit<Name extends EmptyEvents>(eventName: Name): Promise<void>;
-
-		emitSerial<Name extends Extract<keyof EventDataMap, string>>(eventName: Name, eventData: EventDataMap[Name]): Promise<void>;
-		emitSerial<Name extends EmptyEvents>(eventName: Name): Promise<void>;
-	}
-}

package/legacy.d.ts

@@ -1,2 +0,0 @@
-import Emittery = require('./Emittery')
-export = Emittery

package/legacy.js

@@ -1,171 +0,0 @@
-'use strict';
-
-function _asyncToGenerator(fn) { return function () { var gen = fn.apply(this, arguments); return new Promise(function (resolve, reject) { function step(key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { return Promise.resolve(value).then(function (value) { step("next", value); }, function (err) { step("throw", err); }); } } return step("next"); }); }; }
-
-const anyMap = new WeakMap();
-const eventsMap = new WeakMap();
-const resolvedPromise = Promise.resolve();
-
-function assertEventName(eventName) {
-	if (typeof eventName !== 'string') {
-		throw new TypeError('eventName must be a string');
-	}
-}
-
-function assertListener(listener) {
-	if (typeof listener !== 'function') {
-		throw new TypeError('listener must be a function');
-	}
-}
-
-function getListeners(instance, eventName) {
-	const events = eventsMap.get(instance);
-	if (!events.has(eventName)) {
-		events.set(eventName, new Set());
-	}
-
-	return events.get(eventName);
-}
-
-class Emittery {
-	constructor() {
-		anyMap.set(this, new Set());
-		eventsMap.set(this, new Map());
-	}
-
-	on(eventName, listener) {
-		assertEventName(eventName);
-		assertListener(listener);
-		getListeners(this, eventName).add(listener);
-		return this.off.bind(this, eventName, listener);
-	}
-
-	off(eventName, listener) {
-		assertEventName(eventName);
-		assertListener(listener);
-		getListeners(this, eventName).delete(listener);
-	}
-
-	once(eventName) {
-		return new Promise(resolve => {
-			assertEventName(eventName);
-			const off = this.on(eventName, data => {
-				off();
-				resolve(data);
-			});
-		});
-	}
-
-	emit(eventName, eventData) {
-		var _this = this;
-
-		return _asyncToGenerator(function* () {
-			assertEventName(eventName);
-
-			const listeners = getListeners(_this, eventName);
-			const anyListeners = anyMap.get(_this);
-			const staticListeners = [...listeners];
-			const staticAnyListeners = [...anyListeners];
-
-			yield resolvedPromise;
-			return Promise.all([...staticListeners.map((() => {
-				var _ref = _asyncToGenerator(function* (listener) {
-					if (listeners.has(listener)) {
-						return listener(eventData);
-					}
-				});
-
-				return function (_x) {
-					return _ref.apply(this, arguments);
-				};
-			})()), ...staticAnyListeners.map((() => {
-				var _ref2 = _asyncToGenerator(function* (listener) {
-					if (anyListeners.has(listener)) {
-						return listener(eventName, eventData);
-					}
-				});
-
-				return function (_x2) {
-					return _ref2.apply(this, arguments);
-				};
-			})())]);
-		})();
-	}
-
-	emitSerial(eventName, eventData) {
-		var _this2 = this;
-
-		return _asyncToGenerator(function* () {
-			assertEventName(eventName);
-
-			const listeners = getListeners(_this2, eventName);
-			const anyListeners = anyMap.get(_this2);
-			const staticListeners = [...listeners];
-			const staticAnyListeners = [...anyListeners];
-
-			yield resolvedPromise;
-			/* eslint-disable no-await-in-loop */
-			for (const listener of staticListeners) {
-				if (listeners.has(listener)) {
-					yield listener(eventData);
-				}
-			}
-
-			for (const listener of staticAnyListeners) {
-				if (anyListeners.has(listener)) {
-					yield listener(eventName, eventData);
-				}
-			}
-			/* eslint-enable no-await-in-loop */
-		})();
-	}
-
-	onAny(listener) {
-		assertListener(listener);
-		anyMap.get(this).add(listener);
-		return this.offAny.bind(this, listener);
-	}
-
-	offAny(listener) {
-		assertListener(listener);
-		anyMap.get(this).delete(listener);
-	}
-
-	clearListeners(eventName) {
-		if (typeof eventName === 'string') {
-			getListeners(this, eventName).clear();
-		} else {
-			anyMap.get(this).clear();
-			for (const listeners of eventsMap.get(this).values()) {
-				listeners.clear();
-			}
-		}
-	}
-
-	listenerCount(eventName) {
-		if (typeof eventName === 'string') {
-			return anyMap.get(this).size + getListeners(this, eventName).size;
-		}
-
-		if (typeof eventName !== 'undefined') {
-			assertEventName(eventName);
-		}
-
-		let count = anyMap.get(this).size;
-
-		for (const value of eventsMap.get(this).values()) {
-			count += value.size;
-		}
-
-		return count;
-	}
-}
-
-// Subclass used to encourage TS users to type their events.
-Emittery.Typed = class extends Emittery {};
-Object.defineProperty(Emittery.Typed, 'Typed', {
-	enumerable: false,
-	value: undefined
-});
-
-module.exports = Emittery;