@usine/core/run/state

Classes

Canceled

Canceled, with the reason recorded.

Extends

• Schema.Class

Constructors

Constructor

new Canceled(…args): Canceled

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

Canceled

Properties

reason

readonly reason: OperatorCanceled | Superseded | Revoked

---

Failed

The last attempt failed and no auto-retry applies. The failure is on the Attempt, and retry reopens the run.

Extends

• Schema.Class

Constructors

Constructor

new Failed(…args): Failed

Parameters

Parameter	Type
…args	[props?: object, options?: MakeOptions]

Returns

Failed

---

OperatorCanceled

The operator closed the run by hand.

Extends

• Schema.Class

Constructors

Constructor

new OperatorCanceled(…args): OperatorCanceled

Parameters

Parameter	Type
…args	[props?: object, options?: MakeOptions]

Returns

OperatorCanceled

---

Pending

Just created: no attempt started and no approval gate passed.

Extends

• Schema.Class

Constructors

Constructor

new Pending(…args): Pending

Parameters

Parameter	Type
…args	[props?: object, options?: MakeOptions]

Returns

Pending

---

Queued

Approved and waiting for a worker slot.

Extends

• Schema.Class

Constructors

Constructor

new Queued(…args): Queued

Parameters

Parameter	Type
…args	[props?: object, options?: MakeOptions]

Returns

Queued

---

Revoked

The run’s Item stopped matching its loop’s trigger before any attempt started.

Extends

• Schema.Class

Constructors

Constructor

new Revoked(…args): Revoked

Parameters

Parameter	Type
…args	[props?: object, options?: MakeOptions]

Returns

Revoked

---

Running

An attempt is executing on a worker.

Extends

• Schema.Class

Constructors

Constructor

new Running(…args): Running

Parameters

Parameter	Type
…args	[props?: object, options?: MakeOptions]

Returns

Running

---

Succeeded

The step finished and its result is stored.

Extends

• Schema.Class

Constructors

Constructor

new Succeeded(…args): Succeeded

Parameters

Parameter	Type
…args	[props?: object, options?: MakeOptions]

Returns

Succeeded

---

Superseded

A newer Event for the same Item took the run’s place before any attempt started.

Extends

• Schema.Class

Constructors

Constructor

new Superseded(…args): Superseded

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

Superseded

Properties

by

readonly by: string & Brand<"EventId">

---

Waiting

Parked on the loop’s approval gate. The approval it waits for is an Event like any other fact.

Extends

• Schema.Class

Constructors

Constructor

new Waiting(…args): Waiting

Parameters

Parameter	Type
…args	[props?: object, options?: MakeOptions]

Returns

Waiting

Type Aliases

CancelReason

CancelReason = typeof CancelReason.Type

---

Open

Open = typeof Open.Type

Runs that still owe work, including those waiting for approval or a Worker.

---

RunState

RunState = typeof RunState.Type

A Run’s progress from creation through approval and execution to a recorded outcome.

---

Startable

Startable = typeof Startable.Type

The states an attempt can start from: the gate is passed or absent.

---

Unstarted

Unstarted = typeof Unstarted.Type

The states with no attempt started: what supersede and revoke accept.

Variables

approve

const approve: (_state) => Queued

Returns the approved state; the Run still waits for a Worker slot before execution.

Parameters

Parameter	Type
_state	Waiting

Returns

Queued

---

awaitApproval

const awaitApproval: (_state) => Waiting

Parks a pending run on its loop’s approval gate.

Parameters

Parameter	Type
_state	Pending

Returns

Waiting

---

cancelByOperator

const cancelByOperator: (_state) => Canceled

Cancels from any open state.

Parameters

Parameter	Type
_state	Open

Returns

Canceled

---

CancelReason

const CancelReason: Schema.Union<readonly [typeof OperatorCanceled, typeof Superseded, typeof Revoked]>

---

fail

const fail: (_state) => Failed

Closes the run after a failed attempt when no auto-retry applies; shouldAutoRetry decides that.

Parameters

Parameter	Type
_state	Running

Returns

Failed

---

isOpen

const isOpen: <I>(input) => input is I & (Pending | Queued | Running | Waiting)

Type Parameters

Type Parameter
I

Parameters

Parameter	Type
input	I

Returns

input is I & (Pending | Queued | Running | Waiting)

---

isStartable

const isStartable: <I>(input) => input is I & (Pending | Queued)

Type Parameters

Type Parameter
I

Parameters

Parameter	Type
input	I

Returns

input is I & (Pending | Queued)

---

isUnstarted

const isUnstarted: <I>(input) => input is I & (Pending | Queued | Waiting)

Type Parameters

Type Parameter
I

Parameters

Parameter	Type
input	I

Returns

input is I & (Pending | Queued | Waiting)

---

Open

const Open: Schema.Union<readonly [typeof Pending, typeof Waiting, typeof Queued, typeof Running]>

Runs that still owe work, including those waiting for approval or a Worker.

---

OPEN_STATE_TAGS

const OPEN_STATE_TAGS: readonly ["Pending", "Waiting", "Queued", "Running"]

The open states as _tag literals, for queries that filter stored rows.

---

operatorActions

const operatorActions: (state) => object

The operator actions permitted by a Run’s lifecycle state. Command handlers still apply the typed transitions.

Parameters

Parameter	Type
state	RunState

Returns

object

canApprove

canApprove: boolean

canCancel

canCancel: boolean

canResolveFailure

canResolveFailure: boolean

canRetry

canRetry: boolean

---

retry

const retry: (_state) => Running

Returns the reopened state for operator retry; attempt N+1 belongs to the same Run and Step.

Parameters

Parameter	Type
_state	Failed

Returns

Running

---

revoke

const revoke: (_state) => Canceled

Cancels an unstarted run because its Item stopped matching the loop’s trigger.

Parameters

Parameter	Type
_state	Unstarted

Returns

Canceled

---

RunState

const RunState: Schema.Union<readonly [typeof Pending, typeof Waiting, typeof Queued, typeof Running, typeof Succeeded, typeof Failed, typeof Canceled]>

A Run’s progress from creation through approval and execution to a recorded outcome.

---

start

const start: (_state) => Running

Returns the running state for a first Attempt after any required approval has been granted.

Parameters

Parameter	Type
_state	Startable

Returns

Running

---

Startable

const Startable: Schema.Union<readonly [typeof Pending, typeof Queued]>

The states an attempt can start from: the gate is passed or absent.

---

STATE_TAGS

const STATE_TAGS: readonly ["Pending", "Waiting", "Queued", "Running", "Succeeded", "Failed", "Canceled"]

Every state as a _tag literal, for read models that project stored rows.

---

succeed

const succeed: (_state) => Succeeded

Closes the run after a successful attempt.

Parameters

Parameter	Type
_state	Running

Returns

Succeeded

---

supersede

const supersede: (_state, by) => Canceled

Cancels an unstarted run because a newer Event for the same Item replaced it. A running attempt always finishes and the newer state is judged when it ends (ADR 0007).

Parameters

Parameter	Type
_state	Unstarted
by	EventId

Returns

Canceled

---

Unstarted

const Unstarted: Schema.Union<readonly [typeof Pending, typeof Waiting, typeof Queued]>

The states with no attempt started: what supersede and revoke accept.

---

UNSTARTED_STATE_TAGS

const UNSTARTED_STATE_TAGS: readonly ["Pending", "Waiting", "Queued"]

The unstarted states as _tag literals, for queries that filter stored rows.