types.nope.IDataPubSubSystem

A data-based Publish and Subscribe system. Extends IPubSubSystem by providing the the methods and properties:

• 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.

Author

M.Karkowski

Export

• IPubSubSystem<AD, I, O>

  ↳ IDataPubSubSystem

• DataPubSubSystem

Readonly data: unknown

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

Author

M.Karkowski

Memberof

IPubSubSystem

Readonly emitters: Object

List all known Emitters in the System.

IPubSubSystem.emitters

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

IPubSubSystem.onIncrementalDataChange

Readonly options: IPubSubOptions

Options which describe the Behavior

Author

M.Karkowski

Memberof

IPubSubSystem

IPubSubSystem.options

Readonly publishers: IMapBasedMergeData<O, IPubSubEmitterOptions<AD>, O, string>

List containing all publishers.

Author

M.Karkowski

Memberof

IPubSubSystem

IPubSubSystem.publishers

Readonly subscriptions: IMapBasedMergeData<O, IPubSubEmitterOptions<AD>, O, string>

List, containing all subscribers.

Author

M.Karkowski

Memberof

IPubSubSystem

IPubSubSystem.subscriptions

dispose(): void

Disposes the Pub-Sub-System.

Author

M.Karkowski

Memberof

IPubSubSystem

void

IPubSubSystem.dispose

emit(path, data, options?): void

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

Author

M.Karkowski

Memberof

IPubSubSystem

void

IPubSubSystem.emit

patternBasedPush<T>(pattern, content, options): void

Pushes data to the elements, where the pattern matches.

Author

M.Karkowski

Memberof

IDataPubSubSystem

void

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

A Pattern based Pull. You can provide a mqtt based pattern and receive an array which contains all the data which matches the topic.

Author

M.Karkowski

Memberof

IPubSubSystem

{ data: T ; path: string }[]

{{ path: string, data: T }[]}

pullData<T, D>(path, _default): T

Pull some Data of System. You will allways receive a just a copy. This method prevents you to use a pattern like path. If you want to use patterns please use the "patternbasedPullData"

Author

M.Karkowski

Memberof

IPubSubSystem

T

The Expected Type

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

Function, to push data. Every subscriber will be informed, if pushing the data on the given path will affect the subscribers.

Author

M.Karkowski

Memberof

IPubSubSystem

void

register(emitter, options): O

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

O

{O}

IPubSubSystem.register

registerSubscription<T>(path, subscription): INopeObserver

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

Author

M.Karkowski

Memberof

IPubSubSystem

INopeObserver

{INopeObserver}

IPubSubSystem.registerSubscription

toDescription(): Object

Lists all publishers and subscribers of the system.

Object

IPubSubSystem.toDescription

unregister(emitter): boolean

Removes an observable of the Pub-Sub-System.

Author

M.Karkowski

Memberof

IPubSubSystem

boolean

{boolean}

IPubSubSystem.unregister

updateMatching(): void

Helper to manually Trigger an update of the Matching. This will update subscribers and publishers and link them. Normally this is not necessary.

This will build an internal linking (based on the settings) between publishers and subscribers.

Author

M.Karkowski

Memberof

IPubSubSystem

void

IPubSubSystem.updateMatching

updateOptions(emitter, options): void

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

Author

M.Karkowski

Memberof

IPubSubSystem

void

IPubSubSystem.updateOptions