IImperativeErrorParms.ts

/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/

import { Logger } from "../../../logger";
/**
 * Imperative Standard Error - All Imperative services/utils must thrown an Imperative Error (not a generic Error).
 * The Imperative Error collects additional diagnostics and most (if not all) Imperative Promises
 * @export
 * @interface IImperativeErrorParms
 */
export interface IImperativeErrorParms {
    /**
     * Logger for the Imperative Error (logs messages and the node report that is generated upon request)
     * @type {Logger}
     * @memberof IImperativeErrorParms
     */
    logger?: Logger;
    /**
     * Node report is automatically captured for diagnostic purposes, you can suppress by specifying true.
     * @type {boolean}
     * @memberof IImperativeErrorParms
     *
     * @deprecated Removed as of 10/17/2018 due to install issues.
     */
    suppressReport?: boolean;
    /**
     * Message tag - prepended to the error message specified. Useful for categorizing error messages
     * (e.g. "Profile IO Error"). A ": " is appended automatically (e.g. "Profile IO Error: ")
     * @type {string}
     * @memberof IImperativeErrorParms
     */
    tag?: string;
}