@zedux/react
Version:
A Molecular State Engine for React
43 lines (42 loc) • 1.72 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.useAtomState = void 0;
const useAtomInstance_1 = require("./useAtomInstance");
/**
* Creates an atom instance for the passed atom template based on the passed
* params. If an instance has already been created for the passed params, reuses
* the existing instance.
*
* Registers a dynamic graph dependency on the atom instance. This means
* components that use this hook will rerender when the resolved atom instance's
* state changes.
*
* Also accepts an atom instance and subscribes to updates in the passed
* instance.
*
* If the atom doesn't take params or an instance is passed, pass an empty array
* for the 2nd param when you need to supply the 3rd `config` param.
*
* Returns a [state, setState] tuple. The `setState` function is
* "export-infused", meaning it has all of the atom instance's `exports`
* attached directly to the function. These can be destructured for convenience:
*
* ```ts
* const [state, { decrement, increment }] = useAtomState(myCounterAtom)
* ```
*
* The 3rd param is a `config` object which can be given `operation` and
* `suspend` fields:
*
* ```ts
* const [state, setState] = useAtomState(myAtom, [], {
* operation: 'myUsageDescription', // helps with debugging
* suspend: false, // disable React suspense if the atom set a promise
* })
* ```
*/
const useAtomState = (atom, params, config = { operation: 'useAtomState' }) => {
const instance = (0, useAtomInstance_1.useAtomInstance)(atom, params, Object.assign(Object.assign({}, config), { subscribe: true }));
return [instance.getState(), instance._infusedSetter];
};
exports.useAtomState = useAtomState;