Skip to main content Link Search Menu Expand Document (external link)

ScopedAtom overview

Added in v1.0.0


Table of contents


Type IDs

TypeId

Signature

export declare const TypeId: "~@effect-atom/atom-react/ScopedAtom"

Added in v1.0.0

TypeId (type alias)

Signature

export type TypeId = "~@effect-atom/atom-react/ScopedAtom"

Added in v1.0.0

constructors

make

Signature

export declare const make: <A extends Atom.Atom<any>, Input = never>(
  f: (() => A) | ((input: Input) => A)
) => ScopedAtom<A, Input>

Added in v1.0.0

models

ScopedAtom (interface)

Signature

export interface ScopedAtom<A extends Atom.Atom<any>, Input = never> {
  readonly [TypeId]: TypeId
  use(): A
  Provider: Input extends never
    ? React.FC<{ readonly children?: React.ReactNode | undefined }>
    : React.FC<{ readonly children?: React.ReactNode | undefined; readonly value: Input }>
  Context: React.Context<A>
}

Added in v1.0.0