@nuskin/events

@nuskin/events

"This is a replacement for the pub/sub functionality that has been used from nuskinjquery. It includes the same functionality as what was there and the main use of this is in @nuskin/ns-util - events.js where nuskinjquery was used."

Installing

Usng npm:

npm add @nuskin/events

Usng yarn:

yarn add @nuskin/events

Example usage

const {
    subscribe,
    publish,
    unsubscribe,
    getValue,
    setValue,
} = require('@nuskin/events');


// Publishes value to listeners on the eventId event.
// value is optional and if not specified it will come through
// as true to the listeners.
//
// If an array is being passed into value then it needs to be
// surrounded by []. The code uses the first element of the array
// to publish to the listeners.
publish(eventId, value);

const testCallback = (value) => {
  // do something with value
};

// sets up the testCallback function to listen on
subscribe(eventId, testCallback);

// This will take the testCallback function off of the eventId listeners.
unsubscribe(eventId, testCallback);

// This will set a value in state to be retrieved by getValue.
// This will also publish value to listeners on eventId.
setValue(eventId, value);

// This will call testCallback with the current value set in start by setValue.
// The third parameter is default to false. If it is set to true then it will
// also subscribe to future values publish/setValue to listeners on eventId
getValue(eventId, testCallback, true);

Resources

License

MIT