UNPKG

1.77 kBTypeScriptView Raw
1import { DiagLogger, DiagLogFunction } from './types';
2/**
3 * A simple Immutable Console based diagnostic logger which will output any messages to the Console.
4 * If you want to limit the amount of logging to a specific level or lower use the
5 * {@link createLogLevelDiagLogger}
6 */
7export declare class DiagConsoleLogger implements DiagLogger {
8 constructor();
9 /** Log an error scenario that was not expected and caused the requested operation to fail. */
10 error: DiagLogFunction;
11 /**
12 * Log a warning scenario to inform the developer of an issues that should be investigated.
13 * The requested operation may or may not have succeeded or completed.
14 */
15 warn: DiagLogFunction;
16 /**
17 * Log a general informational message, this should not affect functionality.
18 * This is also the default logging level so this should NOT be used for logging
19 * debugging level information.
20 */
21 info: DiagLogFunction;
22 /**
23 * Log a general debug message that can be useful for identifying a failure.
24 * Information logged at this level may include diagnostic details that would
25 * help identify a failure scenario. Useful scenarios would be to log the execution
26 * order of async operations
27 */
28 debug: DiagLogFunction;
29 /**
30 * Log a detailed (verbose) trace level logging that can be used to identify failures
31 * where debug level logging would be insufficient, this level of tracing can include
32 * input and output parameters and as such may include PII information passing through
33 * the API. As such it is recommended that this level of tracing should not be enabled
34 * in a production environment.
35 */
36 verbose: DiagLogFunction;
37}
38//# sourceMappingURL=consoleLogger.d.ts.map
\No newline at end of file