Remote / foldkit-remote/why

ReadStep

interface · packages/remote/src/whyTerms.ts:321

interface ReadStep<Message> {
  readonly read: string
  readonly index: number
  readonly message: Message
  readonly from: State
  readonly to: State
  readonly why: ReadWhy
  readonly regression: boolean
}

One change of a read's tag in a history, with the Message that made it.

Members

ReadStep.read

property · packages/remote/src/whyTerms.ts:323

readonly read: string

The read's name, as timeline was given it.

ReadStep.index

property · packages/remote/src/whyTerms.ts:325

readonly index: number

The history entry it changed at, from 0.

ReadStep.message

property · packages/remote/src/whyTerms.ts:326

readonly message: Message

ReadStep.from

property · packages/remote/src/whyTerms.ts:327

readonly from: State

ReadStep.to

property · packages/remote/src/whyTerms.ts:328

readonly to: State

ReadStep.why

property · packages/remote/src/whyTerms.ts:330

readonly why: ReadWhy

why at the Model it changed to.

ReadStep.regression

property · packages/remote/src/whyTerms.ts:332

readonly regression: boolean

It showed a value and stopped, with no reason a reader can see (#234).