nope-js-browser
Version:
NoPE Runtime for the Browser. For nodejs please use nope-js-node
45 lines (44 loc) • 1.6 kB
TypeScript
/**
* @author Martin Karkowski
* @email m.karkowski@zema.de
* @create date 2020-11-06 08:54:35
* @modify date 2022-01-03 18:02:49
* @desc [description]
*/
import { ILogger } from "js-logger";
import { LoggerLevel, NopeLogger } from "./nopeLogger";
/**
* Return the central loger. This logger is a singleton (see {@link getSingleton})
*
* @author M.Karkowski
* @export
* @return {NopeLogger} A Returns the Logger {@link NopeLogger}
*/
export declare function getCentralNopeLogger(): NopeLogger;
/**
* Helper Function, to create a Logger. Therefore it uses a specific Level and a Lable of the
* Logger. The Logger-Level can be overwritten by the central-logger see {@link getCentralNopeLogger}
*
*
* @export
* @param {LoggerLevel} level The Level, which should be rendered
* @param {string} [label=''] An Lable for the Logger. Every Message beginns with that lable.
* @return {*} Returns a Logger.
*/
export declare function getNopeLogger(name: string, level?: LoggerLevel): ILogger;
/**
* The valid defintion types for the logger.
*/
export type ValidLoggerDefinition = ILogger | LoggerLevel | false;
/**
* Helper to define a Logger based on the given Logger-Definition.
* Based on the type, a new logger is created ("LoggerLevel"), the
* provided Logger is used or if "false" no logger is returned.
*
* @author M.Karkowski
* @export
* @param {ValidLoggerDefinition} param
* @param {string} defaultName
* @return {*}
*/
export declare function defineNopeLogger(param: ValidLoggerDefinition, defaultName: string): ILogger;