Installation
npm install --save @types/pubsub-js
Summary
This package contains type definitions for pubsub-js (https://github.com/mroderick/PubSubJS).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pubsub-js.
index.d.ts
declare namespace PubSubJS {
interface Base<T = any, M = Message>
extends
CountSubscriptions,
ClearAllSubscriptions,
GetSubscriptions,
Publish<T, M>,
Subscribe<T, M>,
Unsubscribe<T>
{
name: string;
version: string;
}
type Token = string;
type Message = string | symbol;
type SubscriptionListener<T> = (message: string, data?: T) => void;
interface CountSubscriptions {
countSubscriptions(token: Token): number;
}
interface ClearAllSubscriptions {
clearAllSubscriptions(token?: Token): void;
}
interface GetSubscriptions {
getSubscriptions(token: Token): Message[];
}
interface Publish<T, M> {
publish(message: M, data?: T): boolean;
publishSync(message: M, data?: T): boolean;
}
interface Subscribe<T, M> {
subscribe(message: M, func: SubscriptionListener<T>): Token;
subscribeOnce(message: M, func: SubscriptionListener<T>): Base<T, M>;
}
interface Unsubscribe<T> {
unsubscribe(tokenOrFunction: Token | SubscriptionListener<T>): Token | boolean;
}
}
declare var PubSub: PubSubJS.Base;
declare module "pubsub-js" {
export = PubSub;
}
Additional Details
- Last updated: Tue, 07 Nov 2023 09:09:39 GMT
- Dependencies: none
Credits
These definitions were written by Boris Yankov, Matthias Lindinger, and Profesor08.