Skip to main content

register

register([ { state, middleware, priority } ], storeId)

Register initial state with a store.

ParameterDescription
stateFunction or object that represents the state to register
middlewareFunction that acts as middleware wrapped around an action
priorityState is registered in a undeterministic order unless a priority is specified. Higher priority state is registered first.
storeIdThe name of the store to register state in.

Registering state:

The set function is used to change state and the get function to retrieve state.

FunctionDescription
set(state => {},type)Calls a function that mutates the passed state. Optionally specify a string type to display when viewing state changes in Dev Tools.
get(state => {})Calls a function that queries the passed state and returns the result.
import { register } from "carry-on-store";

const state = ({ get, set }) => ({
field: "value",
change(val) {
set(state => {
state.field = val;
}, "Change Value");
},
isIt(val) {
return get(({ field }) => field === val);
}
});

// register one state
register({ state });

// register multiple states
register([{ state }, { state }, { state }]);

// register state into a named store
register({ state }, "store1");

// can also specify the storeId first
register("store1", { state });