diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 41 |
1 files changed, 26 insertions, 15 deletions
@@ -69,6 +69,9 @@ 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 @@ -99,11 +102,13 @@ const emitter: mitt.Emitter = mitt(); #### Table of Contents - [mitt](#mitt) -- [on](#on) +- [emit](#emit) + - [Properties](#properties) +- [emit](#emit-1) - [Parameters](#parameters) -- [off](#off) +- [on](#on) - [Parameters](#parameters-1) -- [emit](#emit) +- [off](#off) - [Parameters](#parameters-2) ### mitt @@ -112,6 +117,24 @@ Mitt: Tiny (~200b) functional event emitter / pubsub. Returns **Mitt** +### emit + +#### Properties + +- `all` **EventHandlerMap** Contains all registered event handlers. + +### 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 + +- `type` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \| [symbol](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol))** The event type to invoke +- `evt` **Any?** Any value (object is recommended and powerful), passed to each handler + ### on Register an event handler for the given type. @@ -130,18 +153,6 @@ Remove an event handler for the given type. - `type` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \| [symbol](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol))** Type of event to unregister `handler` from, or `"*"` - `handler` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Handler function to remove -### 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 - -- `type` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \| [symbol](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol))** The event type to invoke -- `evt` **Any?** Any value (object is recommended and powerful), passed to each handler - ## Contribute First off, thanks for taking the time to contribute! |