| 1 | export interface PrettyPrintableError {
|
| 2 | /**
|
| 3 | * messsage to display related to the error
|
| 4 | */
|
| 5 | message?: string;
|
| 6 | /**
|
| 7 | * a unique error code for this error class
|
| 8 | */
|
| 9 | code?: string;
|
| 10 | /**
|
| 11 | * a url to find out more information related to this error
|
| 12 | * or fixing the error
|
| 13 | */
|
| 14 | ref?: string;
|
| 15 | /**
|
| 16 | * a suggestion that may be useful or provide additional context
|
| 17 | */
|
| 18 | suggestions?: string[];
|
| 19 | }
|
| 20 | declare type CLIErrorDisplayOptions = {
|
| 21 | name?: string;
|
| 22 | bang?: string;
|
| 23 | };
|
| 24 | export declare function applyPrettyPrintOptions(error: Error, options: PrettyPrintableError): PrettyPrintableError;
|
| 25 | export default function prettyPrint(error: Error & PrettyPrintableError & CLIErrorDisplayOptions): string | undefined;
|
| 26 | export {};
|