Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • State

Index

Constructors

Properties

_inUpdate: any
_revertibleTreeUpdate: any
_tree: any
_updateTree: any
addHistory: any
behaviors: { currentObject: BehaviorSubject<<internal>.State.ObjectEvent>; isUpdating: BehaviorSubject<boolean> }

Type declaration

cells: Cells
clearHistory: any
errorFree: boolean
ev: any
events: { cell: { created: Subject<<internal>.State.ObjectEvent & { cell: StateObjectCell<StateObject<any, <internal>.StateObject.Type<any>>, <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>> }>; removed: Subject<<internal>.State.ObjectEvent & { parent: string }>; stateUpdated: Subject<<internal>.State.ObjectEvent & { cell: StateObjectCell<StateObject<any, <internal>.StateObject.Type<any>>, <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>> }> }; changed: Subject<{ inTransaction: boolean; state: <internal>.State }>; historyUpdated: Subject<{ state: <internal>.State }>; log: Subject<LogEntry>; object: { created: Subject<<internal>.State.ObjectEvent & { obj: StateObject<any, <internal>.StateObject.Type<any>> }>; removed: Subject<<internal>.State.ObjectEvent & { obj?: StateObject<any, <internal>.StateObject.Type<any>> }>; updated: Subject<<internal>.State.ObjectEvent & { action: "in-place" | "recreate"; obj: StateObject<any, <internal>.StateObject.Type<any>>; oldData?: any; oldObj?: StateObject<any, <internal>.StateObject.Type<any>> }> } }

Type declaration

globalContext: unknown
history: any
historyCapacity: any
inTransaction: any
inTransactionError: any
reverted: any
runTask: <T>(task: Task<T>) => Promise<T>

Type declaration

    • <T>(task: Task<T>): Promise<T>
    • Type parameters

      • T

      Parameters

      Returns Promise<T>

spine: any
tryGetCellData: <T>(ref: string) => T

Type declaration

undoingHistory: any
updateQueue: any
updateTreeAndCreateCtx: any

Accessors

  • get canUndo(): boolean
  • Returns boolean

  • get current(): string
  • Returns string

  • get inUpdate(): boolean
  • Determines whether the state is currently "inside" updateTree function. This is different from "isUpdating" which wraps entire transactions.

    Returns boolean

  • get latestUndoLabel(): undefined | string
  • Returns undefined | string

  • Returns Transforms

  • Returns StateTree

Methods

  • Returns <internal>.Root

  • dispose(): void
  • Returns void

  • setCurrent(ref: string): void
  • Parameters

    • ref: string

    Returns void

  • transaction(edits: (ctx: RuntimeContext) => void | Promise<void>, options?: { canUndo?: string | boolean; rethrowErrors?: boolean }): Task<void>
  • Apply series of updates to the state. If any of them fail, revert to the original state.

    Parameters

    • edits: (ctx: RuntimeContext) => void | Promise<void>
    • Optional options: { canUndo?: string | boolean; rethrowErrors?: boolean }
      • Optional canUndo?: string | boolean
      • Optional rethrowErrors?: boolean

    Returns Task<void>

  • Returns Task<void>

Generated using TypeDoc