pubSub.DataPubSubSystem

Default implementation of IDataPubSubSystem

Extends the PubSubSystem by adding the following properties and methods:

• pushData to push data into the system.
• pullData to pull data from the system. Will allways return the current data or the default value if no data is present at the given path.
• patternbasedPullData to pull data with a given pattern. See the example for details.
• patternBasedPush to push data with a given pattern into the system.
• If you want to acces the root data please check the property data which will contain the entire data root that has been created.

• PubSubSystem<ITopicSetContentOptions, INopeObservable, INopeTopicWithDirectAccess>

  ↳ DataPubSubSystem

• IDataPubSubSystem

new DataPubSubSystem(options?)

PubSubSystem.constructor

_options: IPubSubOptions

PubSubSystem._options

Readonly onIncrementalDataChange: INopeEventEmitter<IIncrementalChange, IIncrementalChange, IIncrementalChange, IEventAdditionalData>

An observable which holds the incremental data change. this will be triggered, if the an emitter (publisher) changes its data. Contains only the last emitted data and the topic

// Describe the required Test:
let pubSubSystem = new PubSubSystemBase({
  generateEmitterType: function () {
    return new NopeEventEmitter() as INopeEventEmitter;
  },
});

// Create a Publisher for the system:
let publisher: INopeEventEmitter = new NopeEventEmitter();

pubSubSystem.register(publisher, {
  mode: "publish",
  schema: {},
  topic: "this/is/a/test",
});

pubSubSystem.onIncrementalDataChange.subscribe(console.log);
publisher.emit("Hello World!"); // Logs the following => {path: "this/is/a/test", data: "Hello World!"}

Author

M.Karkowski

Memberof

IPubSubSystem

IDataPubSubSystem.onIncrementalDataChange

PubSubSystem.onIncrementalDataChange

Readonly publishers: IMapBasedMergeData<INopeTopicWithDirectAccess<any, any, any>, IPubSubEmitterOptions<ITopicSetContentOptions>, INopeTopicWithDirectAccess<any, any, any>, string>

List containing all publishers.

Author

M.Karkowski

Memberof

IPubSubSystem

IDataPubSubSystem.publishers

PubSubSystem.publishers

Readonly subscriptions: IMapBasedMergeData<INopeTopicWithDirectAccess<any, any, any>, IPubSubEmitterOptions<ITopicSetContentOptions>, INopeTopicWithDirectAccess<any, any, any>, string>

List, containing all subscribers.

Author

M.Karkowski

Memberof

IPubSubSystem

IDataPubSubSystem.subscriptions

PubSubSystem.subscriptions

get data(): unknown

A Getter to return a COPY of the item. Outside of the system, you'll never receive the original object. It is allways a clone.

Author

M.Karkowski

Memberof

PubSubSystemBase

unknown

IDataPubSubSystem.data

get emitters(): Object

List all known Emitters in the System.

Object

IDataPubSubSystem.emitters

PubSubSystemBase.emitters

get options(): IPubSubOptions

Options which describe the Behavior

Author

M.Karkowski

Memberof

IPubSubSystem

IPubSubOptions

IDataPubSubSystem.options

PubSubSystemBase.options

dispose(): void

Unregisters all Emitters and removes all subscriptions of the "onIncrementalDataChange", "publishers" and "subscriptions"

Author

M.Karkowski

Memberof

PubSubSystemBase

void

IDataPubSubSystem.dispose

PubSubSystem.dispose

emit(eventName, data, options?): void

Emits an Events and all subscribes, where the pattern matches will be informed

Author

M.Karkowski

Memberof

IPubSubSystem

void

IDataPubSubSystem.emit

PubSubSystem.emit

patternBasedPush<T>(pattern, data, options?, fast?): void

Option to push data to the system using a pattern see patternBasedPush @ IDataPubSubSystem

void

Nothing

IDataPubSubSystem.patternBasedPush

patternbasedPullData<T, D>(pattern, _default?): { data: T ; path: string }[]

Option to pull data from the system with a pattern see patternbasedPullData @ IDataPubSubSystem

{ data: T ; path: string }[]

IDataPubSubSystem.patternbasedPullData

pullData<T, D>(topic, _default?): T

Option to pull data from the system see pullData @ IDataPubSubSystem

T

The data. Defined as T

IDataPubSubSystem.pullData

pushData<T>(path, content, options?): void

Option to push data into the system see pushData @ IDataPubSubSystem

void

nothing.

IDataPubSubSystem.pushData

register(emitter, options): INopeTopicWithDirectAccess<any, any, any>

Function to register an Observable. Please define the Options, to decide whether the data of the observable should be published or subscribed.

Author

M.Karkowski

Memberof

IPubSubSystem

INopeTopicWithDirectAccess<any, any, any>

{O}

IDataPubSubSystem.register

PubSubSystem.register

registerSubscription<T>(topic, subscription): INopeObserver

A Helper, that allows the user to subscribe to changes. Therfore he must transmit

Author

M.Karkowski

Memberof

IPubSubSystem

INopeObserver

{INopeObserver}

IDataPubSubSystem.registerSubscription

PubSubSystem.registerSubscription

toDescription(): Object

Describes the Data.

Object

IDataPubSubSystem.toDescription

PubSubSystem.toDescription

unregister(emitter): boolean

Removes an observable of the Pub-Sub-System.

Author

M.Karkowski

Memberof

IPubSubSystem

boolean

{boolean}

IDataPubSubSystem.unregister

PubSubSystem.unregister

updateMatching(): void

Internal Match-Making Algorithm. This allowes to Create a predefined List between Publishers and Subscribers. Thereby the Process is speed up, by utilizing this Look-Up-Table

Author

M.Karkowski

Memberof

PubSubSystemBase

void

IDataPubSubSystem.updateMatching

PubSubSystem.updateMatching

updateOptions(emitter, options): void

Function to update the options and there by the topics of an observable.

Author

M.Karkowski

Memberof

IPubSubSystem

void

IDataPubSubSystem.updateOptions

PubSubSystem.updateOptions