import { AnyAtomInstance, AnyAtomTemplate, AtomParamsType, AtomStateType, ParamlessTemplate } from '@zedux/atoms'; import { ZeduxHookConfig } from '../types'; /** * 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 the current state of the resolved atom instance. * * The 3rd param is a `config` object which can be given `operation` and * `suspend` fields: * * ```ts * const state = useAtomValue(myAtom, [], { * operation: 'myUsageDescription', // helps with debugging * suspend: false, // disable React suspense if the atom set a promise * }) * ``` */ export declare const useAtomValue: { (template: A, params: AtomParamsType, config?: Omit): AtomStateType; >(template: A): AtomStateType; (template: ParamlessTemplate): AtomStateType; (instance: I, params?: [], config?: Omit): AtomStateType; };