mitt.ts 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  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} 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. * Remove an event handler for the given type.
  61. * If `handler` is omitted, all handlers of the given type are removed.
  62. * @param {string|symbol} type Type of event to unregister `handler` from (`'*'` to remove a wildcard handler)
  63. * @param {Function} [handler] Handler function to remove
  64. * @memberOf mitt
  65. */
  66. off<Key extends keyof Events>(type: Key, handler?: GenericEventHandler) {
  67. const handlers: Array<GenericEventHandler> | undefined = all!.get(type)
  68. if (handlers) {
  69. if (handler)
  70. handlers.splice(handlers.indexOf(handler) >>> 0, 1)
  71. else
  72. all!.set(type, [])
  73. }
  74. },
  75. /**
  76. * Invoke all handlers for the given type.
  77. * If present, `'*'` handlers are invoked after type-matched handlers.
  78. *
  79. * Note: Manually firing '*' handlers is not supported.
  80. *
  81. * @param {string|symbol} type The event type to invoke
  82. * @param {Any} [evt] Any value (object is recommended and powerful), passed to each handler
  83. * @memberOf mitt
  84. */
  85. emit<Key extends keyof Events>(type: Key, evt?: Events[Key]) {
  86. let handlers = all!.get(type)
  87. if (handlers) {
  88. (handlers as EventHandlerList<Events[keyof Events]>).slice().forEach((handler) => {
  89. handler(evt as Events[Key])
  90. })
  91. }
  92. handlers = all!.get('*')
  93. if (handlers) {
  94. (handlers as WildCardEventHandlerList<Events>).slice().forEach((handler) => {
  95. handler(type, evt as Events[Key])
  96. })
  97. }
  98. },
  99. /**
  100. * Clear all
  101. */
  102. clear() {
  103. this.all.clear()
  104. },
  105. }
  106. }