@umbraco-cms/backoffice

    Class UmbApiError

    UmbApiError is a class that extends UmbError and represents an error that occurs during an API call.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    cause? message name problemDetails request stack? status prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace fromLegacyApiError isUmbApiError isUmbError

    Constructors

    Properties

    cause?: unknown
    message: string
    name: string = 'UmbApiError'
    problemDetails: UmbProblemDetails
    request: unknown
    stack?: string
    status: number
    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Optional override for formatting stack traces

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Transforms an ApiError into an UmbApiError.

      Parameters

      • error: Error & { body?: string; request?: unknown; status?: number }

        The ApiError to transform.

      Returns UmbApiError

      The transformed UmbApiError.

      Use UmbCancelError.isUmbApiError instead and map your object to UmbApiError if needed.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR