PubSub

PubSub - is a main Symbiote.js entity to manipulate application data. It implements simple and well known Publication-subscribe pattern and represents all you need to organize data-flow inside your components and outside of them. It is integrated to the Symbiote base class, but also can be used separately:

import { PubSub } from '@symbiotejs/symbiote';

let myDataCtx = PubSub.registerCtx({
  myProp: 'some value',
  myOtherProp: 'some other value',
});

Static methods

PubSub.registerCtx()

Use to create and register the PubSub instance.

Syntax:

registerCtx(schema)
registerCtx(schema, id)

// > PubSub instance

Example:

let myDataCtx = PubSub.registerCtx({
  myProp: 'some value',
  myOtherProp: 'some other value',
}, 'MY_CTX_ID');

PubSub.getCtx()

Use to get PubSub object from registry.

Syntax:

getCtx(id)

// > PubSub instance

Example:

let myDataCtx = PubSub.getCtx('MY_CTX_ID');

PubSub.deleteCtx()

Use to remove PubSub object from the registry and to clear memory.

Syntax:

deleteCtx(id)

Example:

PubSub.deleteCtx('MY_CTX_ID');

Instance methods

pub()

Use to publish new the new property value.

Syntax:

pub(propertyKey, newValue)

Example:

myDataCtx.pub('propertyName', 'newValue');

multiPub()

Use to publish multiple changes at once.

Syntax:

multiPub(propertyMap)

Example:

myDataCtx.multiPub({
  propertyName: 'new value',
  otherPropertyName: 'other new value',
});

sub()

Use to subscribe on property changes.

Syntax:

sub(propertyName, handler)

Example:

myDataCtx.sub('propertyName', (newValue) => {
  console.log(newValue);
});

read()

Use to read the property value.

Syntax:

read(propertyName)

// > *

Example:

myDataCtx.read('propertyName');

has()

Use to check that property exists.

Syntax:

has(propertyName)

// > true / false

Example:

myDataCtx.has('propertyName');

add()

Use to add a new property into the existing PubSub object.

Syntax:

add(propertyName, initValue)

Example:

myDataCtx.add('propertyName', 'init value');

notify()

Use for the manual invocation of the all subscription handlers for the property.

Syntax:

notify(propertyName)

Example:

myDataCtx.notify('propertyName');