Add the IDbgProvider to the collection of providers for this debug instance
The provider to add if not already present
A context object that can be used to remove this provider from this instance
Check to see if any logging at this level would be reported.
The logging level
true if at least one provider would cause the logging at this level to be recorded.
Readonly cmdsAdditional commands that are available for this instance or any parent instance.
Create a new named IDbg instance which has the current instance as it's parent, any logging to this instance will also be delegated the providers of the current instance as well as any added to the new returne instance.
import { createDbg, eDbgLevel, createConsoleProvider } from "@nevware21/ts-debug";
// Create a new IDbg instance with the defaule values
let dbg = createDbg();
dbg.log.debug("Debug Message"); // Nothing emitted to the provider(s)
dbg.log.error("Error Message"); // "Error Message" emitted to the provider(s)
// Create a named IDbg instance enabling all debug logging levels
let dbgAll = createbg({
name: "MyTest",
lvl: eDbgLevel.All
});
// The logging context sent to the providers will include the name `MyTest`
dbgAll.log.debug("Debug Message"); // "Debug Message" emitted to the provider(s)
dbgAll.log.error("Error Message"); // "Error Message" emitted to the provider(s)
// If the console provider is added to the instance, then the name will be included
// in the output.
dbgAll.addProvider(createConsoleProvider());
// The logging context sent to the providers will include the name `MyTest`
// Nothing emitted to the console as the provide by default will only send Error and higher messages
dbgAll.log.debug("Debug Message");
// "[MyTest]: Error Message" emitted to the console(s)
dbgAll.log.error("Error Message");
Optional config: string | IDbgConfigCan be either a string or an IDbgConfig instance, when a string value this will be the name of the instance.
A new instance which can be used for providing scoped debugging
Call the provider for each registered provider.
The callback function to call with the provider
Optional handleError: ((provider, error) => void)A callback function to call when an exception is thrown for a provider
Readonly logReturn the logging interface to be used for logging debug messages
Readonly lvlThe maximum logging level that will be reported by this instance.
Readonly nameThe name of the logger, the default logger is an empty name
Optional Readonly pIf this debug instance is a child of a parent then this is a link to their parent instance.
Add the provider to the collection of providers while executing the callback function, the requested provider will be removed after the cb has finished executing.
The provider to add while executing the callback
The callback function to execute
The response from the callback function
Readonly usrUser context values that are available for this instance or any parent instance
Generated using TypeDoc
A basic debug interface for logging debug information from you application or library