Skip to main content
Version: Current

SubscribeInput

@rotorsoft/act-root


@rotorsoft/act-root / act/src / SubscribeInput

Type Alias: SubscribeInput

SubscribeInput = object

Defined in: libs/act/src/types/ports.ts:459

One target stream to register with Store.subscribe.

Propertiesโ€‹

correlated_at?โ€‹

readonly optional correlated_at?: number

Defined in: libs/act/src/types/ports.ts:491

Highest event id observed to resolve to this target โ€” the stream's work mark (#1485). Applied as correlated_at = GREATEST(correlated_at, N) for every value including zero and negatives; omitted leaves the stored value untouched.

A mark is an assertion about the log: correlate sets it to the id of a real event that resolved to this target, so at < correlated_at implies a fetch returns work. correlate is the only component entitled to write it โ€” the store cannot resolve user-code targets, and notify is best-effort โ€” which is what the name records.

Eligibility follows from it: a stream is claimable iff at < correlated_at. NULL means unknown, not "no work": those rows fall back to the legacy has-work probe against the event log, which is how installs that predate the column keep working. That arm is deleted once correlate marks universally.


lane?โ€‹

readonly optional lane?: string

Defined in: libs/act/src/types/ports.ts:472

Drain lane (ACT-1103). Adapter UPSERTs on every subscribe.


priority?โ€‹

readonly optional priority?: number

Defined in: libs/act/src/types/ports.ts:470

Optional scheduling priority for the lagging-frontier claim() ordering. Default 0. When the same stream is subscribed by multiple reactions with different priorities, implementations must keep the maximum so the highest-priority reaction wins. Use Store.prioritize for runtime overrides that ignore this max โ€” operator-driven changes.


source?โ€‹

readonly optional source?: string

Defined in: libs/act/src/types/ports.ts:461


streamโ€‹

readonly stream: string

Defined in: libs/act/src/types/ports.ts:460