Skip to content
Effect Days 2026 Get your ticket

HttpClientError

6 exports Added in v1.0.0 Source

Error

HttpClientError type

Added in v1.0.0 Source

Signature

type HttpClientError = RequestError | ResponseError

RequestError

Added in v1.0.0 Source

Signature

declare class RequestError extends YieldableError<this> & Record<typeof TypeId, typeof TypeId> & {
readonly _tag: "RequestError";
} & Readonly<{
readonly cause?: unknown;
readonly description?: string;
readonly reason: "Transport" | "Encode" | "InvalidUrl";
readonly request: HttpClientRequest;
}> {
constructor(args: {
readonly cause?: unknown;
readonly description?: string;
readonly reason: "Transport" | "Encode" | "InvalidUrl";
readonly request: HttpClientRequest;
});
message: string;
methodAndUrl: string;
}

Signature

declare class ResponseError extends YieldableError<this> & Record<typeof TypeId, typeof TypeId> & {
readonly _tag: "ResponseError";
} & Readonly<{
readonly cause?: unknown;
readonly description?: string;
readonly reason: "StatusCode" | "Decode" | "EmptyBody";
readonly request: HttpClientRequest;
readonly response: HttpClientResponse;
}> {
constructor(args: {
readonly cause?: unknown;
readonly description?: string;
readonly reason: "StatusCode" | "Decode" | "EmptyBody";
readonly request: HttpClientRequest;
readonly response: HttpClientResponse;
});
message: string;
methodAndUrl: string;
}

Guards

Signature

declare function isHttpClientError(u: unknown): u is HttpClientError

Type Id

TypeId

Added in v1.0.0 Source

Signature

declare const TypeId: unique symbol

TypeId type

Added in v1.0.0 Source

Signature

type TypeId = typeof TypeId