Class MutableSnapshot

Hierarchy (view full)

Constructors

constructor

Properties

reset set

Methods

asyncMap getID getInfo_UNSTABLE getLoadable getNodes_UNSTABLE getPromise isRetained map retain

Constructors

constructor

Properties

reset

reset: ResetRecoilState

set

set: SetRecoilState

Methods

asyncMap

  • asyncMap(cb): Promise<Snapshot>

  • Parameters

    • cb: ((mutableSnapshot) => Promise<void>)
        • (mutableSnapshot): Promise<void>

        • Parameters

          Returns Promise<void>

    Returns Promise<Snapshot>

getID

  • getID(): SnapshotID

  • Returns SnapshotID

getInfo_UNSTABLE

  • getInfo_UNSTABLE<T>(recoilValue): RecoilStateInfo<T>

  • Type Parameters

    • T

    Parameters

    Returns RecoilStateInfo<T>

getLoadable

  • getLoadable<T>(recoilValue): Loadable<T>

  • Type Parameters

    • T

    Parameters

    Returns Loadable<T>

getNodes_UNSTABLE

  • getNodes_UNSTABLE(opts?): Iterable<RecoilValue<unknown>>

  • Parameters

    • Optional opts: {
          isInitialized?: boolean;
          isModified?: boolean;
      }
      • Optional isInitialized?: boolean
      • Optional isModified?: boolean

    Returns Iterable<RecoilValue<unknown>>

getPromise

  • getPromise<T>(recoilValue): Promise<T>

  • Type Parameters

    • T

    Parameters

    Returns Promise<T>

isRetained

  • isRetained(): boolean

  • Returns boolean

map

  • map(cb): Snapshot

  • Parameters

    • cb: ((mutableSnapshot) => void)
        • (mutableSnapshot): void

        • Parameters

          Returns void

    Returns Snapshot

retain

  • retain(): (() => void)

  • Returns (() => void)

      • (): void

      • Returns void

Settings

Member Visibility

Theme

On This Page

constructorresetsetasyncMapgetIDgetInfo_UNSTABLEgetLoadablegetNodes_UNSTABLEgetPromiseisRetainedmapretain