standard-log 11.5.0 → 11.5.2

package/ts/types.ts

@@ -1,45 +1,55 @@
 import type { StackTraceMeta } from '@just-func/types'
 
 export type StandardLogOptions<CustomLevelNames extends string = LogMethodNames> = {
-  customLevels?: Record<CustomLevelNames, number>,
-  logLevel?: number,
-  reporters?: LogReporter[]
+	customLevels?: Record<CustomLevelNames, number>
+	logLevel?: number
+	reporters?: LogReporter[]
 }
 
 export interface LoggerOptions extends StackTraceMeta {
-  level?: number,
-  writeTo?: LogReporter | ReporterFilter
+	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
+	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 LogMethodNames =
+	| 'emergency'
+	| 'alert'
+	| 'critical'
+	| 'error'
+	| 'warn'
+	| 'notice'
+	| 'info'
+	| 'debug'
+	| 'trace'
+	| 'planck'
 
 export type LogEntry = {
-  id: string,
-  level: number,
-  // args instead of messages because it is `any[]` instead of `string[]`
-  args: any[],
-  timestamp: Date
+	id: string
+	level: number
+	// args instead of messages because it is `any[]` instead of `string[]`
+	args: any[]
+	timestamp: Date
 }
 
 export type LogMethod = (...args: any[]) => void
@@ -49,11 +59,11 @@ export type LogFunction = (log: LogMethod, logLevel: number) => string | void
 export type ReporterFilter = string | RegExp | ((reporterId: string) => boolean)
 
 export interface StandardLogInstance<N extends string = LogMethodNames> {
-  logLevel: number,
-  toLogLevelName(level: number): string,
-  toLogLevel(name: N): number,
-  getLogger(id: string, options?: LoggerOptions): Logger<N | LogMethodNames>,
-  getNonConsoleLogger(id: string, options?: LoggerOptions): Logger<N | LogMethodNames>
+	logLevel: number
+	toLogLevelName(level: number): string
+	toLogLevel(name: N): number
+	getLogger(id: string, options?: LoggerOptions): Logger<N | LogMethodNames>
+	getNonConsoleLogger(id: string, options?: LoggerOptions): Logger<N | LogMethodNames>
 }
 
 /**
@@ -68,45 +78,45 @@ export type LogFormatter<T = any[]> = (entry: LogEntry) => T
  */
 export type LogFilter = (entry: LogEntry) => boolean
 
-export type LogLevelEntry = { name: string, level: number }
+export 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,
-  /**
-   * Indicate 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
+	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
+	/**
+	 * Indicate 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
+	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,
+	debug(...args: any[]): void
+	info(...args: any[]): void
+	warn(...args: any[]): void
+	error(...args: any[]): void
 }