useAtom | /src/react/useAtom.ts | jotai@v2.8.4

function useAtom

import { useAtom } from "https://deno.land/x/jotai@v2.8.4/src/react/useAtom.ts";

useAtom<Value, Args extends unknown[], Result>(atom: WritableAtom<Value, Args, Result>, options?: Options): [Awaited<Value>, SetAtom<Args, Result>]

useAtom<Value>(atom: PrimitiveAtom<Value>, options?: Options): [Awaited<Value>, SetAtom<[SetStateAction<Value>], void>]

useAtom<Value>(atom: Atom<Value>, options?: Options): [Awaited<Value>, never]

useAtom<AtomType extends WritableAtom<unknown, never[], unknown>>(atom: AtomType, options?: Options): [Awaited<ExtractAtomValue<AtomType>>, SetAtom<ExtractAtomArgs<AtomType>, ExtractAtomResult<AtomType>>]

useAtom<AtomType extends Atom<unknown>>(atom: AtomType, options?: Options): [Awaited<ExtractAtomValue<AtomType>>, never]

Type Parameters

Value

Args extends unknown[]

Result

optional

options: Options

[Awaited<Value>, SetAtom<Args, Result>]

Value

optional

options: Options

[Awaited<Value>, SetAtom<[SetStateAction<Value>], void>]

Value

optional

options: Options

[Awaited<Value>, never]

AtomType extends WritableAtom<unknown, never[], unknown>

optional

options: Options

AtomType extends Atom<unknown>

optional

options: Options