Class Zeit<State, DerivedState>

constructor

• new Zeit<State, DerivedState>(initialState, compute?): Zeit<State, DerivedState>

• Type Parameters

  • State extends object

  • DerivedState

  Parameters

  • initialState: State

  • compute: ((state) => DerivedState) = ...

    • • (state): DerivedState

      • Parameters

        • state: State

        Returns DerivedState

  Returns Zeit<State, DerivedState>

Optional onCommand

Optional onPatch

Optional onRedo

Optional onReplaceHistory

Optional onReset

Optional onResetHistory

Optional onUndo

canRedo

• get canRedo(): boolean

• Returns boolean

canUndo

• get canUndo(): boolean

• Returns boolean

history

• get history(): Command<State>[]

• Returns Command<State>[]

snapshot

• get snapshot(): State

• Returns State

state

• get state(): State & DerivedState

• Returns State & DerivedState

store

• get store(): StoreApi<State & DerivedState>

• Returns StoreApi<State & DerivedState>

commit

• commit(next, _prev, _patch, _id?): State

• 在正式更新状态之前执行最后的修改。

  默认的实现是直接返回了 merge(next, patchState) 的结果，也就是没有做任何修 改。在扩展 Zeit 类时重写这个方法来实现自定义的修改或者其他副作用（side effects），比如说日志，调试等等。请注意，此方法内执行的修改是无法撤销的。

  Parameters

  • next: State

  • _prev: State

  • _patch: Partial<{
        [P in string | number | symbol]: Partial<({ [P in keyof State[P]]: Partial<{ [P in keyof State[P][P]]: Partial<{ [P in keyof State[P][P][P]]: Partial<{ [P in keyof State[P][P][P][P]]: Partial<{ [P in keyof State[P][P][P][P][P]]: Partial<{ [P in keyof State[P][P][P][P][P][P]]: Partial<...>; }>; }>; }>; }>; }>; })>
    }>

  • Optional _id: string

  Returns State

execute

• execute(command, id?): Zeit<State, DerivedState>

• Parameters

  • command: Command<State>

  • id: undefined | string = command.id

  Returns Zeit<State, DerivedState>

forceUpdate

• forceUpdate(): void

• Returns void

Optional onStateDidChange

• onStateDidChange(state, id?): void

• Parameters

  • state: State

  • Optional id: string

  Returns void

Optional onStateWillChange

• onStateWillChange(state, id?): void

• Parameters

  • state: State

  • Optional id: string

  Returns void

patch

• patch(patchState): Zeit<State, DerivedState>

• Parameters

  • patchState: Partial<{
        [P in string | number | symbol]: Partial<({ [P in keyof State[P]]: Partial<{ [P in keyof State[P][P]]: Partial<{ [P in keyof State[P][P][P]]: Partial<{ [P in keyof State[P][P][P][P]]: Partial<{ [P in keyof State[P][P][P][P][P]]: Partial<{ [P in keyof State[P][P][P][P][P][P]]: Partial<...>; }>; }>; }>; }>; }>; })>
    }>

  Returns Zeit<State, DerivedState>

redo

• redo(): Zeit<State, DerivedState>

• Returns Zeit<State, DerivedState>

replace

• replace(state): Zeit<State, DerivedState>

• Parameters

  • state: State

  Returns Zeit<State, DerivedState>

replaceHistory

• replaceHistory(history, cursor?): Zeit<State, DerivedState>

• Parameters

  • history: Command<State>[]

  • cursor: number = ...

  Returns Zeit<State, DerivedState>

reset

• reset(): Zeit<State, DerivedState>

• Returns Zeit<State, DerivedState>

resetHistory

• resetHistory(): Zeit<State, DerivedState>

• Returns Zeit<State, DerivedState>

saveSnapshot

• saveSnapshot(): Zeit<State, DerivedState>

• Returns Zeit<State, DerivedState>

shallowExecute

• shallowExecute(command, id?): Zeit<State, DerivedState>

• Parameters

  • command: Command<State>

  • id: undefined | string = command.id

  Returns Zeit<State, DerivedState>

shallowPatch

• shallowPatch(patchState): Zeit<State, DerivedState>

• Parameters

  • patchState: Partial<{
        [P in string | number | symbol]: Partial<({ [P in keyof State[P]]: Partial<{ [P in keyof State[P][P]]: Partial<{ [P in keyof State[P][P][P]]: Partial<{ [P in keyof State[P][P][P][P]]: Partial<{ [P in keyof State[P][P][P][P][P]]: Partial<{ [P in keyof State[P][P][P][P][P][P]]: Partial<...>; }>; }>; }>; }>; }>; })>
    }>

  Returns Zeit<State, DerivedState>

undo

• undo(): Zeit<State, DerivedState>

• Returns Zeit<State, DerivedState>