UNPKG

1.39 kBTypeScriptView Raw
1/**
2 * Used with {@link IConfigMessageReportingRule.logLevel} and {@link IExtractorInvokeOptions.messageCallback}.
3 *
4 * @remarks
5 * This is part of the {@link IConfigFile} structure.
6 *
7 * @public
8 */
9export declare const enum ExtractorLogLevel {
10 /**
11 * The message will be displayed as an error.
12 *
13 * @remarks
14 * Errors typically cause the build to fail and return a nonzero exit code.
15 */
16 Error = "error",
17 /**
18 * The message will be displayed as an warning.
19 *
20 * @remarks
21 * Warnings typically cause a production build fail and return a nonzero exit code. For a non-production build
22 * (e.g. using the `--local` option with `api-extractor run`), the warning is displayed but the build will not fail.
23 */
24 Warning = "warning",
25 /**
26 * The message will be displayed as an informational message.
27 *
28 * @remarks
29 * Informational messages may contain newlines to ensure nice formatting of the output,
30 * however word-wrapping is the responsibility of the message handler.
31 */
32 Info = "info",
33 /**
34 * The message will be displayed only when "verbose" output is requested, e.g. using the `--verbose`
35 * command line option.
36 */
37 Verbose = "verbose",
38 /**
39 * The message will be discarded entirely.
40 */
41 None = "none"
42}
43//# sourceMappingURL=ExtractorLogLevel.d.ts.map
\No newline at end of file