Gathering detailed insights and metrics for strict-event-emitter
Gathering detailed insights and metrics for strict-event-emitter
Installations
npm install strict-event-emitterDeveloper Guide
BETA
Typescript
No
Module System
CommonJS, ESM
Node Version
18.17.1
NPM Version
9.6.7
Score
99.6
Supply Chain
92.3
Quality
75.9
Maintenance
100
Vulnerability
100
License
Releases
15
Languages
2
TypeScript
JavaScript
TypeScript (99.11%)
JavaScript (0.89%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
65 Stars
66 Commits
7 Forks
2 Watchers
2 Branches
7 Contributors
Updated on Mar 20, 2025
Bundle Size
2.36 kB
Minified
898.00 B
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
0.5.1
Package Id
strict-event-emitter@0.5.1
Unpacked Size
44.67 kB
Size
7.02 kB
File Count
7
NPM Version
9.6.7
Node Version
18.17.1
Published on
Sep 21, 2023
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Strict Event Emitter
A type-safe implementation of EventEmitter for browser and Node.js.
Motivation
Despite event emitters potentially accepting any runtime value, defining a strict event contract is crucial when developing complex event-driven architectures. Unfortunately, the native type definitions for Node's EventEmitter annotate event names as string, which forbids any stricter type validation.
1// index.js 2const emitter = new EventEmitter() 3 4// Let's say our application expects a "ping" 5// event with the number payload. 6emitter.on('ping', (n: number) => {}) 7 8// We can, however, emit a different event by mistake. 9emitter.emit('pong', 1) 10 11// Or even the correct event with the wrong data. 12emitter.emit('ping', 'wait, not a number')
The purpose of this library is to provide an EventEmitter instance that can accept a generic describing the expected events contract.
1import { Emitter } from 'strict-event-emitter' 2 3// Define a strict events contract where keys 4// represent event names and values represent 5// the list of arguments expected in ".emit()". 6type Events = { 7 ping: [number] 8} 9 10const emitter = new Emitter<Events>() 11emitter.addListener('ping', (n) => { 12 // "n" argument type is inferred as "number'. 13}) 14 15emitter.emit('ping', 10) // OK 16emitter.emit('unknown', 10) // TypeError (invalid event name) 17emitter.emit('ping', 'wait, not a number') // TypeError (invalid data)
This library is also a custom EventEmitter implementation, which makes it compatible with other environments, like browsers or React Native.
Getting started
Install
1npm install strict-event-emitter
Use
1import { Emitter } from 'strict-event-emitter' 2 3// 1. Define an interface that describes your events. 4// Set event names as the keys, and their expected payloads as values. 5interface Events { 6 connect: [id: string] 7 disconnect: [id: string] 8} 9 10// 2. Create a strict emitter and pass the previously defined "Events" 11// as its first generic argument. 12const emitter = new Emitter<Events>() 13 14// 3. Use the "emitter" the same way you'd use the regular "EventEmitter" instance. 15emitter.addListener('connect', (id) => {}) 16emitter.emit('connect', 'abc-123')
License
MIT
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
Found 5/30 approved changesets -- score normalized to 1
Reason
9 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-3mv9-4h5g-vhg3
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Info: no jobLevel write permissions found
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/open-draft/strict-event-emitter/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/open-draft/strict-event-emitter/main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/open-draft/strict-event-emitter/main.yml/main?enable=pin
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
license file not detected
Details
- Warn: project does not have a license file
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 12 are checked with a SAST tool
Score
2.6
/10
Last Scanned on 2025-05-26
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More