Function: createCamundaEffectWorker()

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.

function createCamundaEffectWorker<A, R>(
  config
): Effect<CamundaEffectWorkerHandle, never, CamundaEffect | R | Scope>;

Create and start an Effect job worker, forked into the current Scope. The worker runs until its scope closes (or CamundaEffectWorkerHandle.interrupt is run), at which point it is interrupted and any in-flight job's lease is released.

Depends on the CamundaEffect service — provide the /effect client layer.

Type Parameters

A

A extends CompleteVars

R

R = never

Parameters

config

EffectWorkerConfig<A, R>

Returns

Effect<CamundaEffectWorkerHandle, never, CamundaEffect | R | Scope>

Description

Camunda Effect Worker. See the README and this test for example usage.