mitt.ts 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. /**
  2. * copy to https://github.com/developit/mitt
  3. * Expand clear method
  4. */
  5. export type EventType = string | symbol;
  6. // An event handler can take an optional event argument
  7. // and should not return a value
  8. export type Handler<T = unknown> = (event: T) => void;
  9. export type WildcardHandler<T = Record<string, unknown>> = (
  10. type: keyof T,
  11. event: T[keyof T],
  12. ) => void;
  13. // An array of all currently registered event handlers for a type
  14. export type EventHandlerList<T = unknown> = Array<Handler<T>>;
  15. export type WildCardEventHandlerList<T = Record<string, unknown>> = Array<WildcardHandler<T>>;
  16. // A map of event types and their corresponding event handlers.
  17. export type EventHandlerMap<Events extends Record<EventType, unknown>> = Map<
  18. keyof Events | '*',
  19. EventHandlerList<Events[keyof Events]> | WildCardEventHandlerList<Events>
  20. >;
  21. export interface Emitter<Events extends Record<EventType, unknown>> {
  22. all: EventHandlerMap<Events>;
  23. on<Key extends keyof Events>(type: Key, handler: Handler<Events[Key]>): void;
  24. on(type: '*', handler: WildcardHandler<Events>): void;
  25. off<Key extends keyof Events>(type: Key, handler?: Handler<Events[Key]>): void;
  26. off(type: '*', handler: WildcardHandler<Events>): void;
  27. emit<Key extends keyof Events>(type: Key, event: Events[Key]): void;
  28. emit<Key extends keyof Events>(type: undefined extends Events[Key] ? Key : never): void;
  29. clear(): void;
  30. }
  31. /**
  32. * Mitt: Tiny (~200b) functional event emitter / pubsub.
  33. * @name mitt
  34. * @returns {Mitt}
  35. */
  36. export function mitt<Events extends Record<EventType, unknown>>(
  37. all?: EventHandlerMap<Events>,
  38. ): Emitter<Events> {
  39. type GenericEventHandler = Handler<Events[keyof Events]> | WildcardHandler<Events>;
  40. all = all || new Map();
  41. return {
  42. /**
  43. * A Map of event names to registered handler functions.
  44. */
  45. all,
  46. /**
  47. * Register an event handler for the given type.
  48. * @param {string|symbol} type Type of event to listen for, or `'*'` for all events
  49. * @param {Function} handler Function to call in response to given event
  50. * @memberOf mitt
  51. */
  52. on<Key extends keyof Events>(type: Key, handler: GenericEventHandler) {
  53. const handlers: Array<GenericEventHandler> | undefined = all!.get(type);
  54. if (handlers) {
  55. handlers.push(handler);
  56. } else {
  57. all!.set(type, [handler] as EventHandlerList<Events[keyof Events]>);
  58. }
  59. },
  60. /**
  61. * Remove an event handler for the given type.
  62. * If `handler` is omitted, all handlers of the given type are removed.
  63. * @param {string|symbol} type Type of event to unregister `handler` from (`'*'` to remove a wildcard handler)
  64. * @param {Function} [handler] Handler function to remove
  65. * @memberOf mitt
  66. */
  67. off<Key extends keyof Events>(type: Key, handler?: GenericEventHandler) {
  68. const handlers: Array<GenericEventHandler> | undefined = all!.get(type);
  69. if (handlers) {
  70. if (handler) {
  71. handlers.splice(handlers.indexOf(handler) >>> 0, 1);
  72. } else {
  73. all!.set(type, []);
  74. }
  75. }
  76. },
  77. /**
  78. * Invoke all handlers for the given type.
  79. * If present, `'*'` handlers are invoked after type-matched handlers.
  80. *
  81. * Note: Manually firing '*' handlers is not supported.
  82. *
  83. * @param {string|symbol} type The event type to invoke
  84. * @param {Any} [evt] Any value (object is recommended and powerful), passed to each handler
  85. * @memberOf mitt
  86. */
  87. emit<Key extends keyof Events>(type: Key, evt?: Events[Key]) {
  88. let handlers = all!.get(type);
  89. if (handlers) {
  90. (handlers as EventHandlerList<Events[keyof Events]>).slice().forEach((handler) => {
  91. handler(evt as Events[Key]);
  92. });
  93. }
  94. handlers = all!.get('*');
  95. if (handlers) {
  96. (handlers as WildCardEventHandlerList<Events>).slice().forEach((handler) => {
  97. handler(type, evt as Events[Key]);
  98. });
  99. }
  100. },
  101. /**
  102. * Clear all
  103. */
  104. clear() {
  105. this.all.clear();
  106. },
  107. };
  108. }