Skip to content

Commit 76c1d96

Browse files
committed
Include sample usage in readme
1 parent 656c8c3 commit 76c1d96

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,22 @@ If present, `"*"` handlers are invoked prior to type-matched handlers.
5252

5353
- `type` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The event type to invoke
5454
- `event` **\[Any]** An event object, passed to each handler
55+
56+
* * *
57+
58+
## Sample usage
59+
60+
```es6
61+
import mitt from 'mitt'
62+
63+
let emitter = mitt()
64+
65+
// listen to an event
66+
emitter.on('foo', e => console.log('foo', e) )
67+
68+
// listen to all events
69+
emitter.on('*', (type, e) => console.log(type, e) )
70+
71+
// fire an event
72+
emitter.emit('foo', { a: 'b' })
73+
```

0 commit comments

Comments
 (0)