HttpApiError.ts

HttpApiError.ts overview

Built-in error schemas for common HTTP API failure responses.

This module provides reusable Schema.ErrorClass values for common HTTP status codes, plus HttpApiSchemaError for request decoding failures raised by the HTTP API runtime. The status errors can be used in endpoint or middleware error declarations and are understood by builders, generated clients, reflection, and OpenAPI generation.

Since v4.0.0

---

Exports Grouped by Category

• NoContent errors
  • BadRequestNoContent
  • ConflictNoContent
  • ForbiddenNoContent
  • GoneNoContent
  • InternalServerErrorNoContent
  • MethodNotAllowedNoContent
  • NotAcceptableNoContent
  • NotFoundNoContent
  • NotImplementedNoContent
  • RequestTimeoutNoContent
  • ServiceUnavailableNoContent
  • UnauthorizedNoContent
• errors
  • BadRequest (class)
    • [HttpServerRespondable.symbol] (method)
    • [ErrorReporter.ignore] (property)
  • Conflict (class)
    • [HttpServerRespondable.symbol] (method)
    • [ErrorReporter.ignore] (property)
  • Forbidden (class)
    • [HttpServerRespondable.symbol] (method)
    • [ErrorReporter.ignore] (property)
  • Gone (class)
    • [HttpServerRespondable.symbol] (method)
    • [ErrorReporter.ignore] (property)
  • HttpApiSchemaError (class)
    • is (static method)
    • wrap (static method)
    • [HttpServerRespondable.symbol] (method)
    • [HttpApiSchemaErrorTypeId] (property)
    • name (property)
    • message (property)
  • InternalServerError (class)
    • [HttpServerRespondable.symbol] (method)
  • MethodNotAllowed (class)
    • [HttpServerRespondable.symbol] (method)
    • [ErrorReporter.ignore] (property)
  • NotAcceptable (class)
    • [HttpServerRespondable.symbol] (method)
    • [ErrorReporter.ignore] (property)
  • NotFound (class)
    • [HttpServerRespondable.symbol] (method)
    • [ErrorReporter.ignore] (property)
  • NotImplemented (class)
    • [HttpServerRespondable.symbol] (method)
  • RequestTimeout (class)
    • [HttpServerRespondable.symbol] (method)
    • [ErrorReporter.ignore] (property)
  • ServiceUnavailable (class)
    • [HttpServerRespondable.symbol] (method)
  • Unauthorized (class)
    • [HttpServerRespondable.symbol] (method)
    • [ErrorReporter.ignore] (property)
• type IDs
  • HttpApiSchemaErrorTypeId
  • HttpApiSchemaErrorTypeId (type alias)

---

NoContent errors

BadRequestNoContent

No-content schema variant for BadRequest, decoding an empty 400 response into a BadRequest error value.

Signature

declare const BadRequestNoContent: HttpApiSchema.asNoContent<typeof BadRequest>

Source

Since v4.0.0

ConflictNoContent

No-content schema variant for Conflict, decoding an empty 409 response into a Conflict error value.

Signature

declare const ConflictNoContent: HttpApiSchema.asNoContent<typeof Conflict>

Source

Since v4.0.0

ForbiddenNoContent

No-content schema variant for Forbidden, decoding an empty 403 response into a Forbidden error value.

Signature

declare const ForbiddenNoContent: HttpApiSchema.asNoContent<typeof Forbidden>

Source

Since v4.0.0

GoneNoContent

No-content schema variant for Gone, decoding an empty 410 response into a Gone error value.

Signature

declare const GoneNoContent: HttpApiSchema.asNoContent<typeof Gone>

Source

Since v4.0.0

InternalServerErrorNoContent

No-content schema variant for InternalServerError, decoding an empty 500 response into an InternalServerError error value.

Signature

declare const InternalServerErrorNoContent: HttpApiSchema.asNoContent<typeof InternalServerError>

Source

Since v4.0.0

MethodNotAllowedNoContent

No-content schema variant for MethodNotAllowed, decoding an empty 405 response into a MethodNotAllowed error value.

Signature

declare const MethodNotAllowedNoContent: HttpApiSchema.asNoContent<typeof MethodNotAllowed>

Source

Since v4.0.0

NotAcceptableNoContent

No-content schema variant for NotAcceptable, decoding an empty 406 response into a NotAcceptable error value.

Signature

declare const NotAcceptableNoContent: HttpApiSchema.asNoContent<typeof NotAcceptable>

Source

Since v4.0.0

NotFoundNoContent

No-content schema variant for NotFound, decoding an empty 404 response into a NotFound error value.

Signature

declare const NotFoundNoContent: HttpApiSchema.asNoContent<typeof NotFound>

Source

Since v4.0.0

NotImplementedNoContent

No-content schema variant for NotImplemented, decoding an empty 501 response into a NotImplemented error value.

Signature

declare const NotImplementedNoContent: HttpApiSchema.asNoContent<typeof NotImplemented>

Source

Since v4.0.0

RequestTimeoutNoContent

No-content schema variant for RequestTimeout, decoding an empty 408 response into a RequestTimeout error value.

Signature

declare const RequestTimeoutNoContent: HttpApiSchema.asNoContent<typeof RequestTimeout>

Source

Since v4.0.0

ServiceUnavailableNoContent

No-content schema variant for ServiceUnavailable, decoding an empty 503 response into a ServiceUnavailable error value.

Signature

declare const ServiceUnavailableNoContent: HttpApiSchema.asNoContent<typeof ServiceUnavailable>

Source

Since v4.0.0

UnauthorizedNoContent

No-content schema variant for Unauthorized, decoding an empty 401 response into an Unauthorized error value.

Signature

declare const UnauthorizedNoContent: HttpApiSchema.asNoContent<typeof Unauthorized>

Source

Since v4.0.0

errors

BadRequest (class)

Built-in HTTP API error for a 400 Bad Request response. When used directly as a server response, it renders as an empty response with status 400.

Signature

declare class BadRequest

Source

Since v4.0.0

[HttpServerRespondable.symbol] (method)

Signature

declare const [HttpServerRespondable.symbol]: () => Effect.Effect<HttpServerResponse.HttpServerResponse, never, never>

Source

[ErrorReporter.ignore] (property)

Signature

readonly [ErrorReporter.ignore]: true

Source

Conflict (class)

Built-in HTTP API error for a 409 Conflict response. When used directly as a server response, it renders as an empty response with status 409.

Signature

declare class Conflict

Source

Since v4.0.0

[HttpServerRespondable.symbol] (method)

Signature

declare const [HttpServerRespondable.symbol]: () => Effect.Effect<HttpServerResponse.HttpServerResponse, never, never>

Source

[ErrorReporter.ignore] (property)

Signature

readonly [ErrorReporter.ignore]: true

Source

Forbidden (class)

Built-in HTTP API error for a 403 Forbidden response. When used directly as a server response, it renders as an empty response with status 403.

Signature

declare class Forbidden

Source

Since v4.0.0

[HttpServerRespondable.symbol] (method)

Signature

declare const [HttpServerRespondable.symbol]: () => Effect.Effect<HttpServerResponse.HttpServerResponse, never, never>

Source

[ErrorReporter.ignore] (property)

Signature

readonly [ErrorReporter.ignore]: true

Source

Gone (class)

Built-in HTTP API error for a 410 Gone response. When used directly as a server response, it renders as an empty response with status 410.

Signature

declare class Gone

Source

Since v4.0.0

[HttpServerRespondable.symbol] (method)

Signature

declare const [HttpServerRespondable.symbol]: () => Effect.Effect<HttpServerResponse.HttpServerResponse, never, never>

Source

[ErrorReporter.ignore] (property)

Signature

readonly [ErrorReporter.ignore]: true

Source

HttpApiSchemaError (class)

Error raised when an HTTP API request component fails schema decoding. It records which component failed and responds as an empty 400 Bad Request when rendered as a server response.

Signature

declare class HttpApiSchemaError

Source

Since v4.0.0

is (static method)

Signature

declare const is: (u: unknown) => u is HttpApiSchemaError

Source

wrap (static method)

Signature

declare const wrap: <A, R>(
  kind: HttpApiSchemaError["kind"],
  effect: Effect.Effect<A, Schema.SchemaError, R>
) => Effect.Effect<A, HttpApiSchemaError, R>

Source

[HttpServerRespondable.symbol] (method)

Signature

declare const [HttpServerRespondable.symbol]: () => Effect.Effect<HttpServerResponse.HttpServerResponse, never, never>

Source

[HttpApiSchemaErrorTypeId] (property)

Signature

readonly [HttpApiSchemaErrorTypeId]: "~effect/httpapi/HttpApiError/HttpApiSchemaError"

Source

name (property)

Signature

readonly name: "HttpApiSchemaError"

Source

message (property)

Signature

readonly message: "Params" | "Headers" | "Query" | "Body" | "Payload"

Source

InternalServerError (class)

Built-in HTTP API error for a 500 Internal Server Error response. When used directly as a server response, it renders as an empty response with status 500.

Signature

declare class InternalServerError

Source

Since v4.0.0

[HttpServerRespondable.symbol] (method)

Signature

declare const [HttpServerRespondable.symbol]: () => Effect.Effect<HttpServerResponse.HttpServerResponse, never, never>

Source

MethodNotAllowed (class)

Built-in HTTP API error for a 405 Method Not Allowed response. When used directly as a server response, it renders as an empty response with status 405.

Signature

declare class MethodNotAllowed

Source

Since v4.0.0

[HttpServerRespondable.symbol] (method)

Signature

declare const [HttpServerRespondable.symbol]: () => Effect.Effect<HttpServerResponse.HttpServerResponse, never, never>

Source

[ErrorReporter.ignore] (property)

Signature

readonly [ErrorReporter.ignore]: true

Source

NotAcceptable (class)

Built-in HTTP API error for a 406 Not Acceptable response. When used directly as a server response, it renders as an empty response with status 406.

Signature

declare class NotAcceptable

Source

Since v4.0.0

[HttpServerRespondable.symbol] (method)

Signature

declare const [HttpServerRespondable.symbol]: () => Effect.Effect<HttpServerResponse.HttpServerResponse, never, never>

Source

[ErrorReporter.ignore] (property)

Signature

readonly [ErrorReporter.ignore]: true

Source

NotFound (class)

Built-in HTTP API error for a 404 Not Found response. When used directly as a server response, it renders as an empty response with status 404.

Signature

declare class NotFound

Source

Since v4.0.0

[HttpServerRespondable.symbol] (method)

Signature

declare const [HttpServerRespondable.symbol]: () => Effect.Effect<HttpServerResponse.HttpServerResponse, never, never>

Source

[ErrorReporter.ignore] (property)

Signature

readonly [ErrorReporter.ignore]: true

Source

NotImplemented (class)

Built-in HTTP API error for a 501 Not Implemented response. When used directly as a server response, it renders as an empty response with status 501.

Signature

declare class NotImplemented

Source

Since v4.0.0

[HttpServerRespondable.symbol] (method)

Signature

declare const [HttpServerRespondable.symbol]: () => Effect.Effect<HttpServerResponse.HttpServerResponse, never, never>

Source

RequestTimeout (class)

Built-in HTTP API error for a 408 Request Timeout response. When used directly as a server response, it renders as an empty response with status 408.

Signature

declare class RequestTimeout

Source

Since v4.0.0

[HttpServerRespondable.symbol] (method)

Signature

declare const [HttpServerRespondable.symbol]: () => Effect.Effect<HttpServerResponse.HttpServerResponse, never, never>

Source

[ErrorReporter.ignore] (property)

Signature

readonly [ErrorReporter.ignore]: true

Source

ServiceUnavailable (class)

Built-in HTTP API error for a 503 Service Unavailable response. When used directly as a server response, it renders as an empty response with status 503.

Signature

declare class ServiceUnavailable

Source

Since v4.0.0

[HttpServerRespondable.symbol] (method)

Signature

declare const [HttpServerRespondable.symbol]: () => Effect.Effect<HttpServerResponse.HttpServerResponse, never, never>

Source

Unauthorized (class)

Built-in HTTP API error for a 401 Unauthorized response. When used directly as a server response, it renders as an empty response with status 401.

Signature

declare class Unauthorized

Source

Since v4.0.0

[HttpServerRespondable.symbol] (method)

Signature

declare const [HttpServerRespondable.symbol]: () => Effect.Effect<HttpServerResponse.HttpServerResponse, never, never>

Source

[ErrorReporter.ignore] (property)

Signature

readonly [ErrorReporter.ignore]: true

Source

type IDs

HttpApiSchemaErrorTypeId

Runtime identifier used to mark and detect HttpApiSchemaError values.

Signature

declare const HttpApiSchemaErrorTypeId: "~effect/httpapi/HttpApiError/HttpApiSchemaError"

Source

Since v4.0.0

HttpApiSchemaErrorTypeId (type alias)

Type-level identifier used to mark HttpApiSchemaError values.

Signature

type HttpApiSchemaErrorTypeId = "~effect/httpapi/HttpApiError/HttpApiSchemaError"

Source

Since v4.0.0