Class PubSubClass

Event based communication module

Hierarchy

PubSubClass

Implements

XBaseJsModule

Index

Constructors

constructor

Properties

name

Accessors

Methods

Constructors

constructor

new PubSubClass(): PubSubClass

- Defined in PubSub/index.ts:32
The constructor function of PubSub

Returns PubSubClass

Properties

Readonly name

name: string = "PubSub"

Used as class' identity. will have constant value of "Permission"

Accessors

options

get options(): PubSubConfigs | Record<any, any>

Implementation of XBaseJsModule.options
- Defined in PubSub/index.ts:47
getter for property options

Returns PubSubConfigs | Record<any, any>

subscriptions

get subscriptions(): Record<string, any>

- Defined in PubSub/index.ts:54
getter for property subscriptions

Returns Record<string, any>

Methods

configure

configure<config>(arg: config): void

Implementation of XBaseJsModule.configure
- Defined in PubSub/index.ts:40
Add configuration into options property

Type Parameters
- config
Parameters
- arg: config
Returns void

publish

publish(type: string, message: any): void

- Defined in PubSub/index.ts:63
Funtion to publish custom event

Parameters
- type: string
- message: any
Returns void

subscribe

subscribe(type: string, listener: ((e: CustomEvent<any>) => any), options?: EventListenerOptions): string

- Defined in PubSub/index.ts:83
Function to subscribe to custom event

Parameters
- type: string
- listener: ((e: CustomEvent<any>) => any)
  - - (e: CustomEvent<any>): any
    - Parameters
      - e: CustomEvent<any>
      Returns any
- Optional options: EventListenerOptions
Returns string
subscription token string

unsubscribe

unsubscribe(token: string): void
unsubscribe(type: string, listener: ((e: CustomEvent<any>) => any), options?: boolean | EventListenerOptions): void

- Defined in PubSub/index.ts:106
Function to cancel a certain subscription

Parameters
- token: string
Returns void
- Defined in PubSub/index.ts:114
Function to cancel a certain subscription

Parameters
- type: string
- listener: ((e: CustomEvent<any>) => any)
  - - (e: CustomEvent<any>): any
    - Parameters
      - e: CustomEvent<any>
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void

unsubscribeAll

unsubscribeAll(): void

- Defined in PubSub/index.ts:167
Function to cancel all subscription(s)

Returns void

Generated using TypeDoc