@shieldz/sdk
    Preparing search index...

    Class ShieldzError

    Thrown for any non-2xx response from the Shieldz API.

    Hierarchy

    • Error
      • ShieldzError
    Index

    Constructors

    constructor

    Properties

    cause? code message name param? requestId? stack? status type

    Constructors

    Properties

    cause?: unknown
    code: string

    Machine-readable code, e.g. "invalid_amount", "invoice_not_found".

    message: string
    name: string
    param?: string

    The request field that caused the error, when applicable.

    requestId?: string | null

    Correlation id for the request (the cf-ray), to quote to support.

    stack?: string
    status: number

    HTTP status code (0 for connection/timeout errors before a response).

    type: string

    Error class, e.g. "invalid_request", "auth_error", "rate_limit".

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties