Foodtruck Order — TypeScript Reference - v0.1.0
    Preparing search index...

    Class ApiError

    Error raised for a non-successful HTTP response.

    Hierarchy

    • Error
      • ApiError
    Index
    constructor
    code generatedMessage issues requestId retryAfterSeconds status

    • Parameters

      • status: number
      • message: string
      • generatedMessage: boolean = false
      • details: ApiErrorDetails = {}

      Returns ApiError

    code:
        | "INVALID_REQUEST"
        | "VALIDATION_FAILED"
        | "UNAUTHENTICATED"
        | "INVALID_CREDENTIALS"
        | "INVALID_RESET_CREDENTIAL"
        | "RATE_LIMITED"
        | "NOT_FOUND"
        | "CONFLICT"
        | "CHECKOUT_NOT_PAID"
        | "CHECKOUT_UNRESOLVED"
        | "INTERNAL_ERROR"
        | undefined

    Stable backend error category, when the body carried a recognized code.

    generatedMessage: boolean

    True when the message is a local fallback rather than the server's text.

    issues: readonly ApiFieldIssue[]

    Safe field issues retained from a recognized error body.

    requestId: string | undefined

    Server correlation identifier for safe log correlation.

    retryAfterSeconds: number | undefined

    Server-provided whole-second retry guidance for a throttled request.

    status: number

    HTTP status of the failed response.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties