@tomjs/logger/dist/index.d.mts

logger for `node.js`

//#region src/index.d.ts
interface LoggerOptions {
  /**
   * log prefix
   */
  prefix?: string;
  /**
   * enable debug mode
   * @default false
   */
  debug?: boolean;
  /**
   * show time in log. use `flag:"time"` replace time
   * @default false
   * @deprecated
   */
  time?: boolean;
  /**
   * show log symbols
   * @default 'symbol'
   */
  flag?: 'time' | 'symbol' | 'none';
  /**
   * specify the log directory name
   */
  directory?: string;
  /**
   * specify the log cleanup period
   * @default 30
   */
  cleanup?: number;
  /**
   * log file root directory，default is '～/.tomjs'
   */
  root?: string;
}
/**
 * log tool
 */
declare class Logger {
  private _opts;
  private _logDir?;
  constructor(options?: LoggerOptions);
  private initLogDir;
  private format;
  private _writeLog;
  private _log;
  /**
   * set debug mode or not
   */
  enableDebug(debug: boolean): void;
  /**
   * set debug mode or not
   */
  setOptions(options: LoggerOptions): void;
  /**
   * like console.log
   */
  log(...args: any[]): void;
  /**
   * write log to file
   */
  write(...args: any[]): void;
  /**
   * only show in debug mode
   */
  debug(...args: any[]): void;
  /**
   * add the specified red prefix or error symbol before the log content
   */
  error(...args: any[]): void;
  /**
   * add the specified blue prefix or info symbol before the log content
   */
  info(...args: any[]): void;
  /**
   * add the specified green prefix or success symbol before the log content
   */
  success(...args: any[]): void;
  /**
   * add the specified yellow prefix or warning symbol before the log content
   */
  warning(...args: any[]): void;
  /**
   * add the specified yellow prefix or warning symbol before the log content
   */
  warn(...args: any[]): void;
}
//#endregion
export { Logger, Logger as default, LoggerOptions };