Interface: ActivateJobsStreamOptions<R>

Opt-In Subpath

The Effect API is an opt-in subpath (@camunda8/orchestration-cluster-api/effect) and requires the optional effect peer dependency. The main . entry stays Promise-based and pulls in zero Effect at runtime.

Extended by

• EffectWorkerConfig

Type Parameters

R

R = never

Properties

activationRetrySchedule?

readonly optional activationRetrySchedule?: Schedule<unknown, DomainError, never, R>;

Schedule used to back off and retry a failed activation request (transport outage, broker restart, transient server error). Runs on the Effect Clock. When omitted, an activation failure fails the stream.

---

fetchVariables?

readonly optional fetchVariables?: readonly string[];

Restrict activation to these variable names.

---

jobTimeout?

readonly optional jobTimeout?: Input;

Per-job activation lock timeout (server-side). Default 60 seconds.

---

maxJobsToActivate?

readonly optional maxJobsToActivate?: number;

Max jobs to activate per poll (the activation batch size). Default 10.

---

pollInterval?

readonly optional pollInterval?: Input;

Delay between polls that returned no jobs, on the Effect Clock (so it is virtual under TestClock). A poll that returns jobs schedules the next poll immediately. Default 1 second.

---

requestTimeout?

readonly optional requestTimeout?: Input;

Long-poll request timeout. 0 (the default) lets the broker hold the request for its configured default; a negative value returns immediately when idle.

---

withLease?

readonly optional withLease?: boolean;

Activate jobs with a lease — default false.

When true, each activated job is assigned a distinct, opaque lease token (ActivatedJobResult.jobLeaseToken) that is threaded back into the fenced completeJob / failJob / throwJobError commands, fencing them against a superseded activation of the same job.

Note: the Effect handler intentionally keeps the base job shape (jobLeaseToken remains optional/nullable); the token is threaded back into fenced commands automatically, so handlers do not read it directly.

---

workerName?

readonly optional workerName?: string;

Worker name recorded on the activation request. Defaults to effect-worker-<type>-<n>, where <n> is an incrementing per-process counter.