Make sure the open source you're using is safe to use
typed-emitter
v1.3.1Strictly typed event emitter interface for TypeScript 3.
npm install typed-emitter
We couldn't find any similar packages Browse all packages
Package Health Score
61 / 100
- Popularity Recognized
- Maintenance Inactive
- Security No known security issues
- Community Limited
Make sure the open source you're using is safe to usePopularity
Recognized
Weekly Downloads (20,178)- Dependents
- 59
- GitHub Stars
- 83
- Forks
- 8
- Contributors
- 6
The npm package typed-emitter receives a total of 20,178 downloads a week. As such, we scored typed-emitter popularity level to be Recognized.
Based on project statistics from the GitHub repository for the npm package typed-emitter, we found that it has been starred 83 times, and that 59 other projects in the ecosystem are dependent on it.
Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.
Security
No known security issues
Security and license risk for significant versions
All VersionsDirect Vulnerabilities
0.0.2
0.1.0
0.2.0
1.2.0
1.3.1
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
Indirect Vulnerabilities
0.0.2
0.1.0
0.2.0
1.2.0
1.3.1
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
License Risks
0.0.2
0.1.0
0.2.0
1.2.0
1.3.1
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
All security vulnerabilities belong to
production dependencies of direct and indirect
packages.
We found a way for you to contribute to the project! Looks like typed-emitter is missing a security policy.
You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.
We found a way for you to contribute to the project! Looks like typed-emitter is missing a security policy.
# Install the Snyk CLI and test your project
npm i snyk && snyk test typed-emitter
Maintenance
Inactive
Commit Frequency- Open Issues
- 2
- Merged PR
- 7
- Open PR
- 0
- Last Commit
- 4 months ago
Further analysis of the maintenance status of typed-emitter based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.
We found that typed-emitter demonstrates a positive version release cadence with at least one new version released in the past 12 months.
In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.
Community
Limited
- Readme.md
- Yes
- Contributing.md
- No
- Code of Conduct
- No
- Contributors
- 6
- Funding
- No
This project has seen only 10 or less contributors.
We found a way for you to contribute to the project! Looks like typed-emitter is missing a Code of Conduct.
Embed Package Health Score Badge
Package
- Node.js Compatibility
- not defined
- Age
- 5 years
- Dependencies
- 0 Direct
- Versions
- 10
- Install Size
- 5.34 kB
- Dist-tags
- 1
- # of Files
- 4
- Maintainers
- 1
- TS Typings
- No
typed-emitter has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.
Typed-Emitter
Strictly typed event emitter interface for TypeScript 3.
Code size: Zero bytes - Just the typings, no implementation. Use the default event emitter of the events module in node.js or bring your favorite implementation when writing code for the browser.
Installation
$ npm install --save-dev typed-emitter
# Using yarn:
$ yarn add --dev typed-emitter
Usage
import EventEmitter from "events"
import TypedEmitter from "typed-emitter"
// Define your emitter's types like that:
// Key: Event name; Value: Listener function signature
interface MessageEvents {
error: (error: Error) => void,
message: (body: string, from: string) => void
}
const messageEmitter = new EventEmitter() as TypedEmitter<MessageEvents>
// Good 👍
messageEmitter.emit("message", "Hi there!", "no-reply@test.com")
// TypeScript will catch those mistakes ✋
messageEmitter.emit("mail", "Hi there!", "no-reply@test.com")
messageEmitter.emit("message", "Hi there!", true)
// Good 👍
messageEmitter.on("error", (error: Error) => { /* ... */ })
// TypeScript will catch those mistakes ✋
messageEmitter.on("error", (error: string) => { /* ... */ })
messageEmitter.on("failure", (error: Error) => { /* ... */ })
Extending an emitter
You might find yourself in a situation where you need to extend an event emitter, but also want to strictly type its events. Here is how to.
class MyEventEmitter extends (EventEmitter as new () => TypedEmitter<MyEvents>) {
// ...
}
As a generic class:
class MyEventEmitter<T> extends (EventEmitter as { new<T>(): TypedEmitter<T> })<T> {
// ...
}
Why another package?
The interface that comes with @types/node is not type-safe at all. It does not even offer a way of specifying the events that the emitter will emit...
The eventemitter3 package is a popular event emitter implementation that comes with TypeScript types out of the box. Unfortunately there is no way to declare the event arguments that the listeners have to expect.
There were a few other examples of type-safe event emitter interfaces out there as well. They were either not published to npm, had an inconsistent interface or other limitations.
License
MIT
typed-emitter versions
| Version | Published | Tag | Node.js Compatability | Licenses | Dependencies | Direct Vulnerabilities | Publisher |
|---|---|---|---|---|---|---|---|
| 1.3.1 | 23 September 2020 | latest | * | MIT | 0 |
| andywer |
| 1.2.0 | 27 May 2020 | * | MIT | 0 |
| andywer | |
| 0.2.0 | 21 October 2019 | * | MIT | 0 |
| andywer | |
| All Versions | |||||||
typed-emitter dependencies
Last updated on
21 January-2021, at 23:06 (UTC).