PushOptions.capacity
property · packages/primitives/src/state/history.ts:41
readonly capacity: numberPrimitives / foldkit-primitives/state
interface · packages/primitives/src/state/history.ts:40
interface PushOptions<Value> {
readonly capacity: number
readonly group?: string | null | undefined
readonly at?: number | undefined
readonly within?: number | undefined
readonly equals?: ((present: Value, value: Value) => boolean) | undefined
}How push records a value.
PushOptions.capacityproperty · packages/primitives/src/state/history.ts:41
readonly capacity: numberPushOptions.groupproperty · packages/primitives/src/state/history.ts:43
readonly group?: string | null | undefinedConsecutive pushes of one group are one step; none stands alone.
PushOptions.atproperty · packages/primitives/src/state/history.ts:45
readonly at?: number | undefinedWhen the push was made, in milliseconds: read for within, and kept for the next push.
PushOptions.withinproperty · packages/primitives/src/state/history.ts:51
readonly within?: number | undefinedWith at: a push joins the group's step only when it comes within this many
milliseconds of that group's previous push, so typing that pauses starts a
new step. The Model holds no clock; the caller says what time it is.
PushOptions.equalsproperty · packages/primitives/src/state/history.ts:53
readonly equals?: ((present: Value, value: Value) => boolean) | undefinedA value equal to the present records nothing: the Model comes back as it was given.