@report-toolkit/inspector/src/message.d.ts

See docs at [https://ibm.github.io/report-toolkit](https://ibm.github.io/report-toolkit)

/**
 * Output of inspector
 * @module @report-toolkit/inspector.message
 *
 */
/**
 */
export class Message {
    /**
     *
     * @param {Partial<MessageOptions>} opts
     */
    constructor(opts?: Partial<MessageOptions>);
    message: any;
    severity: any;
    id: any;
    config: any;
    filepath: any;
    error: any;
    data: any;
    isNonEmpty(): boolean;
    toString(): any;
}
export function createMessage(message: RawMessage, opts?: Partial<MessageOptions>): Readonly<Message>;
/**
 * Allowed extra options when creating a {@link Message}
 */
export type MessageOptions = {
    /**
     * - Extra data
     */
    data: object;
    /**
     * - Filepath of associated report, if applicable. Ignored if `isAggregate` is `true`
     */
    filepath: string;
    /**
     * - ID of Rule which created the {@link Message}
     */
    id: string;
    /**
     * - `true` if {@link Message} references multiple files
     */
    isAggregate: boolean;
    /**
     * - If present, an `Error` which was thrown by the Rule
     */
    error: Error;
    /**
     * - Rule configuration
     */
    config: object;
    /**
     * - The severity of the {@link Message}
     */
    severity: "error" | "warning" | "info";
    /**
     * - The message text itself, if first param not passed to {@link Message.createMessage}.
     */
    message: string;
};
export type RawMessage = string | Partial<MessageOptions>;
export type constants = typeof constants;
import { constants } from "@report-toolkit/common/src";