Skip to main content

subscribe

subscribe(callback,watch, storeId)

Subscribe to state changes. Returns a function that will unsubscribe.

ParameterDescription
callbackFunction to call when state changes.
watchOptional object representing state keys to subscribe to
storeIdThe name of the store to subscribe to.

Subscribe to all changes

Only specifying the callback will subscribe to all state changes.

import { subscribe } from "carry-on-store";

const stateChanged = (state, changes) => {
console.log("state changed", state, changes);
};

subscribe(stateChanged);

Subscribe to some changes

Specifying the watch parameter allows you to control what state changes will execute the callback function.

In this example, any changes to the fields field1, nested, and nested.field will cause the callback function to execute.

import { subscribe } from "carry-on-store";

const stateChanged = (state, changes) => {
console.log("state changed", state, changes);
};

const watches = {
field1: true,
nested: {
field: true
}
};

subscribe(stateChanged, watches);