@metreeca/http - v0.1.1
    Preparing search index...

    Type Alias Problem

    Problem details for HTTP APIs.

    Portable description of an error condition, as defined by RFC 9457, which obsoletes RFC 7807. Every field is optional, so a report carries as much detail as its source provides: type and title classify the problem, status, detail, and instance pin it to a specific occurrence, and report conveys machine-readable data for automated handling.

    success reports failed exchanges in this shape, so a client assembled with it surfaces transport failures and error responses alike as problem details.

    const problem: Problem = {
      status: 404,
      title: "Not Found",
      detail: "Resource /api/users/123 does not exist",
      instance: "/api/users/123",
      report: { timestamp: "2025-12-02T10:30:00Z" }
    };

    RFC 9457 - Problem Details for HTTP APIs

    type Problem = {
        title?: string;
        type?: string;
        instance?: string;
        status?: number;
        detail?: string;
        report?: Value;
    }
    Index
    title? type? instance? status? detail? report?
    title?: string

    Short, human-readable summary of the problem type.

    Should be the same for all occurrences of this problem type, for example Payment Required or Not Found.

    type?: string

    URI reference identifying the problem type.

    "about:blank"
    instance?: string

    URI reference identifying the specific occurrence of the problem.

    status?: number

    HTTP status code generated by the origin server.

    detail?: string

    Human-readable explanation specific to this occurrence of the problem.

    report?: Value

    Machine-readable details about this occurrence of the problem.

    An RFC 9457 extension member, shaped as the reporting party requires, for instance a validation trace or a diagnostic payload consumers may branch on.

    Settings
    Member Visibility

    On This Page
    Properties