For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10

Class: HttpError

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.

An HTTP-level failure (non-2xx / transport carrying a status).

Extends​

  • YieldableError<this> & object & Readonly<{ body?: unknown; cause?: unknown; message: string; status?: number; }>

Constructors​

Constructor​

new HttpError(args): HttpError;

Parameters​

args​
body?​

unknown

cause?​

unknown

message​

string

status?​

number

Returns​

HttpError

Inherited from​

Data.TaggedError('HttpError')<{
  readonly status?: number;
  readonly body?: unknown;
  readonly message: string;
  readonly cause?: unknown;
}>.constructor

Properties​

body?​

readonly optional body?: unknown;

Inherited from​

Data.TaggedError("HttpError").body;

status?​

readonly optional status?: number;

Inherited from​

Data.TaggedError("HttpError").status;