UNPKG

ph-utils

Version:

js 开发工具集,前后端都可以使用(commonjs和es module)

63 lines (62 loc) 1.95 kB
type LoggerLevel = "debug" | "info" | "warn" | "error" | "fatal"; /** 日志消息类型 */ type MessageIntf = number | string | boolean | object | any[] | Error; /** 日志消息选项 */ type MessageOption = { /** 日志名称 */ name?: string; /** 日志级别 */ level?: LoggerLevel; /** 日志消息 */ message: MessageIntf; /** 当前消息是否美化输出 */ pretty?: boolean; /** 如果消息是 JSON 格式, 转换为字符串时, 是否格式化 JSON */ jsonSpace?: number; }; type LoggerOption = { /** 记录的日志名称, 通常用于表明哪个页面 */ name?: string; /** 记录日志级别, 通常上线时 error 或者禁用日志, 默认: debug */ level?: LoggerLevel; /** 是否需要美化输出, 默认: true */ pretty?: boolean; }; /** * 日志记录器 */ export declare class Logger { /** 日志级别 */ levels: string[]; colors: { debug: string; info: string; warn: string; error: string; }; option: LoggerOption & { levelNum: number; }; /** 构造日志记录器 */ constructor(option?: LoggerOption); setOption(option: LoggerOption): void; log(message: MessageIntf | MessageOption): void; info(message: MessageIntf | MessageOption): void; debug(message: MessageIntf | MessageOption): void; warn(message: MessageIntf | MessageOption): void; error(message: MessageIntf | MessageOption): void; fatal(message: MessageIntf | MessageOption): void; getLevel(): string; getName(): string | undefined; getOption(): LoggerOption & { levelNum: number; }; private generateLog; /** 格式化显示 */ private formatShow; } /** 默认日志记录器 */ export declare const logger: Logger; /** 获取新的日志记录器, 属性采用之前的 */ export declare const getLogger: (option?: LoggerOption) => Logger; export {};