suub

📫 Suub

A simple pub/sub written in Typescript

Gist

import { Subscription } from '../dist';

const mySub = Subscription.create<number>();

const unsub = mySub.subscribe(num => {
  console.log('num: ' + name);
});

mySub.call(45); // num: 45

unsub();

Examples

Take a look at the Examples folder.

API

Subscription.create(options: Options): Subscription

Create a new Subscription

• options.onFirstSubscription?: A function called when the subscriber count goes from 0 to 1
• options.onLastUnsubscribe?: A function called when the subscriber count goes from 1 to 0

Note: by default the T type is void meaning the Subscription has no data.

Subscription

A subscription object

Subscription.subscribe([subId, ] listener): Unsubscribe

Add a subscriber

• subId (optional): Associate an id with the listener to be able to unsubscribe by this same id.
• listener: The function that will be called when you call, this function receive a value as parameter (of type T)
• return Unsubscribe: returns a function that will unsubscribe the listener.

Subscription.call(value: T)

Call all listeners in the same order they were subscribed

• value: The value (of type T) that will be passed to the listeners

Note: If T is void this function does not take any arguments.

Subscription.unsubscribeAll()

Unsubscribe all listeners

Subscription.unsubscribe(listener)

Unsubscribe a listener either by reference or by id

• listener: Either an id (string) or a reference to a listener

Subscription.isSubscribed(listener): boolean

Test wether a listener id subscribed or not

• listener: Either an id (string) or a reference to a listener