npmpackage.info

strongly-typed-events

Add the power of events to your projects. We even have 3 flavors for you! Each in their own package.

3.0.11

138

MIT

TypeScript

2.69 kB

1,147,535 2.8

Installations

npm install strongly-typed-events

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=4.2.4

Node Version

18.17.0

NPM Version

lerna/7.1.4/node@v18.17.0+x64 (win32)

Score

79.7

Supply Chain

100

Quality

76.2

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

4

Total

509

Closed

259

Merged

246

Issues

Open

0

Total

28

Closed

28

Releases

2.1.9

Updated on Jul 19, 2021

v1.1.3

Updated on Feb 18, 2018

0.3.0

Updated on Jul 10, 2016

0.2.1

Updated on Jul 09, 2016

0.2.0

Updated on May 29, 2016

0.1.0

Updated on May 26, 2016

View All 6 releases

Contributors

Unable to fetch Contributors

View All 9 Contributors

Languages

TypeScript

HTML

JavaScript

PowerShell

TypeScript (89.55%)

HTML (5.6%)

JavaScript (4.23%)

PowerShell (0.62%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

KeesCBakker

Download Statistics

Total Downloads

1,147,535

Last Day

780

Last Week

4,244

Last Month

21,387

Last Year

188,095

GitHub Statistics

MIT License

138 Stars

747 Commits

14 Forks

8 Watchers

6 Branches

9 Contributors

Updated on Dec 19, 2024

Bundle Size

21.24 kB

Minified

2.69 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

3.0.11

Package Id

strongly-typed-events@3.0.11

Unpacked Size

16.74 kB

Size

4.31 kB

File Count

NPM Version

lerna/7.1.4/node@v18.17.0+x64 (win32)

Node Version

18.17.0

Published on

Aug 09, 2023

Total Downloads

Cumulative downloads

Total Downloads

1,147,535

Last Day

26%

780

Compared to previous day

Last Week

-13.6%

4,244

Compared to previous week

Last Month

42.4%

21,387

Compared to previous month

Last Year

-25%

188,095

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

ste-core ste-events ste-promise-events ste-promise-signals ste-promise-simple-events ste-signals ste-simple-events

Dev Dependencies

@types/chai @types/mocha @types/node chai del-cli mocha ts-node typescript

Strongly Typed Events

Add the power of events to your projects. We even have 3 flavors for you.

Event types

This project gives you the following event types:

Events - styled after the way .Net implements events. With each event you'll get a sender and an argument object. If you use typescript, you can implement them using generics.
Simple events - basically the same thing, with only 1 argument.
Signals - for when no data is needed, just the firing of the event is enough.

Subscription made easy

An example says more than a 1000 words. Imagine if you have events like this on your class:

1let clock = new Clock("Smu", 1000);
2
3//log the ticks to the console - this is a signal event
4clock.onTick.subscribe(() => console.log("Tick!"));
5
6//log the sequence parameter to the console - this is a simple event
7clock.onSequenceTick.subscribe(s => console.log(`Sequence: ${s}`));
8
9//log the name of the clock and the tick argument to the console - this is an event
10clock.onClockTick.subscribe((c, n) =>
11  console.log(`${c.name} ticked ${n} times.`)
12);

Events made easy

So let's look at the implementation from a TypeScript perspective. (Do you program NodeJs without typescript? Check this)

1import { SignalDispatcher, SimpleEventDispatcher, EventDispatcher } from "strongly-typed-events";
2
3class Clock {
4  private _onTick = new SignalDispatcher();
5  private _onSequenceTick = new SimpleEventDispatcher<number>();
6  private _onClockTick = new EventDispatcher<Clock, number>();
7  private _ticks: number = 0;
8
9  constructor(public name: string, timeout: number) {
10    setInterval(() => {
11      this._ticks += 1;
12      this._onTick.dispatch();
13      this._onSequenceTick.dispatch(this._ticks);
14      this._onClockTick.dispatch(this, this._ticks);
15    }, timeout);
16  }
17
18  public get onTick() {
19    return this._onTick.asEvent();
20  }
21
22  public get onSequenceTick() {
23    return this._onSequenceTick.asEvent();
24  }
25
26  public get onClockTick() {
27    return this._onClockTick.asEvent();
28  }
29}

Stopping events

You can stop events from being propagated.

1let dispatcher = new SignalDispatcher();
2
3  let a = 0;
4  dispatcher.sub(ev => {
5    a++;
6    if (a > 2) {
7      ev.stopPropagation();
8    }
9  });
10
11  let b = 0;
12  dispatcher.sub(() => { b++; });
13
14  dispatcher.dispatch();
15  dispatcher.dispatch();
16  dispatcher.dispatch();
17  dispatcher.dispatch();
18
19  // a should be 4, because 4 dispatches are done.");
20  // b should be 2, because events after the 2nd dispatch are stopped."
21

Packages

The project is separated into multiple packages, so you only need to include what you need. We have the following packages:

Package	Description
`ste-core`	Package that contains all the building blocks for the creation of events. The dispatcher implementation is its main hero.
`ste-events` or `ste-promise-events`	Events that are modeled after .Net with a `sender` and `argument`. If you use typescript, you can leverage the support for generics and get strongly typed code.
`ste-simple-events` or `ste-promise-simple-events`	A simpler version of the `ste-event`-event. No sender, just an argument.
`ste-signals` or `ste-promise-signals`	A signal is even simpler, it is just a callback for when you need to be alerted without any scope.
`strongly-typed-events`	This package includes everything.
`ste-browser`	Helps to host events in the browser.

Documentation

This project will help you to add events, event handling en event dispatching to your classes. To get you started, check:

Check the documentation or the examples for more information.

History

The change history can be found here.

Maintenance

This project is maintained by Kees C. Bakker.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.8

/10

Last Scanned on 2025-02-10

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

Other packages similar to strongly-typed-events

ste-core

3.0.11

Core files for the Strongly Typed Events project.

ste-simple-events

3.0.11

Add the power of Simple Events to your projects. Every event has an argument with its data.

ste-events

3.0.11

Add the power of Events to your projects. They are styled after .Net using a sender and arguments.

sub-events

1.10.1

Lightweight, strongly-typed events, with monitored subscriptions.

Gathering detailed insights and metrics for strongly-typed-events