Skip to content

index

13 exports Added in v4.0.0 Source

Accessors

Signature

declare function injectRegistry(): AtomRegistry;

Composables

useAtom

Added in v4.0.0 Source

Signature

declare function useAtom<R, W, Mode extends "value" | "promise" | "promiseExit" = never>(atom: () => Writable<R, W>, options?: {
  readonly mode?: [R] extends [AsyncResult<any, any>] ? Mode : "value";
}): readonly [Ref<R>, "promise" extends Mode ? (value: W) => Promise<Success<R>> : "promiseExit" extends Mode ? (value: W) => Promise<Exit<Success<R>, Failure<R>>> : (value: W | (value: R) => W) => void]

useAtomRef

Added in v4.0.0 Source

Signature

declare function useAtomRef<A>(atomRef: () => ReadonlyRef<A>): Ref<A>;

useAtomSet

Added in v4.0.0 Source

Signature

declare function useAtomSet<R, W, Mode extends "value" | "promise" | "promiseExit" = never>(atom: () => Writable<R, W>, options?: {
  readonly mode?: [R] extends [AsyncResult<any, any>] ? Mode : "value";
}): "promise" extends Mode ? (value: W, options?: {
  readonly signal?: AbortSignal;
}) => Promise<Success<R>> : "promiseExit" extends Mode ? (value: W, options?: {
  readonly signal?: AbortSignal;
}) => Promise<Exit<Success<R>, Failure<R>>> : (value: W | (value: R) => W) => void

useAtomValue

Added in v4.0.0 Source

Signature

declare function useAtomValue<A>(atom: () => Atom<A>): Ref<A>;

Constants

Signature

declare const defaultRegistry: AtomRegistry.AtomRegistry;

Re-Exports

AsyncResult

Added in v4.0.0 Source

Atom

Added in v4.0.0 Source

AtomHttpApi

Added in v4.0.0 Source

AtomRef

Added in v4.0.0 Source

AtomRegistry

Added in v4.0.0

Signature

declare const AtomRegistry: any;

AtomRpc

Added in v4.0.0 Source

Symbols

registryKey

Added in v4.0.0 Source

Signature

declare const registryKey: InjectionKey<AtomRegistry>;