Function: createCamundaEffectClient()

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 createCamundaEffectClient(options?): CamundaEffectClient;

Create an Effect-flavoured Camunda client.

Every CamundaClient method becomes (...args) => Effect.Effect<Awaited<R>, DomainError, never>. Failures are narrowed into the tagged DomainError union so callers use Effect.catchTag/catchTags. The underlying throwing client is reachable via the .inner escape hatch.

Parameters

options?

CamundaOptions

Returns

CamundaEffectClient

Description

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