@barchart/common-js/types/api/failures/FailureReasonItem.d.ts

Library of common JavaScript utilities

/**
 * One of the reason(s) for API failure, including any specific data that
 * allows a human-readable message to be generated.
 *
 * @public
 */
export default class FailureReasonItem {
    /**
     * @param {FailureType} type
     * @param {object=} data
     */
    constructor(type: FailureType, data?: object | undefined);
    /**
     * The {@link FailureType} of the item.
     *
     * @public
     * @returns {FailureType}
     */
    public get type(): FailureType;
    /**
     * The data.
     *
     * @public
     * @return {object}
     */
    public get data(): object;
    /**
     * Formats a human-readable message, describing the failure.
     *
     * @public
     * @param {object=} root - Root data from the {@link FailureReason}.
     * @returns {string}
     */
    public format(root?: object | undefined): string;
    /**
     * Returns a string representation.
     *
     * @public
     * @returns {string}
     */
    public toString(): string;
    #private;
}
import FailureType from './FailureType.js';