index.ts

index.ts overview

Since v4.0.0

---

Exports Grouped by Category

• composables
  • useAtom
  • useAtomRef
  • useAtomSet
  • useAtomValue
• modules
  • AsyncResult (namespace export)
  • Atom (namespace export)
  • AtomRef (namespace export)
  • AtomRegistry (namespace export)
  • AtomRpc (namespace export)
• re-exports
  • AtomHttpApi (namespace export)
• registry
  • defaultRegistry
  • injectRegistry
  • registryKey

---

composables

useAtom

Signature

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

Source

Since v4.0.0

useAtomRef

Signature

declare const useAtomRef: <A>(atomRef: () => AtomRef.ReadonlyRef<A>) => Readonly<Ref<A>>

Source

Since v4.0.0

useAtomSet

Signature

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

Source

Since v4.0.0

useAtomValue

Signature

declare const useAtomValue: <A>(atom: () => Atom.Atom<A>) => Readonly<Ref<A>>

Source

Since v4.0.0

modules

AsyncResult (namespace export)

Re-exports all named exports from the “effect/unstable/reactivity/AsyncResult” module as AsyncResult.

Signature

export * as AsyncResult from "effect/unstable/reactivity/AsyncResult"

Source

Since v4.0.0

Atom (namespace export)

Re-exports all named exports from the “effect/unstable/reactivity/Atom” module as Atom.

Signature

export * as Atom from "effect/unstable/reactivity/Atom"

Source

Since v4.0.0

AtomRef (namespace export)

Re-exports all named exports from the “effect/unstable/reactivity/AtomRef” module as AtomRef.

Signature

export * as AtomRef from "effect/unstable/reactivity/AtomRef"

Source

Since v4.0.0

AtomRegistry (namespace export)

Re-exports all named exports from the “effect/unstable/reactivity/AtomRegistry” module as AtomRegistry.

Signature

export * as AtomRegistry from "effect/unstable/reactivity/AtomRegistry"

Source

Since v4.0.0

AtomRpc (namespace export)

Re-exports all named exports from the “effect/unstable/reactivity/AtomRpc” module as AtomRpc.

Signature

export * as AtomRpc from "effect/unstable/reactivity/AtomRpc"

Source

Since v4.0.0

re-exports

AtomHttpApi (namespace export)

Re-exports all named exports from the “effect/unstable/reactivity/AtomHttpApi” module as AtomHttpApi.

Signature

export * as AtomHttpApi from "effect/unstable/reactivity/AtomHttpApi"

Source

Since v4.0.0

registry

defaultRegistry

Signature

declare const defaultRegistry: AtomRegistry.AtomRegistry

Source

Since v4.0.0

injectRegistry

Signature

declare const injectRegistry: () => AtomRegistry.AtomRegistry

Source

Since v4.0.0

registryKey

Signature

declare const registryKey: InjectionKey<AtomRegistry.AtomRegistry>

Source

Since v4.0.0