API Docs for:
Show:

Utils.Mediator Class

Defined in: development/js/utils/mediator.js:5
Module: Utils

Mediator utility

Methods

publish

(
  • topic
  • True
)

Defined in development/js/utils/mediator.js:112

Allows to push/publish data over a channel to connected listeners

Parameters:

  • topic String

    Topic or channel to publish into

  • True Boolean

    if the topic exists

Example:

import mediator from './utils/mediator';

mediator.subscribe('some-channel', (data) => {
    console.log(data);
});

// ... later in code ...

mediator.publish('some-channel', 1); // -> logs "1" into the console

subscribe

(
  • topic
  • handler
  • [scope = undefined]
)
String

Defined in development/js/utils/mediator.js:35

Subscribes a listener to a (optionally new) topic/channel on the mediator. Optionally accepts a third argument which defines the scope the listener is called upon (e. g. where "this" points to)

Parameters:

  • topic String

    Topic or channel to subscribe to

  • handler Function

    The listener function to call on activation

  • [scope = undefined] Any optional

    Optional scope for the handler function

Returns:

String:

Identifier key to use when unsubscribing

Example:

import mediator from './utils/mediator';

const someChannelID = mediator.subscribe('some-channel', (data) => {
    console.log(data);
});

unsubscribe

(
  • identifier
  • True
)

Defined in development/js/utils/mediator.js:76

Removes a previously made subscription

Parameters:

  • identifier String

    Identifier key of channel to unsubscribe from

  • True Boolean

    on success

Example:

import mediator from './utils/mediator';

const someChannelID = mediator.subscribe('some-channel', (data) => {
    console.log(data);
});

// ... later in code ...

mediator.unsubscribe(someChannelID);

unsubscribeAll

() Undefined

Defined in development/js/utils/mediator.js:18

Unsubscribes all listeners from all channels

Returns:

Undefined:

Example:

import mediator from './utils/mediator';

mediator.unsubscribeAll();