433 lines
12 KiB
TypeScript
433 lines
12 KiB
TypeScript
|
/**
|
||
|
|
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;
|
||
|
|
|
||
|
|
// Helper type for turning the passed `EventData` type map into a list of string keys that don't require data alongside the event name when emitting. Uses the same trick that `Omit` does internally to filter keys by building a map of keys to keys we want to keep, and then accessing all the keys to return just the list of keys we want to keep.
|
||
|
|
type DatalessEventNames<EventData> = {
|
||
|
|
[Key in keyof EventData]: EventData[Key] extends undefined ? Key : never;
|
||
|
|
}[keyof EventData];
|
||
|
|
|
||
|
|
declare const listenerAdded: unique symbol;
|
||
|
|
declare const listenerRemoved: unique symbol;
|
||
|
|
type OmnipresentEventData = {[listenerAdded]: Emittery.ListenerChangedData; [listenerRemoved]: Emittery.ListenerChangedData};
|
||
|
|
|
||
|
|
/**
|
||
|
|
Emittery is a strictly typed, fully async EventEmitter implementation. Event listeners can be registered with `on` or `once`, and events can be emitted with `emit`.
|
||
|
|
|
||
|
|
`Emittery` has a generic `EventData` type that can be provided by users to strongly type the list of events and the data passed to the listeners for those events. Pass an interface of {[eventName]: undefined | <eventArg>}, with all the event names as the keys and the values as the type of the argument passed to listeners if there is one, or `undefined` if there isn't.
|
||
|
|
|
||
|
|
@example
|
||
|
|
```
|
||
|
|
import Emittery = require('emittery');
|
||
|
|
|
||
|
|
const emitter = new Emittery<
|
||
|
|
// Pass `{[eventName: <string | symbol>]: undefined | <eventArg>}` as the first type argument for events that pass data to their listeners.
|
||
|
|
// A value of `undefined` in this map means the event listeners should expect no data, and a type other than `undefined` means the listeners will receive one argument of that type.
|
||
|
|
{
|
||
|
|
open: string,
|
||
|
|
close: undefined
|
||
|
|
}
|
||
|
|
>();
|
||
|
|
|
||
|
|
// Typechecks just fine because the data type for the `open` event is `string`.
|
||
|
|
emitter.emit('open', 'foo\n');
|
||
|
|
|
||
|
|
// Typechecks just fine because `close` is present but points to undefined in the event data type map.
|
||
|
|
emitter.emit('close');
|
||
|
|
|
||
|
|
// TS compilation error because `1` isn't assignable to `string`.
|
||
|
|
emitter.emit('open', 1);
|
||
|
|
|
||
|
|
// TS compilation error because `other` isn't defined in the event data type map.
|
||
|
|
emitter.emit('other');
|
||
|
|
```
|
||
|
|
*/
|
||
|
|
declare class Emittery<
|
||
|
|
EventData = Record<string, any>, // When https://github.com/microsoft/TypeScript/issues/1863 ships, we can switch this to have an index signature including Symbols. If you want to use symbol keys right now, you need to pass an interface with those symbol keys explicitly listed.
|
||
|
|
AllEventData = EventData & OmnipresentEventData,
|
||
|
|
DatalessEvents = DatalessEventNames<EventData>
|
||
|
|
> {
|
||
|
|
/**
|
||
|
|
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: typeof listenerAdded;
|
||
|
|
|
||
|
|
/**
|
||
|
|
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: typeof listenerRemoved;
|
||
|
|
|
||
|
|
/**
|
||
|
|
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 | symbol,
|
||
|
|
methodNames?: readonly string[]
|
||
|
|
): <T extends { new (): any }>(klass: T) => T; // eslint-disable-line @typescript-eslint/prefer-function-type
|
||
|
|
|
||
|
|
/**
|
||
|
|
Subscribe to one or more events.
|
||
|
|
|
||
|
|
Using the same listener multiple times for the same event will result in only one method call per emitted event.
|
||
|
|
|
||
|
|
@returns An unsubscribe method.
|
||
|
|
|
||
|
|
@example
|
||
|
|
```
|
||
|
|
import Emittery = require('emittery');
|
||
|
|
|
||
|
|
const emitter = new Emittery();
|
||
|
|
|
||
|
|
emitter.on('🦄', data => {
|
||
|
|
console.log(data);
|
||
|
|
});
|
||
|
|
emitter.on(['🦄', '🐶'], data => {
|
||
|
|
console.log(data);
|
||
|
|
});
|
||
|
|
|
||
|
|
emitter.emit('🦄', '🌈'); // log => '🌈' x2
|
||
|
|
emitter.emit('🐶', '🍖'); // log => '🍖'
|
||
|
|
```
|
||
|
|
*/
|
||
|
|
on<Name extends keyof AllEventData>(
|
||
|
|
eventName: Name,
|
||
|
|
listener: (eventData: AllEventData[Name]) => void | Promise<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`.
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
It accepts multiple event names.
|
||
|
|
|
||
|
|
@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
|
||
|
|
});
|
||
|
|
```
|
||
|
|
*/
|
||
|
|
events<Name extends keyof EventData>(
|
||
|
|
eventName: Name | Name[]
|
||
|
|
): AsyncIterableIterator<EventData[Name]>;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Remove one or more event subscriptions.
|
||
|
|
|
||
|
|
@example
|
||
|
|
```
|
||
|
|
import Emittery = require('emittery');
|
||
|
|
|
||
|
|
const emitter = new Emittery();
|
||
|
|
|
||
|
|
const listener = data => console.log(data);
|
||
|
|
(async () => {
|
||
|
|
emitter.on(['🦄', '🐶', '🦊'], listener);
|
||
|
|
await emitter.emit('🦄', 'a');
|
||
|
|
await emitter.emit('🐶', 'b');
|
||
|
|
await emitter.emit('🦊', 'c');
|
||
|
|
emitter.off('🦄', listener);
|
||
|
|
emitter.off(['🐶', '🦊'], listener);
|
||
|
|
await emitter.emit('🦄', 'a'); // nothing happens
|
||
|
|
await emitter.emit('🐶', 'b'); // nothing happens
|
||
|
|
await emitter.emit('🦊', 'c'); // nothing happens
|
||
|
|
})();
|
||
|
|
```
|
||
|
|
*/
|
||
|
|
off<Name extends keyof AllEventData>(
|
||
|
|
eventName: Name,
|
||
|
|
listener: (eventData: AllEventData[Name]) => void | Promise<void>
|
||
|
|
): void;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Subscribe to one or more events only once. It will be unsubscribed after the first
|
||
|
|
event.
|
||
|
|
|
||
|
|
@returns The event data when `eventName` is emitted.
|
||
|
|
|
||
|
|
@example
|
||
|
|
```
|
||
|
|
import Emittery = require('emittery');
|
||
|
|
|
||
|
|
const emitter = new Emittery();
|
||
|
|
|
||
|
|
emitter.once('🦄').then(data => {
|
||
|
|
console.log(data);
|
||
|
|
//=> '🌈'
|
||
|
|
});
|
||
|
|
emitter.once(['🦄', '🐶']).then(data => {
|
||
|
|
console.log(data);
|
||
|
|
});
|
||
|
|
|
||
|
|
emitter.emit('🦄', '🌈'); // Logs `🌈` twice
|
||
|
|
emitter.emit('🐶', '🍖'); // Nothing happens
|
||
|
|
```
|
||
|
|
*/
|
||
|
|
once<Name extends keyof AllEventData>(eventName: Name): Promise<AllEventData[Name]>;
|
||
|
|
|
||
|
|
/**
|
||
|
|
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<Name extends DatalessEvents>(eventName: Name): Promise<void>;
|
||
|
|
emit<Name extends keyof EventData>(
|
||
|
|
eventName: Name,
|
||
|
|
eventData: EventData[Name]
|
||
|
|
): 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<Name extends DatalessEvents>(eventName: Name): Promise<void>;
|
||
|
|
emitSerial<Name extends keyof EventData>(
|
||
|
|
eventName: Name,
|
||
|
|
eventData: EventData[Name]
|
||
|
|
): Promise<void>;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Subscribe to be notified about any event.
|
||
|
|
|
||
|
|
@returns A method to unsubscribe.
|
||
|
|
*/
|
||
|
|
onAny(
|
||
|
|
listener: (
|
||
|
|
eventName: keyof EventData,
|
||
|
|
eventData: EventData[keyof EventData]
|
||
|
|
) => void | Promise<void>
|
||
|
|
): 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<
|
||
|
|
[keyof EventData, EventData[keyof EventData]]
|
||
|
|
>;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Remove an `onAny` subscription.
|
||
|
|
*/
|
||
|
|
offAny(
|
||
|
|
listener: (
|
||
|
|
eventName: keyof EventData,
|
||
|
|
eventData: EventData[keyof EventData]
|
||
|
|
) => void | Promise<void>
|
||
|
|
): void;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Clear all event listeners on the instance.
|
||
|
|
|
||
|
|
If `eventName` is given, only the listeners for that event are cleared.
|
||
|
|
*/
|
||
|
|
clearListeners(eventName?: keyof EventData): void;
|
||
|
|
|
||
|
|
/**
|
||
|
|
The number of listeners for the `eventName` or all events if not specified.
|
||
|
|
*/
|
||
|
|
listenerCount(eventName?: keyof EventData): 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: Record<string, unknown>, methodNames?: readonly string[]): void;
|
||
|
|
}
|
||
|
|
|
||
|
|
declare namespace Emittery {
|
||
|
|
/**
|
||
|
|
Removes an event subscription.
|
||
|
|
*/
|
||
|
|
type UnsubscribeFn = () => void;
|
||
|
|
|
||
|
|
/**
|
||
|
|
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 | Promise<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;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
export = Emittery;
|