Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Topic<T>

PubSub topic for communicating between plugins

Type parameters

  • T

Hierarchy

  • Topic

Index

Constructors

constructor

  • new Topic(plugin: Plugin<any, any, any>, name: string, subscriptions?: ISubscriptionRequest<T>[]): Topic
  • Parameters

    • plugin: Plugin<any, any, any>
    • name: string
    • Default value subscriptions: ISubscriptionRequest<T>[] = []

    Returns Topic

Properties

name

name: string

subscriptions

subscriptions: ISubscriptionRequest<T>[]

Methods

destroy

  • destroy(): Promise<void>
  • Returns Promise<void>

publish

  • publish(body: T): Promise<void>
  • Parameters

    • body: T

    Returns Promise<void>

subscribe

  • subscribe(request: ISubscriptionRequest<T>): void
  • Parameters

    • request: ISubscriptionRequest<T>

    Returns void

unsubscribe

  • unsubscribe(request: ISubscriptionRequest<T>): Promise<void>
  • Parameters

    • request: ISubscriptionRequest<T>

    Returns Promise<void>