Class CanonicalState<State>

constructor

• new CanonicalState<State extends StateValue>(
      initial: State,
      options?: {
          extensions?: StateRegistry;
          migrations?: Readonly<Record<number, (state: StateValue) => State>>;
          version?: number;
      },
  ): CanonicalState<State>

  Type Parameters

  • State extends StateValue

  Parameters

  • initial: State
  • options: {
        extensions?: StateRegistry;
        migrations?: Readonly<Record<number, (state: StateValue) => State>>;
        version?: number;
    } = {}

  Returns CanonicalState<State>

Readonlyextensions

state

• get state(): State

  Returns State

restore

• restore(
      snapshot: CanonicalStateSnapshot<State>,
      options?:
          | {
              missing?: "reset"
              | "keep"
              | "remove";
              onDiagnostic?: (diagnostic: StateRestoreDiagnostic) => void;
          }
          | undefined,
  ): readonly StateRestoreDiagnostic[]

  Parameters

  • snapshot: CanonicalStateSnapshot<State>
  • options:
        | {
            missing?: "reset"
            | "keep"
            | "remove";
            onDiagnostic?: (diagnostic: StateRestoreDiagnostic) => void;
        }
        | undefined = {}

  Returns readonly StateRestoreDiagnostic[]

set

• set(next: State): void

  Parameters

  • next: State

  Returns void

snapshot

• snapshot(): CanonicalStateSnapshot<State>

  Returns CanonicalStateSnapshot<State>

transaction

• transaction<T>(work: (state: CanonicalState<State>) => T): T

  Type Parameters

  • T

  Parameters

  • work: (state: CanonicalState<State>) => T

  Returns T

update

• update(transform: (current: State) => State): State

  Parameters

  • transform: (current: State) => State

  Returns State