@offirmo/practical-logger-types

TypeScript types for Offirmo’s practical logger (no code)

Usage no npm install needed!

<script type="module">
  import offirmoPracticalLoggerTypes from 'https://cdn.skypack.dev/@offirmo/practical-logger-types';
</script>

README

Offirmo’s practical logger - TypeScript interfaces
Offirmo’s quality seal

npm badge dependencies badge bundle size badge license badge maintenance status badge

This is an internal module of Offirmo’s practical logger.

  • declares only TypeScript types
  • No code, 0 bytes = will do nothing to your bundle size
  • no dependencies

Usage

This is most likely not what you are looking for!

See the actual implementations of those interfaces:

Interface

A logger will have the following interface:

  • setLevel(level: LogLevel): void
  • getLevel(): LogLevel
  • addCommonDetails(hash: Readonly<{ [k: string]: any }>): void
  • Log primitives: (mirroring the log levels)
    • fatal(message?: string, details?: Readonly<{ [k: string]: any }>): void
    • emerg(…) idem
    • alert(…) idem
    • crit(…) idem
    • error(…) idem
    • warning(…), warn(…) idem
    • notice(…) idem
    • info(…) idem
    • verbose(…) idem
    • log(…) idem
    • debug(…) idem
    • trace(…) idem
    • silly(…) idem
  • those functions are present for convenience but may not do anything (platform-dependent):
    • group(groupTitle?: string): void
    • groupCollapsed(groupTitle?: string): void
    • groupEnd(): void

Concept

Other loggers:

Credits

I had a look at bunyan's interface.