import { Atom, Actions } from 'xoid';

/**
 * An atom, or a function returning an atom can be passed as the first argument.
 * When the second optional argument is set to `true`, it will also consume the actions of the atom.
 * @see [xoid.dev/docs/framework-integrations/use-atom](https://xoid.dev/docs/framework-integrations/use-atom)
 */
declare function useAtom<T>(atom: Atom<T>): T;
declare function useAtom<T>(atom: () => Atom<T>): T;
declare function useAtom<T, U>(atom: Atom<T> & Actions<U>, withActions: true): [T, U];
declare function useAtom<T, U>(atom: () => Atom<T> & Actions<U>, withActions: true): [T, U];

export { useAtom };