Skip to main content

Interface: RunMaintenanceTickOptions

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:441

Properties​

jobAbsoluteTimeoutMs?​

optional jobAbsoluteTimeoutMs?: number

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:468

Defaults to HOST_DEFAULTS.jobAbsoluteTimeoutMs. Pass 0 to disable the absolute tier.


logPrefix?​

optional logPrefix?: string

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:478

Prefix for this host's console.error diagnostics, e.g. "[NodeHost]". Defaults to HOST_DEFAULTS.logPrefix.


maxClaimsPerTick?​

optional maxClaimsPerTick?: number

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:449

Defaults to HOST_DEFAULTS.maxClaimsPerTick.


maxOutboxFlushPerTick?​

optional maxOutboxFlushPerTick?: number

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:464

Defaults to HOST_DEFAULTS.maxOutboxFlushPerTick.


maxSuspendedChecksPerTick?​

optional maxSuspendedChecksPerTick?: number

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:462

Defaults to HOST_DEFAULTS.maxSuspendedChecksPerTick.


retention?​

optional retention?: RetentionOptions

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:473

Delete terminal runs older than retention.olderThanMs through run.purge at the end of every tick. Omitted, nothing is deleted.


serves?​

optional serves?: readonly ServedDefinition[] | "all"

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:460

Which definition versions this host may adopt and poll, forwarded verbatim to run.claimPending and stage.pollSuspended.

Left unset, the kernel derives it from the registry, which is the behaviour you want. Pass "all" to claim and poll regardless of version — the pre-1.0 behaviour, and the documented escape hatch for a fleet that is deliberately homogeneous. Pass an explicit list to run maintenance on behalf of another build.


staleLeaseThresholdMs?​

optional staleLeaseThresholdMs?: number

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:466

Defaults to HOST_DEFAULTS.staleLeaseThresholdMs.


workerId?​

optional workerId?: string

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:447

Unique worker identifier passed to run.claimPending. Defaults to HOST_DEFAULTS.workerId — pass a distinct id when more than one process runs maintenance.