polarity-integration-utils
    Preparing search index...

    Interface IntegrationErrorProperties

    interface IntegrationErrorProperties {
        cause?: Error;
        code?: string;
        help?: string;
        meta?: MetaObject;
        requestOptions?: HttpRequestOptions;
        requestOptionsToSanitize?: 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

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

    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?: MetaObject

    Any additional properties which will be appended to the Error's meta property

    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. By default, the following paths are sanitized:

    • auth.password
    • auth.bearer
    • body.password
    • form.client_secret
    • headers.authorization
    • headers.x-api-key

    Additional paths can be sanitized by using the requestOptionsToSanitize property.

    requestOptionsToSanitize?: string[]

    List of paths in JSON dot notation to sanitize in the requestOptions object

    status?: string

    The 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)