diff --git a/README.md b/README.md index 2e55675..61d3b2c 100755 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ [![NPM Version](https://badge.fury.io/js/tseep.svg?style=flat)](https://www.npmjs.com/package/tseep) +[![GitHub stars](https://img.shields.io/github/stars/Morglod/tseep.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/Morglod/tseep/) # tseep @@ -13,9 +14,6 @@ Up to **x12** faster than `eventemitter3` in terms of "classic api event emitter - Worlds fastest pure-js `EventEmitter` - Fully tested with eventemitter3 tests -PS Uses `eval` for runtime codegenerations; -don't be afraid of it, all JS engines use it lol. - [how it works](./docs/how_it_works_en.md) ## Benchmarks @@ -65,19 +63,13 @@ events.emit("foo", 123, "hello world"); !! **`__proto__`** event name is restricted (type guard exists) !! -
- -Full EventEmitter class api - - ```ts - // Listener = (...args: any[]) => Promise|void // EventMap extends { [event in (string|symbol)]: Listener } class EventEmitter { - maxListeners: number; - _eventsCount: number; + readonly maxListeners: number; + readonly _eventsCount: number; emit(event: EventKey, ...args: ArgsN): boolean; on(event: EventKey, listener: EventMap[EventKey]): this; @@ -98,8 +90,6 @@ class EventEmitter { } ``` -
- ## License MIT diff --git a/docs/how_it_works_en.md b/docs/how_it_works_en.md index 352b706..ede78fb 100644 --- a/docs/how_it_works_en.md +++ b/docs/how_it_works_en.md @@ -1,5 +1,8 @@ # event emitter +PS Uses `eval` for runtime codegenerations; +don't be afraid of it, all JS engines use it lol. + ## Switching Implementations When calling emit, we also need to handle once listeners (which may not exist). diff --git a/package.json b/package.json index 83ac909..53e5a8b 100755 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "tseep", - "version": "1.0.4", + "version": "1.0.5", "description": "Fastest event emitter in the world", "main": "lib/index.js", "types": "lib/index.d.ts",