Interface: CombineSignalsOptions

Defined in: shared/utils/abortUtils.ts:12

Configuration for building a composite AbortSignal.

Remarks

Combining signals allows a caller to share cancellation concerns such as upstream abort controllers, local timeouts, or explicit user requests. When a timeout is provided together with a reason message, the generated timeout signal uses that reason when aborting.

Properties

additionalSignals?

optional additionalSignals: AbortSignal[]

Defined in: shared/utils/abortUtils.ts:14

Additional AbortSignal instances that should be observed.

---

reason?

optional reason: string

Defined in: shared/utils/abortUtils.ts:19

Optional abort reason message used for timeout-driven cancellation when CombineSignalsOptions.timeoutMs is specified.

---

timeoutMs?

optional timeoutMs: number

Defined in: shared/utils/abortUtils.ts:21

Timeout window in milliseconds before the composite signal aborts.