standard-log 12.1.2 → 13.0.1

package/cjs/types.d.ts

@@ -1,144 +1,145 @@
-import type { StackTraceMeta } from '@just-func/types';
-export type StandardLogOptions<CustomLevelNames extends string = LogMethodNames> = {
-    /**
-     * A map of custom log levels.
-     *
-     * Each logger created will have a method for each custom level.
-     *
-     * ```ts
-     * import { createStandardLog } from 'standard-log'
-     *
-     * const sl = createStandardLog({ customLevels: { foo: 100 } })
-     * const logger = sl.getLogger('my-logger')
-     *
-     * logger.foo('Hello world!') // 2020-01-01T00:00:00.000Z my-logger (FOO) Hello world!
-     * ```
-     */
-    customLevels?: Record<CustomLevelNames, number>;
-    logLevel?: number;
-    reporters?: LogReporter[];
+import { StackTraceMeta } from "@just-func/types";
+//#region ts/types.d.ts
+type StandardLogOptions<CustomLevelNames extends string = LogMethodNames> = {
+  /**
+   * A map of custom log levels.
+   *
+   * Each logger created will have a method for each custom level.
+   *
+   * ```ts
+   * import { createStandardLog } from 'standard-log'
+   *
+   * const sl = createStandardLog({ customLevels: { foo: 100 } })
+   * const logger = sl.getLogger('my-logger')
+   *
+   * logger.foo('Hello world!') // 2020-01-01T00:00:00.000Z my-logger (FOO) Hello world!
+   * ```
+   */
+  customLevels?: Record<CustomLevelNames, number>;
+  logLevel?: number;
+  reporters?: LogReporter[];
 };
-export interface LoggerOptions extends StackTraceMeta {
-    level?: number;
-    writeTo?: LogReporter | ReporterFilter;
+interface LoggerOptions extends StackTraceMeta {
+  level?: number;
+  writeTo?: LogReporter | ReporterFilter;
 }
-export type Logger<N extends string = LogMethodNames> = {
-    readonly id: string;
-    /**
-     * Logger local log level.
-     */
-    level?: number;
-    /**
-     * Logs with an increment counter.
-     * This is useful during debugging to check for steps executed.
-     */
-    count(...args: any[]): void;
-    on(level: number | N, logFunction: LogFunction): void;
-    /**
-     * Write custom log entries.
-     */
-    write(entry: LogEntry): void;
-} & {
-    [k in N]: LogMethod;
-};
+type Logger<N extends string = LogMethodNames> = {
+  readonly id: string;
+  /**
+   * Logger local log level.
+   */
+  level?: number;
+  /**
+   * Logs with an increment counter.
+   * This is useful during debugging to check for steps executed.
+   */
+  count(...args: any[]): void;
+  on(level: number | N, logFunction: LogFunction): void;
+  /**
+   * Write custom log entries.
+   */
+  write(entry: LogEntry): void;
+} & { [k in N]: LogMethod; };
 /**
  * Names of the standard log methods.
  */
-export type LogMethodNames = 'emergency' | 'alert' | 'critical' | 'error' | 'warn' | 'notice' | 'info' | 'debug' | 'trace' | 'planck';
-export type LogEntry = {
-    id: string;
-    level: number;
-    args: any[];
-    timestamp: Date;
+type LogMethodNames = 'emergency' | 'alert' | 'critical' | 'error' | 'warn' | 'notice' | 'info' | 'debug' | 'trace' | 'planck';
+type LogEntry = {
+  id: string;
+  level: number;
+  args: any[];
+  timestamp: Date;
 };
-export type LogMethod = (...args: any[]) => void;
-export type LogFunction = (log: LogMethod, logLevel: number) => string | void;
-export type ReporterFilter = string | RegExp | ((reporterId: string) => boolean);
-export interface StandardLogInstance<N extends string = LogMethodNames> {
-    /**
-     * The current log level.
-     */
-    logLevel: number;
-    /**
-     * Convert log level number to log level name.
-     */
-    toLogLevelName(level: number): string;
-    /**
-     * Convert log level name to log level number.
-     */
-    toLogLevel(name: N): number;
-    /**
-     * Get a logger instance with the specified id.
-     *
-     * ```ts
-     * const logger = getLogger('my-logger')
-     *
-     * logger.info('Hello world!') // 2020-01-01T00:00:00.000Z my-logger (INFO) Hello world!
-     * ```
-     */
-    getLogger(id: string, options?: LoggerOptions): Logger<N | LogMethodNames>;
-    /**
-     * Get a non-console logger instance with the specified id.
-     *
-     * The resulting logger will only send to the reporters that are not console reporters.
-     *
-     * ```ts
-     * const logger = getNonConsoleLogger('my-logger')
-     *
-     * logger.info('Hello world!') // will not send to any console reporter
-     * ```
-     */
-    getNonConsoleLogger(id: string, options?: LoggerOptions): Logger<N | LogMethodNames>;
+type LogMethod = (...args: any[]) => void;
+type LogFunction = (log: LogMethod, logLevel: number) => string | undefined | void;
+type ReporterFilter = string | RegExp | ((reporterId: string) => boolean);
+interface StandardLogInstance<N extends string = LogMethodNames> {
+  /**
+   * The current log level.
+   */
+  logLevel: number;
+  /**
+   * Convert log level number to log level name.
+   */
+  toLogLevelName(level: number): string;
+  /**
+   * Convert log level name to log level number.
+   */
+  toLogLevel(name: N): number;
+  /**
+   * Get a logger instance with the specified id.
+   *
+   * ```ts
+   * const logger = getLogger('my-logger')
+   *
+   * logger.info('Hello world!') // 2020-01-01T00:00:00.000Z my-logger (INFO) Hello world!
+   * ```
+   */
+  getLogger(id: string, options?: LoggerOptions): Logger<N | LogMethodNames>;
+  /**
+   * Get a non-console logger instance with the specified id.
+   *
+   * The resulting logger will only send to the reporters that are not console reporters.
+   *
+   * ```ts
+   * const logger = getNonConsoleLogger('my-logger')
+   *
+   * logger.info('Hello world!') // will not send to any console reporter
+   * ```
+   */
+  getNonConsoleLogger(id: string, options?: LoggerOptions): Logger<N | LogMethodNames>;
 }
 /**
  * Formats a log entry.
  * Depends on the reporter, it can expect a different return type.
  * By default the return type is `any[]` which the `console` accepts.
  */
-export type LogFormatter<T = any[]> = (entry: LogEntry) => T;
+type LogFormatter<T = any[]> = (entry: LogEntry) => T;
 /**
  * Determines whether the entry should be written.
  */
-export type LogFilter = (entry: LogEntry) => boolean;
-export type LogLevelEntry = {
-    name: string;
-    level: number;
+type LogFilter = (entry: LogEntry) => boolean;
+type LogLevelEntry = {
+  name: string;
+  level: number;
 };
-export interface LogReporter<T = any> {
-    readonly id: string;
-    /**
-     * Specifies the formatter to be used by the reporter.
-     * Using this you can customize how the reporter writes the log entry.
-     */
-    readonly formatter: LogFormatter<T>;
-    /**
-     * Specifies a filter to determine should the log be written.
-     */
-    readonly filter?: LogFilter;
-    /**
-     * Indicates if this is a console reporter.
-     * There is only one console reporter can be present in the system.
-     */
-    readonly isConsoleReporter?: boolean;
-    write(entry: LogEntry): void;
+interface LogReporter<T = any> {
+  readonly id: string;
+  /**
+   * Specifies the formatter to be used by the reporter.
+   * Using this you can customize how the reporter writes the log entry.
+   */
+  readonly formatter: LogFormatter<T>;
+  /**
+   * Specifies a filter to determine should the log be written.
+   */
+  readonly filter?: LogFilter;
+  /**
+   * Indicates if this is a console reporter.
+   * There is only one console reporter can be present in the system.
+   */
+  readonly isConsoleReporter?: boolean;
+  write(entry: LogEntry): void;
 }
-export type LogReporterOptions<T = any> = {
-    id?: string;
-    /**
-     * Specifies the formatter to be used by the reporter.
-     * Using this you can customize how the reporter writes the log entry.
-     */
-    formatter?: LogFormatter<T>;
-    /**
-     * Specifies a filter to determine should the log be written.
-     */
-    filter?: LogFilter;
+type LogReporterOptions<T = any> = {
+  id?: string;
+  /**
+   * Specifies the formatter to be used by the reporter.
+   * Using this you can customize how the reporter writes the log entry.
+   */
+  formatter?: LogFormatter<T>;
+  /**
+   * Specifies a filter to determine should the log be written.
+   */
+  filter?: LogFilter;
 };
-export type LogLevel = number;
-export interface ConsoleLike {
-    debug(...args: any[]): void;
-    info(...args: any[]): void;
-    warn(...args: any[]): void;
-    error(...args: any[]): void;
+type LogLevel = number;
+interface ConsoleLike {
+  debug(...args: any[]): void;
+  info(...args: any[]): void;
+  warn(...args: any[]): void;
+  error(...args: any[]): void;
 }
+//#endregion
+export { ConsoleLike, LogEntry, LogFilter, LogFormatter, LogFunction, LogLevel, LogLevelEntry, LogMethod, LogMethodNames, LogReporter, LogReporterOptions, Logger, LoggerOptions, ReporterFilter, StandardLogInstance, StandardLogOptions };
 //# sourceMappingURL=types.d.ts.map

package/cjs/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../ts/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAEtD,MAAM,MAAM,kBAAkB,CAAC,gBAAgB,SAAS,MAAM,GAAG,cAAc,IAAI;IAClF;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAA;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,WAAW,EAAE,CAAA;CACzB,CAAA;AAED,MAAM,WAAW,aAAc,SAAQ,cAAc;IACpD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,WAAW,GAAG,cAAc,CAAA;CACtC;AAED,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,MAAM,GAAG,cAAc,IAAI;IACvD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC3B,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,EAAE,WAAW,EAAE,WAAW,GAAG,IAAI,CAAA;IACrD;;OAEG;IACH,KAAK,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;CAC5B,GAAG;KAAG,CAAC,IAAI,CAAC,GAAG,SAAS;CAAE,CAAA;AAE3B;;GAEG;AACH,MAAM,MAAM,cAAc,GACvB,WAAW,GACX,OAAO,GACP,UAAU,GACV,OAAO,GACP,MAAM,GACN,QAAQ,GACR,MAAM,GACN,OAAO,GACP,OAAO,GACP,QAAQ,CAAA;AAEX,MAAM,MAAM,QAAQ,GAAG;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IAEb,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,SAAS,EAAE,IAAI,CAAA;CACf,CAAA;AAED,MAAM,MAAM,SAAS,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;AAEhD,MAAM,MAAM,WAAW,GAAG,CAAC,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAA;AAE7E,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,CAAA;AAEhF,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM,GAAG,cAAc;IACrE;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;IACrC;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,CAAC,GAAG,MAAM,CAAA;IAC3B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM,CAAC,CAAC,GAAG,cAAc,CAAC,CAAA;IAC1E;;;;;;;;;;OAUG;IACH,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM,CAAC,CAAC,GAAG,cAAc,CAAC,CAAA;CACpF;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,KAAK,CAAC,CAAA;AAE5D;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,KAAK,EAAE,QAAQ,KAAK,OAAO,CAAA;AAEpD,MAAM,MAAM,aAAa,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAE3D,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IACnC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;IACnC;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAA;IAC3B;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;IACpC,KAAK,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;CAC5B;AAED,MAAM,MAAM,kBAAkB,CAAC,CAAC,GAAG,GAAG,IAAI;IACzC,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAA;AAE7B,MAAM,WAAW,WAAW;IAC3B,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC3B,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC1B,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC1B,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;CAC3B"}
+{"version":3,"file":"types.d.ts","names":[],"sources":["../ts/types.ts"],"mappings":";;KAEY,mBAAmB,kCAAkC;;;;;;;;;;;;;;;EAehE,eAAe,OAAO;EACtB;EACA,YAAY;;UAGI,sBAAsB;EACtC;EACA,UAAU,cAAc;;KAGb,OAAO,mBAAmB;WAC5B;;;;EAIT;;;;;EAKA,SAAS;EACT,GAAG,gBAAgB,GAAG,aAAa;;;;EAInC,MAAM,OAAO;OACP,KAAK,IAAI;;;;KAKJ;KAYA;EACX;EACA;EAEA;EACA,WAAW;;KAGA,gBAAgB;KAEhB,eAAe,KAAK,WAAW;KAE/B,0BAA0B,WAAW;UAEhC,oBAAoB,mBAAmB;;;;EAIvD;;;;EAIA,eAAe;;;;EAIf,WAAW,MAAM;;;;;;;;;;EAUjB,UAAU,YAAY,UAAU,gBAAgB,OAAO,IAAI;;;;;;;;;;;;EAY3D,oBAAoB,YAAY,UAAU,gBAAgB,OAAO,IAAI;;;;;;;KAQ1D,aAAa,cAAc,OAAO,aAAa;;;;KAK/C,aAAa,OAAO;KAEpB;EAAkB;EAAc;;UAE3B,YAAY;WACnB;;;;;WAKA,WAAW,aAAa;;;;WAIxB,SAAS;;;;;WAKT;EACT,MAAM,OAAO;;KAGF,mBAAmB;EAC9B;;;;;EAKA,YAAY,aAAa;;;;EAIzB,SAAS;;KAGE;UAEK;EAChB,SAAS;EACT,QAAQ;EACR,QAAQ;EACR,SAAS"}

package/cjs/types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map