Remote / foldkit-remote/testing

WalkOptions

interface · packages/remote/src/walk.ts:41

interface WalkOptions<Model, Message> {
  readonly cases: ReadonlyArray<WalkCase<Model, Message>>
  readonly from: ReadonlyArray<Start<Model>>
  readonly step: (model: Model, message: Message) => Model | Promise<Model>
  readonly violations: (
    before: Model,
    message: Message,
    after: Model,
  ) => ReadonlyArray<Violation>
  readonly laws: ReadonlyArray<string>
  readonly transition?: (tag: string) => string
  readonly seeds: number
  readonly steps: number
  readonly regressions?: ReadonlyArray<{
    readonly name: string
    readonly from: () => Model
    readonly case: (model: Model) => Message
  }>
}

Members

WalkOptions.cases

property · packages/remote/src/walk.ts:42

readonly cases: ReadonlyArray<WalkCase<Model, Message>>

WalkOptions.from

property · packages/remote/src/walk.ts:43

readonly from: ReadonlyArray<Start<Model>>

WalkOptions.step

property · packages/remote/src/walk.ts:45

readonly step: (model: Model, message: Message) => Model | Promise<Model>

May answer later: a walk of declared writes goes through the writer.

WalkOptions.violations

property · packages/remote/src/walk.ts:46

readonly violations: (
  before: Model,
  message: Message,
  after: Model,
) => ReadonlyArray<Violation>

WalkOptions.laws

property · packages/remote/src/walk.ts:53

readonly laws: ReadonlyArray<string>

Every law violations judges: a walk with no failure is evidence for each. A violation naming another law throws, but nothing can tell that violations checks a listed law at all: one it never checks still gets Walked records, on the author's word.

WalkOptions.transition

property · packages/remote/src/walk.ts:55

readonly transition?: (tag: string) => string

A drawn case's transition id in evidence, such as write:Sell for Sell; its tag by default.

WalkOptions.seeds

property · packages/remote/src/walk.ts:57

readonly seeds: number

Walks of seeds 1..seeds from each start, each steps long.

WalkOptions.steps

property · packages/remote/src/walk.ts:58

readonly steps: number

WalkOptions.regressions

property · packages/remote/src/walk.ts:60

readonly regressions?: ReadonlyArray<{
  readonly name: string
  readonly from: () => Model
  readonly case: (model: Model) => Message
}>

Single Messages that once broke a law, each from a start of its own, run first.