polarity-integration-utils
    Preparing search index...

    Interface SerializedIntegrationError

    interface SerializedIntegrationError {
        cause?: Error;
        code?: string | number;
        detail: string;
        help?: string;
        meta?: ErrorMeta;
        name: string;
        requestOptions?: HttpRequestOptions;
        stack?: string;
        status?: string;
        title: string;
    }
    Index

    Properties

    cause?: Error

    The cause property is used to specify the cause of the error. Typically, this property is used to pass through a related Error instance.

    code?: string | number

    An optional application-specific error code, expressed as a string value.

    detail: string

    a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized

    help?: string

    Additional details related to the error that may help the user troubleshoot the issue. If set by the user via the Error constructor, the user provided value will override any automated help message set by the Error class.

    meta?: ErrorMeta

    an optional meta object containing non-standard meta-information about the error.

    name: string

    The name data property of IntegrationError.prototype is shared by all Error instances. It represents the name for the type of error. For IntegrationError.prototype.name, the initial value is "IntegrationError".

    requestOptions?: HttpRequestOptions

    Relevant for integration errors involving a network call, the requestOptions property details the request options that resulted in the specified error. The requestOptions property will automatically have sensitive authentication headers stripped.

    stack?: string

    An optional StackTrace of the error

    status?: string

    An optional HTTP status code applicable to this error, expressed as a string value.

    title: string

    a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem except for purposes of localization. If omitted, the title will default to the type of error (e.g., IntegrationError, or ApiRequestError)