Libraries
    Preparing search index...

    Class ApiError

    Error thrown by the typed HTTP client when the server responds with a non-2xx status code.

    try {
        await client.todos.get({ params: { id: 999 } });
    } catch (err) {
        if (err instanceof ApiError && err.status === 404) {
            console.log('Not found:', err.message);
        }
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    body cause? message name stack? status traceId?

    Constructors

    • Parameters

      • status: number

        The HTTP status code (e.g. 404, 500).

      • message: string

        A human-readable error description.

      • body: unknown = undefined

        The parsed response body, if the server returned JSON.

      • OptionaltraceId: string

        The X-Trace-Id response header value, if the server set one. Useful for correlating client-side errors with backend traces in observability tools (SigNoz, Jaeger, etc.).

      Returns ApiError

    Properties

    Readonlybody

    body: unknown = undefined

    The parsed response body, if the server returned JSON.

    cause?: unknown
    message: string
    name: string
    stack?: string
    status: number

    The HTTP status code (e.g. 404, 500).

    traceId?: string

    The X-Trace-Id response header value, if the server set one. Useful for correlating client-side errors with backend traces in observability tools (SigNoz, Jaeger, etc.).

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties