Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

type-signals

englercj1.6kMIT1.1.0TypeScript support: included

Small and fast Signal library for Typescript.

typescript, signals, events

readme

Type Signals

Small and fast Signal library for Typescript.

Heavily inspired by mini-signals.

Install

npm install type-signals

Documentation

Example Usage

import { Signal } from 'type-signals';

type OnDoThingSignal = (foo: string, bar: string): void;
const mySignal = new Signal<OnDoThingSignal>();

const binding = mySignal.add(onSignal); // add listener
mySignal.dispatch('foo', 'bar');        // dispatch signal passing custom parameters
binding.detach();                       // remove a single listener

function onSignal(foo: string, bar: string)
{
    assert(foo === 'foo');
    assert(bar === 'bar');
}