@oclif/errors
Version:
display friendly CLI errors and log to error log
27 lines (26 loc) • 776 B
TypeScript
export interface PrettyPrintableError {
/**
* messsage to display related to the error
*/
message?: string;
/**
* a unique error code for this error class
*/
code?: string;
/**
* a url to find out more information related to this error
* or fixing the error
*/
ref?: string;
/**
* a suggestion that may be useful or provide additional context
*/
suggestions?: string[];
}
declare type CLIErrorDisplayOptions = {
name?: string;
bang?: string;
};
export declare function applyPrettyPrintOptions(error: Error, options: PrettyPrintableError): PrettyPrintableError;
export default function prettyPrint(error: Error & PrettyPrintableError & CLIErrorDisplayOptions): string | undefined;
export {};