From f238c86890bf16292d11ee77a6d7078698840b6e Mon Sep 17 00:00:00 2001 From: FoxxMD Date: Fri, 8 Mar 2024 17:38:08 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20FoxxMD/l?= =?UTF-8?q?ogging@6967b2d98adf253bc649c73490b5354d367b8d93=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- functions/factory.buildDestinationFile.html | 3 +- .../factory.buildDestinationRollingFile.html | 3 +- functions/factory.buildDestinationStderr.html | 6 ++- functions/factory.buildDestinationStdout.html | 6 ++- functions/factory.buildDestinationStream.html | 4 +- functions/factory.buildLogger.html | 5 ++- functions/factory.prettyOptsFactory.html | 3 +- functions/index.childLogger.html | 7 +++- functions/index.isLogOptions.html | 2 +- functions/index.loggerApp.html | 3 +- functions/index.loggerAppRolling.html | 3 +- functions/index.parseLogOptions.html | 3 +- index.html | 38 +++++++++---------- interfaces/index.FileLogOptions.html | 12 +++--- interfaces/index.LogOptions.html | 8 ++-- interfaces/index.LoggerAppExtras.html | 6 +-- ...index._internal_.FileLogOptionsStrong.html | 12 +++--- interfaces/index._internal_.FileOptions.html | 10 ++--- .../index._internal_.PinoRollOptions.html | 6 +-- interfaces/index._internal_.RollOptions.html | 4 +- modules/factory.html | 2 +- modules/index.html | 2 +- types/factory.FileDestination.html | 2 +- types/factory.StreamDestination.html | 2 +- .../factory._internal_.FileOptionsParsed.html | 2 +- types/index.LogData.html | 3 +- types/index.LogLevel.html | 2 +- types/index.LogLevelStreamEntry.html | 4 +- types/index.Logger.html | 2 +- ...index._internal_.FileLogOptionsParsed.html | 2 +- types/index._internal_.LogOptionsParsed.html | 2 +- variables/factory.PRETTY_COLORS.html | 4 +- variables/factory.PRETTY_COLORS_STR.html | 4 +- variables/factory.PRETTY_ISO8601.html | 2 +- variables/factory.PRETTY_LEVELS.html | 4 +- variables/factory.PRETTY_LEVELS_STR.html | 4 +- variables/factory.prettyConsole.html | 4 +- variables/factory.prettyFile.html | 4 +- variables/index.LOG_LEVELS.html | 2 +- variables/index.loggerDebug.html | 2 +- variables/index.loggerTest.html | 2 +- 41 files changed, 114 insertions(+), 87 deletions(-) diff --git a/functions/factory.buildDestinationFile.html b/functions/factory.buildDestinationFile.html index 9fc8a52..170593e 100644 --- a/functions/factory.buildDestinationFile.html +++ b/functions/factory.buildDestinationFile.html @@ -1 +1,2 @@ -buildDestinationFile | @foxxmd/logging Docs

Function buildDestinationFile

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +buildDestinationFile | @foxxmd/logging Docs

Function buildDestinationFile

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.buildDestinationRollingFile.html b/functions/factory.buildDestinationRollingFile.html index 69eaa50..6127a49 100644 --- a/functions/factory.buildDestinationRollingFile.html +++ b/functions/factory.buildDestinationRollingFile.html @@ -1 +1,2 @@ -buildDestinationRollingFile | @foxxmd/logging Docs

Function buildDestinationRollingFile

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +buildDestinationRollingFile | @foxxmd/logging Docs

Function buildDestinationRollingFile

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.buildDestinationStderr.html b/functions/factory.buildDestinationStderr.html index 1329166..98ba143 100644 --- a/functions/factory.buildDestinationStderr.html +++ b/functions/factory.buildDestinationStderr.html @@ -1 +1,5 @@ -buildDestinationStderr | @foxxmd/logging Docs

Function buildDestinationStderr

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +buildDestinationStderr | @foxxmd/logging Docs

Function buildDestinationStderr

  • buildDestinationStderr(level, options?): LogLevelStreamEntry

  • Creates a LogLevelStreamEntry stream that writes to STDERR at or above the minimum level

    +

    Parameters

    • level: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"
    • options: Omit<StreamDestination, "destination"> = {}

    Returns LogLevelStreamEntry

    Source

    const buildDestinationStderr = (level: LogLevel, options: Omit<StreamDestination, 'destination'> = {}): LogLevelStreamEntry => {
        const opts = {...options, destination: destination({dest: 2, sync: true})};
        return buildDestinationStream(level, opts);
    }
+
    +

    See

    buildDestinationStream

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.buildDestinationStdout.html b/functions/factory.buildDestinationStdout.html index 57586be..3f89380 100644 --- a/functions/factory.buildDestinationStdout.html +++ b/functions/factory.buildDestinationStdout.html @@ -1 +1,5 @@ -buildDestinationStdout | @foxxmd/logging Docs

Function buildDestinationStdout

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +buildDestinationStdout | @foxxmd/logging Docs

Function buildDestinationStdout

  • buildDestinationStdout(level, options?): LogLevelStreamEntry

  • Creates a LogLevelStreamEntry stream that writes to STDOUT at or above the minimum level

    +

    Parameters

    • level: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"
    • options: Omit<StreamDestination, "destination"> = {}

    Returns LogLevelStreamEntry

    Source

    const buildDestinationStdout = (level: LogLevel, options: Omit<StreamDestination, 'destination'> = {}): LogLevelStreamEntry => {
        const opts = {...options, destination: destination({dest: 1, sync: true})}
        return buildDestinationStream(level, opts);
    }
+
    +

    See

    buildDestinationStream

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.buildDestinationStream.html b/functions/factory.buildDestinationStream.html index 6bb7687..ce9b7e8 100644 --- a/functions/factory.buildDestinationStream.html +++ b/functions/factory.buildDestinationStream.html @@ -1 +1,3 @@ -buildDestinationStream | @foxxmd/logging Docs

Function buildDestinationStream

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +buildDestinationStream | @foxxmd/logging Docs

Function buildDestinationStream

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.buildLogger.html b/functions/factory.buildLogger.html index 4fb1419..a54bf74 100644 --- a/functions/factory.buildLogger.html +++ b/functions/factory.buildLogger.html @@ -1 +1,4 @@ -buildLogger | @foxxmd/logging Docs

Function buildLogger

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +buildLogger | @foxxmd/logging Docs

Function buildLogger

  • buildLogger(defaultLevel, streams): Logger

  • Builds a Logger object for use in your application

    +

    defaultLevel must the minimum level ANY stream can log from IE it should be the lowest level any of your streams will possibly log. Recommended to always use debug.

    +

    Parameters

    • defaultLevel: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"
    • streams: LogLevelStreamEntry[]

    Returns Logger

    See

    Logger

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.prettyOptsFactory.html b/functions/factory.prettyOptsFactory.html index 7284db5..3120108 100644 --- a/functions/factory.prettyOptsFactory.html +++ b/functions/factory.prettyOptsFactory.html @@ -1 +1,2 @@ -prettyOptsFactory | @foxxmd/logging Docs

Function prettyOptsFactory

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +prettyOptsFactory | @foxxmd/logging Docs

Function prettyOptsFactory

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/index.childLogger.html b/functions/index.childLogger.html index 7168fee..32d5586 100644 --- a/functions/index.childLogger.html +++ b/functions/index.childLogger.html @@ -1 +1,6 @@ -childLogger | @foxxmd/logging Docs

Function childLogger

  • childLogger(parent, labelsVal?, context?, options?): Logger

  • Parameters

    • parent: Logger
    • labelsVal: any = []
    • context: object = {}
    • options: {} = {}

      Returns Logger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +childLogger | @foxxmd/logging Docs

    Function childLogger

    • childLogger(parent, labelsVal?, context?, options?): Logger

    • Returns a new logger with the given properties appended to all log objects created by it

      +

      Parameters

      • parent: Logger

        Logger Parent logger to inherit from

        +
      • labelsVal: any = []

        (any | any[]) Labels to always apply to logs from this logger

        +
      • context: object = {}

        object Additional properties to always apply to logs from this logger

        +
      • options: {} = {}

        object

        +

        Returns Logger

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/index.isLogOptions.html b/functions/index.isLogOptions.html index 103f45b..ffd8c54 100644 --- a/functions/index.isLogOptions.html +++ b/functions/index.isLogOptions.html @@ -1 +1 @@ -isLogOptions | @foxxmd/logging Docs

      Function isLogOptions

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +isLogOptions | @foxxmd/logging Docs

      Function isLogOptions

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/index.loggerApp.html b/functions/index.loggerApp.html index 4fd2da9..ac4f54c 100644 --- a/functions/index.loggerApp.html +++ b/functions/index.loggerApp.html @@ -1 +1,2 @@ -loggerApp | @foxxmd/logging Docs

      Function loggerApp

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +loggerApp | @foxxmd/logging Docs

      Function loggerApp

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/index.loggerAppRolling.html b/functions/index.loggerAppRolling.html index 6b14e62..e123c02 100644 --- a/functions/index.loggerAppRolling.html +++ b/functions/index.loggerAppRolling.html @@ -1 +1,2 @@ -loggerAppRolling | @foxxmd/logging Docs

      Function loggerAppRolling

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +loggerAppRolling | @foxxmd/logging Docs

      Function loggerAppRolling

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/index.parseLogOptions.html b/functions/index.parseLogOptions.html index d0b0835..37b2d68 100644 --- a/functions/index.parseLogOptions.html +++ b/functions/index.parseLogOptions.html @@ -1 +1,2 @@ -parseLogOptions | @foxxmd/logging Docs

      Function parseLogOptions

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +parseLogOptions | @foxxmd/logging Docs

      Function parseLogOptions

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/index.html b/index.html index 5fd8a90..cf5d589 100644 --- a/index.html +++ b/index.html @@ -33,18 +33,18 @@

      Loggers

      The package exports 4 top-level loggers.

      App Loggers

      These are the loggers that should be used for the majority of your application. They accept an optional configuration object for configuring log destinations.

      Helper Loggers

      These loggers are pre-defined for specific use cases:

      -

      Configuring

      The App Loggers take an optional config object.

      +

      Configuring

      The App Loggers take an optional config object LogOptions:

      interface LogOptions {
        /**
         *  Specify the minimum log level for all log outputs without their own level specified.
         *
         *  Defaults to env `LOG_LEVEL` or `info` if not specified.
         *
         *  @default 'info'
         * */
        level?: LogLevel
        /**
         * Specify the minimum log level streamed to the console (or docker container)
         * */
        console?: LogLevel
        /**
         * Specify the minimum log level to output for files or a log file options object. If `false` no log files will be created.
         * */
        file?: LogLevel | false | FileLogOptions
      }
      -

      Available LogLevel levels, from lowest to highest:

      +

      Available LogLevel levels, from lowest to highest:

      const infoLogger = loggerApp({
       level: 'info' // console and file will log any levels `info` and above
      });

      const logger = loggerApp({
        console: 'debug', // console will log `debug` and higher
        file: 'warn' // file will log `warn` and higher
      });
      -

      File Options

      file in LogOptions may be an object that specifies more behavior log files.

      +

      File Options

      file in LogOptions may be an object that specifies more behavior log files.

      File Options -
      export interface FileOptions {
        /**
         * The path and filename to use for log files.
         *
         * If using rolling files the filename will be appended with `.N` (a number) BEFORE the extension based on rolling status.
         *
         * May also be specified using env LOG_PATH or a function that returns a string.
         *
         * If path is relative the absolute path will be derived from the current working directory.
         *
         * @default 'CWD/logs/app.log'
         * */
        path?: string | (() => string)
        /**
         * For rolling log files
         *
         * When
         * * value passed to rolling destination is a string (`path` option) and
         * * `frequency` is defined
         *
         * This determines the format of the datetime inserted into the log file name:
         *
         * * `unix` - unix epoch timestamp in milliseconds
         * * `iso`  - Full ISO8601 datetime IE '2024-03-07T20:11:34Z'
         * * `auto`
         *   * When frequency is `daily` only inserts date IE YYYY-MM-DD
         *   * Otherwise inserts full ISO8601 datetime
         *
         * @default 'auto'
         * */
        timestamp?: 'unix' | 'iso' | 'auto'
        /**
         * The maximum size of a given rolling log file.
         *
         * Can be combined with frequency. Use k, m and g to express values in KB, MB or GB.
         *
         * Numerical values will be considered as MB.
         * */
        size?: number | string
        /**
         * The amount of time a given rolling log file is used. Can be combined with size.
         *
         * Use `daily` or `hourly` to rotate file every day (or every hour). Existing file within the current day (or hour) will be re-used.
         *
         * Numerical values will be considered as a number of milliseconds. Using a numerical value will always create a new file upon startup.
         *
         * @default 'daily'
         * */
        frequency?: 'daily' | 'hourly' | number
      }
+
      export interface FileOptions {
        /**
         * The path and filename to use for log files.
         *
         * If using rolling files the filename will be appended with `.N` (a number) BEFORE the extension based on rolling status.
         *
         * May also be specified using env LOG_PATH or a function that returns a string.
         *
         * If path is relative the absolute path will be derived from the current working directory.
         *
         * @default 'CWD/logs/app.log'
         * */
        path?: string | (() => string)
        /**
         * For rolling log files
         *
         * When
         * * value passed to rolling destination is a string (`path` option) and
         * * `frequency` is defined
         *
         * This determines the format of the datetime inserted into the log file name:
         *
         * * `unix` - unix epoch timestamp in milliseconds
         * * `iso`  - Full ISO8601 datetime IE '2024-03-07T20:11:34-00:00'
         * * `auto`
         *   * When frequency is `daily` only inserts date IE YYYY-MM-DD
         *   * Otherwise inserts full ISO8601 datetime
         *
         * @default 'auto'
         * */
        timestamp?: 'unix' | 'iso' | 'auto'
        /**
         * The maximum size of a given rolling log file.
         *
         * Can be combined with frequency. Use k, m and g to express values in KB, MB or GB.
         *
         * Numerical values will be considered as MB.
         * */
        size?: number | string
        /**
         * The amount of time a given rolling log file is used. Can be combined with size.
         *
         * Use `daily` or `hourly` to rotate file every day (or every hour). Existing file within the current day (or hour) will be re-used.
         *
         * Numerical values will be considered as a number of milliseconds. Using a numerical value will always create a new file upon startup.
         *
         * @default 'daily'
         * */
        frequency?: 'daily' | 'hourly' | number
      }
      -

      Additional App Logger Configuration

      loggerApp and loggerAppRolling accept an optional second parameter, LoggerAppExtras that allows adding additional log destinations or pino-pretty customization:

      +

      Additional App Logger Configuration

      loggerApp and loggerAppRolling accept an optional second parameter, LoggerAppExtras that allows adding additional log destinations or pino-pretty customization:

      export interface LoggerAppExtras {
        /**
         * Additional pino-pretty options that are applied to the built-in console/log streams
         * */
        pretty?: PrettyOptions
        /**
         * Additional logging destinations to use alongside the built-in console/log stream. These can be any created by buildDestination* functions or other Pino Transports
         * */
        destinations?: LogLevelStreamEntry[]
      }

      Some defaults and convenience variables for pino-pretty options are available in @foxxmd/logging/factory prefixed with PRETTY_. See factory variables docs for all options.

      An example using the extras parameter:

      -
      import { loggerApp } from '@foxxmd/logging';
      import { 
          PRETTY_ISO8601, // replaces standard timestamp with ISO8601 format
        buildDestinationFile 
      } from "@foxxmd/logging/factory";

      const warnFileDestination = buildDestinationFile('warn', {path: './myLogs/warn.log'});

      const logger = loggerApp({}, {
         destinations: [warnFileDestination],
         pretty: {
           translateTime: PRETTY_ISO8601
         }
      });
      logger.debug('Test');
      // [2024-03-07T11:27:41-05:00] DEBUG: Test
+
      import { loggerApp } from '@foxxmd/logging';
      import {
          PRETTY_ISO8601, // replaces standard timestamp with ISO8601 format
          buildDestinationFile 
      } from "@foxxmd/logging/factory";

      const warnFileDestination = buildDestinationFile('warn', {path: './myLogs/warn.log'});

      const logger = loggerApp({}, {
         destinations: [warnFileDestination],
         pretty: {
           translateTime: PRETTY_ISO8601
         }
      });
      logger.debug('Test');
      // [2024-03-07T11:27:41-05:00] DEBUG: Test
 
      
 
      See Building A Logger for more information.
      
-
      Usage
      Child Loggers
      Pino Child loggers can be created using the childLogger function with the added ability to inherit Labels from their parent loggers.
      
+
      Usage
      Child Loggers
      Pino Child loggers can be created using the childLogger function with the added ability to inherit Labels from their parent loggers.
      
 
      Labels are inserted between the log level and message contents of a log. The child logger inherits all labels from all its parent loggers.
      
 
      childLogger accepts a single string label or an array of string labels.
      
 
      import {loggerApp, childLogger} from '@foxxmd/logging';

      logger = loggerApp();
      logger.debug('Test');
      // [2024-03-07 11:27:41.944 -0500] DEBUG: Test

      const nestedChild1 = childLogger(logger, 'First');
      nestedChild1.debug('I am nested one level');
      // [2024-03-07 11:27:41.945 -0500] DEBUG: [First] I am nested one level

      const nestedChild2 = childLogger(nestedChild1, ['Second', 'Third']);
      nestedChild2.warn('I am nested two levels but with more labels');
      // [2024-03-07 11:27:41.945 -0500] WARN: [First] [Second] [Third] I am nested two levels but with more labels

      const siblingLogger = childLogger(logger, ['1Sib','2Sib']);
      siblingLogger.info('Test');
      // [2024-03-07 11:27:41.945 -0500] INFO: [1Sib] [2Sib] Test
@@ -89,8 +89,8 @@
 
      const er = new Error('This is the original error');
      const causeErr = new ErrorWithCause('A top-level error', {cause: er});
      logger.debug(causeErr, 'Test');
      /*
      [2024-03-07 11:43:27.453 -0500] DEBUG: Test
      ErrorWithCause: A top-level error
          at <anonymous> (/my/dir/src/index.ts:55:18)
      caused by: Error: This is the original error
          at <anonymous> (/my/dir/src/index.ts:54:12)
       */
 
      
 
      Passing an Error without a second argument (message) will cause the top-level error's message to be printed instead of log message.
      
-
      Building A Logger
      All the functionality required to build your own logger is exported by @foxxmd/logging/factory. You can customize almost every facet of logging.
      
-
      A logger is composed of a minimum default level and array of objects that implement StreamEntry, the same interface used by pino.multistream. The only constraint is that your streams must accept the same levels as @foxxmd/logging using the LogLevelStreamEntry interface that extends StreamEntry.
      
+
      Building A Logger
      All the functionality required to build your own logger is exported by @foxxmd/logging/factory. You can customize almost every facet of logging.
      
+
      A logger is composed of a minimum default level and array of objects that implement StreamEntry, the same interface used by pino.multistream. The only constraint is that your streams must accept the same levels as @foxxmd/logging using the LogLevelStreamEntry interface that extends StreamEntry.
      
 
      import {LogLevelStreamEntry} from '@foxxmd/logging';
      import { buildLogger } from "@foxxmd/logging/factory";

      const myStreams: LogLevelStreamEntry[] = [];
      // build streams

      const logger = buildLogger('debug', myStreams);
      logger.debug('Test');
 
      
 
      factory exports several "destination" LogLevelStreamEntry function creators with default configurations that can be overridden.
      
@@ -99,26 +99,26 @@
 
      All buildDestination functions take args:
      
 
-
      options inherits a default pino-pretty configuration that comprises @foxxmd/logging's opinionated logging format. The common default config can be generated using prettyOptsFactory which accepts an optional pino-pretty options object to override defaults:
      
+
      options inherits a default pino-pretty configuration that comprises @foxxmd/logging's opinionated logging format. The common default config can be generated using prettyOptsFactory which accepts an optional PrettyOptions object to override defaults:
      
 
      import { prettyOptsFactory } from "@foxxmd/logging/factory";

      const defaultConfig = prettyOptsFactory();

      // override with your own config
      const myCustomizedConfig = prettyOptsFactory({ colorize: false });
 
      
 
      Pre-configured PrettyOptions are also provided for different destinations:
      
 
      import { 
          prettyConsole, // default config
          prettyFile     // disables colorize
      } from "@foxxmd/logging/factory";
 
      
 
      Specific buildDestinations also require passing a stream or path:
      
-
      buildDestinationStream must pass a NodeJS.WriteableStream or SonicBoom DestinationStream to options as destination
      
+
      buildDestinationStream must pass a NodeJS.WriteableStream or SonicBoom DestinationStream to options as destination
      
 
      import {buildDestinationStream} from "@foxxmd/logging/factory";

      const myStream = new WritableStream();
      const dest = buildDestinationStream('debug', {destination: myStream});
 
      
-
      buildDestinationStdout and buildDestinationStderr do not require a destination as they are fixed to STDOUT/STDERR
      
-
      buildDestinationFile and buildDestinationRollingFile must pass a path to options
      
+
      buildDestinationStdout and buildDestinationStderr do not require a destination as they are fixed to STDOUT/STDERR
      
+
      buildDestinationFile and buildDestinationRollingFile must pass a path to options
      
 
      import {buildDestinationFile} from "@foxxmd/logging/factory";

      const dest = buildDestinationFile('debug', {path: '/path/to/file.log'});
 
      
 
      Example
      Putting everything above together
      
 
      import {
        buildDestinationStream,
        buildDestinationFile,
        prettyOptsFactory,
        buildDestinationStdout,
        buildLogger
      } from "@foxxmd/logging/factory";
      import { PassThrough } from "node:stream";

      const hookStream = new PassThrough();
      const hookDestination = buildDestinationStream('debug', {
        ...prettyOptsFactory({sync: true, ignore: 'pid'}),
        destination: hookStream
      });

      const debugFileDestination = buildDestinationFile('debug', {path: './myLogs/debug.log'});
      const warnFileDestination = buildDestinationFile('warn', {path: './myLogs/warn.log'});

      const logger = buildLogger('debug', [
        hookDestination,
        buildDestinationStdout('debug'),
        debugFileDestination,
        warnFileDestination
      ]);
      hookStream.on('data', (log) => {console.log(log)});
      logger.debug('Test')
      // logs to hookStream
      // logs to STDOUT
      // logs to file ./myLogs/debug.log
      // does NOT log to file ./myLogs/warn.log
 
      
-
      Parsing LogOptions
      If you wish to use LogOptions to get default log levels for your destinations use parseLogOptions:
      
+
      Parsing LogOptions
      If you wish to use LogOptions to get default log levels for your destinations use parseLogOptions:
      
 
      import {parseLogOptions, LogOptions} from '@foxxmd/logging';

      const parsedOptions: LogOptions = parseLogOptions(myConfig);
 
      
 
      Settings
      Member Visibility
      Theme
      On This Page
      @foxxmd/loggingInstallQuick StartLoggersBuilding A Logger
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.FileLogOptions.html b/interfaces/index.FileLogOptions.html
index 8ec52aa..bbd1131 100644
--- a/interfaces/index.FileLogOptions.html
+++ b/interfaces/index.FileLogOptions.html
@@ -1,4 +1,4 @@
-FileLogOptions | @foxxmd/logging Docs
      Interface FileLogOptions
      interface FileLogOptions { 
          size?: string | number; 
          frequency?: number | "daily" | "hourly"; 
          timestamp?: "unix" | "iso" | "auto"; 
          path?: string | (() => string); 
          level?: false | "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"; 
      }
      Hierarchy (view full)
      Properties
      size?
+FileLogOptions | @foxxmd/logging Docs
      Interface FileLogOptions
      interface FileLogOptions { 
          size?: string | number; 
          frequency?: number | "daily" | "hourly"; 
          timestamp?: "unix" | "iso" | "auto"; 
          path?: string | (() => string); 
          level?: false | "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"; 
      }
      Hierarchy (view full)
      Properties
      size?
 frequency?
 timestamp?
 path?
@@ -8,12 +8,12 @@
 
      Numerical values will be considered as MB.
      
 
      Default
      '10MB'
 
      
-
      Optional frequency
      frequency?: number | "daily" | "hourly"
      The amount of time a given rolling log file is used. Can be combined with size.
      
+
      Optional frequency
      frequency?: number | "daily" | "hourly"
      The amount of time a given rolling log file is used. Can be combined with size.
      
 
      Use daily or hourly to rotate file every day (or every hour). Existing file within the current day (or hour) will be re-used.
      
 
      Numerical values will be considered as a number of milliseconds. Using a numerical value will always create a new file upon startup.
      
 
      Default
      'daily'
 
      
-
      Optional timestamp
      timestamp?: "unix" | "iso" | "auto"
      For rolling log files
      
+
      Optional timestamp
      timestamp?: "unix" | "iso" | "auto"
      For rolling log files
      
 
      When
      
 
        
 
      • value passed to rolling destination is a string (path from LogOptions is a string) and
        • 
@@ -31,11 +31,11 @@
 
      
 
      Default
      'auto'
 
      
-
      Optional path
      path?: string | (() => string)
      The path and filename to use for log files.
      
+
      Optional path
      path?: string | (() => string)
      The path and filename to use for log files.
      
 
      If using rolling files the filename will be appended with .N (a number) BEFORE the extension based on rolling status.
      
 
      May also be specified using env LOG_PATH or a function that returns a string.
      
 
      If path is relative the absolute path will be derived from the current working directory.
      
 
      Type declaration
        • (): string
        • Returns string
      Default
      'CWD/logs/app.log'
 
      
-
      Optional level
      level?: false | "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"
      Specify the minimum log level to output to rotating files. If false no log files will be created.
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      sizefrequencytimestamppathlevel
      Generated using TypeDoc
      
\ No newline at end of file
+
      Optional level
      level?: false | "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"
      Specify the minimum log level to output to rotating files. If false no log files will be created.
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      sizefrequencytimestamppathlevel
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.LogOptions.html b/interfaces/index.LogOptions.html
index d8bbd46..73c420d 100644
--- a/interfaces/index.LogOptions.html
+++ b/interfaces/index.LogOptions.html
@@ -1,10 +1,10 @@
-LogOptions | @foxxmd/logging Docs
      Interface LogOptions
      interface LogOptions { 
          level?: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"; 
          file?: false | "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug" | FileLogOptions; 
          console?: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"; 
      }
      Properties
      level?
+LogOptions | @foxxmd/logging Docs
      Interface LogOptions
      interface LogOptions { 
          level?: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"; 
          file?: false | "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug" | FileLogOptions; 
          console?: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"; 
      }
      Properties
      level?
 file?
 console?
 
      Properties
      Optional level
      level?: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"
      Specify the minimum log level for all log outputs without their own level specified.
      
 
       Defaults to env LOG_LEVEL or info if not specified.
      
 
      Default
      'info'
 
      
-
      Optional file
      file?: false | "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug" | FileLogOptions
      Specify the minimum log level to output to rotating files or file output options. If false no log files will be created.
      
-
      Optional console
      console?: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"
      Specify the minimum log level streamed to the console (or docker container)
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      levelfileconsole
      Generated using TypeDoc
      
\ No newline at end of file
+
      Optional file
      file?: false | "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug" | FileLogOptions
      Specify the minimum log level to output to rotating files or file output options. If false no log files will be created.
      
+
      Optional console
      console?: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"
      Specify the minimum log level streamed to the console (or docker container)
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      levelfileconsole
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.LoggerAppExtras.html b/interfaces/index.LoggerAppExtras.html
index 054c9cf..5e60f1e 100644
--- a/interfaces/index.LoggerAppExtras.html
+++ b/interfaces/index.LoggerAppExtras.html
@@ -1,5 +1,5 @@
-LoggerAppExtras | @foxxmd/logging Docs
      Interface LoggerAppExtras
      interface LoggerAppExtras { 
          pretty?: PrettyOptions_; 
          destinations?: LogLevelStreamEntry[]; 
      }
      Properties
      pretty?
+LoggerAppExtras | @foxxmd/logging Docs
      Interface LoggerAppExtras
      interface LoggerAppExtras { 
          pretty?: PrettyOptions_; 
          destinations?: LogLevelStreamEntry[]; 
      }
      Properties
      pretty?
 destinations?
 
      Properties
      Optional pretty
      pretty?: PrettyOptions_
      Additional pino-pretty options that are applied to the built-in console/log streams
      
-
      Optional destinations
      destinations?: LogLevelStreamEntry[]
      Additional logging destinations to use alongside the built-in console/log stream. These can be any created by buildDestination* functions or other Pino Transports
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      prettydestinations
      Generated using TypeDoc
      
\ No newline at end of file
+
      Optional destinations
      destinations?: LogLevelStreamEntry[]
      Additional logging destinations to use alongside the built-in console/log stream. These can be any created by buildDestination* functions or other Pino Transports
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      prettydestinations
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index._internal_.FileLogOptionsStrong.html b/interfaces/index._internal_.FileLogOptionsStrong.html
index 13fb8bf..0ecf604 100644
--- a/interfaces/index._internal_.FileLogOptionsStrong.html
+++ b/interfaces/index._internal_.FileLogOptionsStrong.html
@@ -1,4 +1,4 @@
-FileLogOptionsStrong | @foxxmd/logging Docs
      Interface FileLogOptionsStrong
      interface FileLogOptionsStrong { 
          size?: string | number; 
          frequency?: number | "daily" | "hourly"; 
          timestamp?: "unix" | "iso" | "auto"; 
          level: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"; 
          path: string | (() => string); 
      }
      Hierarchy (view full)
      Properties
      size?
+FileLogOptionsStrong | @foxxmd/logging Docs
      Interface FileLogOptionsStrong
      interface FileLogOptionsStrong { 
          size?: string | number; 
          frequency?: number | "daily" | "hourly"; 
          timestamp?: "unix" | "iso" | "auto"; 
          level: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"; 
          path: string | (() => string); 
      }
      Hierarchy (view full)
      Properties
      size?
 frequency?
 timestamp?
 level
@@ -8,12 +8,12 @@
 
      Numerical values will be considered as MB.
      
 
      Default
      '10MB'
 
      
-
      Optional frequency
      frequency?: number | "daily" | "hourly"
      The amount of time a given rolling log file is used. Can be combined with size.
      
+
      Optional frequency
      frequency?: number | "daily" | "hourly"
      The amount of time a given rolling log file is used. Can be combined with size.
      
 
      Use daily or hourly to rotate file every day (or every hour). Existing file within the current day (or hour) will be re-used.
      
 
      Numerical values will be considered as a number of milliseconds. Using a numerical value will always create a new file upon startup.
      
 
      Default
      'daily'
 
      
-
      Optional timestamp
      timestamp?: "unix" | "iso" | "auto"
      For rolling log files
      
+
      Optional timestamp
      timestamp?: "unix" | "iso" | "auto"
      For rolling log files
      
 
      When
      
 
        
 
      • value passed to rolling destination is a string (path from LogOptions is a string) and
        • 
@@ -31,11 +31,11 @@
 
      
 
      Default
      'auto'
 
      
-
      level
      level: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"
      Specify the minimum log level to output to rotating files. If false no log files will be created.
      
-
      path
      path: string | (() => string)
      The path and filename to use for log files.
      
+
      level
      level: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"
      Specify the minimum log level to output to rotating files. If false no log files will be created.
      
+
      path
      path: string | (() => string)
      The path and filename to use for log files.
      
 
      If using rolling files the filename will be appended with .N (a number) BEFORE the extension based on rolling status.
      
 
      May also be specified using env LOG_PATH or a function that returns a string.
      
 
      If path is relative the absolute path will be derived from the current working directory.
      
 
      Type declaration
        • (): string
        • Returns string
      Default
      'CWD/logs/app.log'
 
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      sizefrequencytimestamplevelpath
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      sizefrequencytimestamplevelpath
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index._internal_.FileOptions.html b/interfaces/index._internal_.FileOptions.html
index c03e507..9b0a139 100644
--- a/interfaces/index._internal_.FileOptions.html
+++ b/interfaces/index._internal_.FileOptions.html
@@ -1,4 +1,4 @@
-FileOptions | @foxxmd/logging Docs
      Interface FileOptions
      interface FileOptions { 
          size?: string | number; 
          frequency?: number | "daily" | "hourly"; 
          timestamp?: "unix" | "iso" | "auto"; 
          path?: string | (() => string); 
      }
      Hierarchy (view full)
      Properties
      size?
+FileOptions | @foxxmd/logging Docs
      Interface FileOptions
      interface FileOptions { 
          size?: string | number; 
          frequency?: number | "daily" | "hourly"; 
          timestamp?: "unix" | "iso" | "auto"; 
          path?: string | (() => string); 
      }
      Hierarchy (view full)
      Properties
      size?
 frequency?
 timestamp?
 path?
@@ -7,12 +7,12 @@
 
      Numerical values will be considered as MB.
      
 
      Default
      '10MB'
 
      
-
      Optional frequency
      frequency?: number | "daily" | "hourly"
      The amount of time a given rolling log file is used. Can be combined with size.
      
+
      Optional frequency
      frequency?: number | "daily" | "hourly"
      The amount of time a given rolling log file is used. Can be combined with size.
      
 
      Use daily or hourly to rotate file every day (or every hour). Existing file within the current day (or hour) will be re-used.
      
 
      Numerical values will be considered as a number of milliseconds. Using a numerical value will always create a new file upon startup.
      
 
      Default
      'daily'
 
      
-
      Optional timestamp
      timestamp?: "unix" | "iso" | "auto"
      For rolling log files
      
+
      Optional timestamp
      timestamp?: "unix" | "iso" | "auto"
      For rolling log files
      
 
      When
      
 
        
 
      • value passed to rolling destination is a string (path from LogOptions is a string) and
        • 
@@ -30,10 +30,10 @@
 
      
 
      Default
      'auto'
 
      
-
      Optional path
      path?: string | (() => string)
      The path and filename to use for log files.
      
+
      Optional path
      path?: string | (() => string)
      The path and filename to use for log files.
      
 
      If using rolling files the filename will be appended with .N (a number) BEFORE the extension based on rolling status.
      
 
      May also be specified using env LOG_PATH or a function that returns a string.
      
 
      If path is relative the absolute path will be derived from the current working directory.
      
 
      Type declaration
        • (): string
        • Returns string
      Default
      'CWD/logs/app.log'
 
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      sizefrequencytimestamppath
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      sizefrequencytimestamppath
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index._internal_.PinoRollOptions.html b/interfaces/index._internal_.PinoRollOptions.html
index c6ea3bf..27530dd 100644
--- a/interfaces/index._internal_.PinoRollOptions.html
+++ b/interfaces/index._internal_.PinoRollOptions.html
@@ -1,13 +1,13 @@
-PinoRollOptions | @foxxmd/logging Docs
      Interface PinoRollOptions
      interface PinoRollOptions { 
          size?: string | number; 
          frequency?: number | "daily" | "hourly"; 
      }
      Hierarchy (view full)
      Properties
      size?
+PinoRollOptions | @foxxmd/logging Docs
      Interface PinoRollOptions
      interface PinoRollOptions { 
          size?: string | number; 
          frequency?: number | "daily" | "hourly"; 
      }
      Hierarchy (view full)
      Properties
      size?
 frequency?
 
      Properties
      Optional size
      size?: string | number
      The maximum size of a given rolling log file.
      
 
      Can be combined with frequency. Use k, m and g to express values in KB, MB or GB.
      
 
      Numerical values will be considered as MB.
      
 
      Default
      '10MB'
 
      
-
      Optional frequency
      frequency?: number | "daily" | "hourly"
      The amount of time a given rolling log file is used. Can be combined with size.
      
+
      Optional frequency
      frequency?: number | "daily" | "hourly"
      The amount of time a given rolling log file is used. Can be combined with size.
      
 
      Use daily or hourly to rotate file every day (or every hour). Existing file within the current day (or hour) will be re-used.
      
 
      Numerical values will be considered as a number of milliseconds. Using a numerical value will always create a new file upon startup.
      
 
      Default
      'daily'
 
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      sizefrequency
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      sizefrequency
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index._internal_.RollOptions.html b/interfaces/index._internal_.RollOptions.html
index 9022379..0a60649 100644
--- a/interfaces/index._internal_.RollOptions.html
+++ b/interfaces/index._internal_.RollOptions.html
@@ -1,4 +1,4 @@
-RollOptions | @foxxmd/logging Docs
      Interface RollOptions
      interface RollOptions { 
          timestamp?: "unix" | "iso" | "auto"; 
      }
      Hierarchy (view full)
      Properties
      timestamp?
+RollOptions | @foxxmd/logging Docs
      Interface RollOptions
      interface RollOptions { 
          timestamp?: "unix" | "iso" | "auto"; 
      }
      Hierarchy (view full)
      Properties
      timestamp?
 
      Properties
      Optional timestamp
      timestamp?: "unix" | "iso" | "auto"
      For rolling log files
      
 
      When
      
 
        
@@ -17,4 +17,4 @@
 
      
 
      Default
      'auto'
 
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      timestamp
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      timestamp
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/modules/factory.html b/modules/factory.html
index 5a51120..cf4402a 100644
--- a/modules/factory.html
+++ b/modules/factory.html
@@ -1,4 +1,4 @@
-factory | @foxxmd/logging Docs
      Module factory
      Index
      Modules
      <internal>
+factory | @foxxmd/logging Docs
      Module factory
      Index
      Modules
      <internal>
 
      Type Aliases
      FileDestination
 StreamDestination
 
      Variables
      PRETTY_LEVELS
diff --git a/modules/index.html b/modules/index.html
index 952e22f..fc5c826 100644
--- a/modules/index.html
+++ b/modules/index.html
@@ -1,4 +1,4 @@
-index | @foxxmd/logging Docs
      Module index
      Index
      Modules
      <internal>
+index | @foxxmd/logging Docs
      Module index
      Index
      Modules
      <internal>
 
      Interfaces
      LogOptions
 FileLogOptions
 LoggerAppExtras
diff --git a/types/factory.FileDestination.html b/types/factory.FileDestination.html
index e972ce4..cb4324d 100644
--- a/types/factory.FileDestination.html
+++ b/types/factory.FileDestination.html
@@ -1 +1 @@
-FileDestination | @foxxmd/logging Docs
      Type alias FileDestination
      FileDestination: Omit<PrettyOptions_, "destination" | "sync"> & FileOptionsParsed
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+FileDestination | @foxxmd/logging Docs
      Type alias FileDestination
      FileDestination: Omit<PrettyOptions_, "destination" | "sync"> & FileOptionsParsed
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/types/factory.StreamDestination.html b/types/factory.StreamDestination.html
index 160789d..f88d12c 100644
--- a/types/factory.StreamDestination.html
+++ b/types/factory.StreamDestination.html
@@ -1 +1 @@
-StreamDestination | @foxxmd/logging Docs
      Type alias StreamDestination
      StreamDestination: Omit<PrettyOptions_, "destination"> & { 
          destination: number | DestinationStream | WritableStream; 
      }
      Type declaration
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+StreamDestination | @foxxmd/logging Docs
      Type alias StreamDestination
      StreamDestination: Omit<PrettyOptions_, "destination"> & { 
          destination: number | DestinationStream | WritableStream; 
      }
      Type declaration
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/types/factory._internal_.FileOptionsParsed.html b/types/factory._internal_.FileOptionsParsed.html
index 313520c..c01eade 100644
--- a/types/factory._internal_.FileOptionsParsed.html
+++ b/types/factory._internal_.FileOptionsParsed.html
@@ -1 +1 @@
-FileOptionsParsed | @foxxmd/logging Docs
      Type alias FileOptionsParsed
      FileOptionsParsed: MarkRequired<FileOptions, "path">
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+FileOptionsParsed | @foxxmd/logging Docs
      Type alias FileOptionsParsed
      FileOptionsParsed: MarkRequired<FileOptions, "path">
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/types/index.LogData.html b/types/index.LogData.html
index 2d03aa6..41717e9 100644
--- a/types/index.LogData.html
+++ b/types/index.LogData.html
@@ -1 +1,2 @@
-LogData | @foxxmd/logging Docs
      Type alias LogData
      LogData: Record<string, any> & { 
          level: number; 
          time: number; 
          pid: number; 
          hostname: string; 
          labels: any[]; 
          msg: string | Error | ErrorWithCause; 
      }
      Type declaration
      • level: number
      • time: number
      • pid: number
      • hostname: string
      • labels: any[]
      • msg: string | Error | ErrorWithCause
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+LogData | @foxxmd/logging Docs
      Type alias LogData
      LogData: Record<string, any> & { 
          level: number; 
          time: number; 
          pid: number; 
          hostname: string; 
          labels: any[]; 
          msg: string | Error | ErrorWithCause; 
      }
      The structure of a Log object when returned by a stream data event
      
+
      Type declaration
      • level: number
      • time: number
      • pid: number
      • hostname: string
      • labels: any[]
      • msg: string | Error | ErrorWithCause
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/types/index.LogLevel.html b/types/index.LogLevel.html
index a58fa06..a99bf50 100644
--- a/types/index.LogLevel.html
+++ b/types/index.LogLevel.html
@@ -1 +1 @@
-LogLevel | @foxxmd/logging Docs
      Type alias LogLevel
      LogLevel: typeof LOG_LEVELS[number]
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+LogLevel | @foxxmd/logging Docs
      Type alias LogLevel
      LogLevel: typeof LOG_LEVELS[number]
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/types/index.LogLevelStreamEntry.html b/types/index.LogLevelStreamEntry.html
index a26fdb3..1af6c75 100644
--- a/types/index.LogLevelStreamEntry.html
+++ b/types/index.LogLevelStreamEntry.html
@@ -1 +1,3 @@
-LogLevelStreamEntry | @foxxmd/logging Docs
      Type alias LogLevelStreamEntry
      LogLevelStreamEntry: StreamEntry<LogLevel>
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+LogLevelStreamEntry | @foxxmd/logging Docs
      Type alias LogLevelStreamEntry
      LogLevelStreamEntry: StreamEntry<LogLevel>
      An object with a write function that can be used by pino as a Transport
      
+
      All buildDestination* functions return this type as well as any Pino Transport
      
+
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/types/index.Logger.html b/types/index.Logger.html
index 3a01993..e99548b 100644
--- a/types/index.Logger.html
+++ b/types/index.Logger.html
@@ -1 +1 @@
-Logger | @foxxmd/logging Docs
      Type alias Logger
      Logger: Logger<LogLevel> & { 
          labels: any[]; 
          addLabel: ((value) => void); 
      }
      Type declaration
      • labels: any[]
      • addLabel: ((value) => void)
          • (value): void
          • Parameters
            • value: any
            Returns void
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+Logger | @foxxmd/logging Docs
      Type alias Logger
      Logger: Logger<LogLevel> & { 
          labels: any[]; 
          addLabel: ((value) => void); 
      }
      Type declaration
      • labels: any[]
      • addLabel: ((value) => void)
          • (value): void
          • Parameters
            • value: any
            Returns void
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/types/index._internal_.FileLogOptionsParsed.html b/types/index._internal_.FileLogOptionsParsed.html
index 6bd5885..bbdaa7b 100644
--- a/types/index._internal_.FileLogOptionsParsed.html
+++ b/types/index._internal_.FileLogOptionsParsed.html
@@ -1 +1 @@
-FileLogOptionsParsed | @foxxmd/logging Docs
      Type alias FileLogOptionsParsed
      FileLogOptionsParsed: Omit<FileLogOptions, "file"> & { 
          level: false; 
      } | FileLogOptionsStrong
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+FileLogOptionsParsed | @foxxmd/logging Docs
      Type alias FileLogOptionsParsed
      FileLogOptionsParsed: Omit<FileLogOptions, "file"> & { 
          level: false; 
      } | FileLogOptionsStrong
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/types/index._internal_.LogOptionsParsed.html b/types/index._internal_.LogOptionsParsed.html
index 5e898f2..6f05c9e 100644
--- a/types/index._internal_.LogOptionsParsed.html
+++ b/types/index._internal_.LogOptionsParsed.html
@@ -1 +1 @@
-LogOptionsParsed | @foxxmd/logging Docs
      Type alias LogOptionsParsed
      LogOptionsParsed: Omit<Required<LogOptions>, "file"> & { 
          file: FileLogOptionsParsed; 
      }
      Type declaration
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+LogOptionsParsed | @foxxmd/logging Docs
      Type alias LogOptionsParsed
      LogOptionsParsed: Omit<Required<LogOptions>, "file"> & { 
          file: FileLogOptionsParsed; 
      }
      Type declaration
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/variables/factory.PRETTY_COLORS.html b/variables/factory.PRETTY_COLORS.html
index f30554f..4271110 100644
--- a/variables/factory.PRETTY_COLORS.html
+++ b/variables/factory.PRETTY_COLORS.html
@@ -1,3 +1,3 @@
 PRETTY_COLORS | @foxxmd/logging Docs
      Variable PRETTY_COLORSConst 
      PRETTY_COLORS: Extract<PrettyOptions_["customColors"], object> = ...
      Additional level colors included in @foxxmd/logging as a string
      
-
      These are always applied when using prettyOptsFactory() but can be overridden
      
-
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+
      These are always applied when using prettyOptsFactory but can be overridden
      
+
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/variables/factory.PRETTY_COLORS_STR.html b/variables/factory.PRETTY_COLORS_STR.html
index 3c30935..bdea96c 100644
--- a/variables/factory.PRETTY_COLORS_STR.html
+++ b/variables/factory.PRETTY_COLORS_STR.html
@@ -1,3 +1,3 @@
 PRETTY_COLORS_STR | @foxxmd/logging Docs
      Variable PRETTY_COLORS_STRConst 
      PRETTY_COLORS_STR: Extract<PrettyOptions_["customColors"], string> = 'verbose:magenta,log:greenBright'
      Additional level colors included in @foxxmd/logging as an object
      
-
      These are always applied when using prettyOptsFactory() but can be overridden
      
-
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+
      These are always applied when using prettyOptsFactory but can be overridden
      
+
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/variables/factory.PRETTY_ISO8601.html b/variables/factory.PRETTY_ISO8601.html
index d79c61e..dac2eb5 100644
--- a/variables/factory.PRETTY_ISO8601.html
+++ b/variables/factory.PRETTY_ISO8601.html
@@ -1,2 +1,2 @@
 PRETTY_ISO8601 | @foxxmd/logging Docs
      Variable PRETTY_ISO8601Const 
      PRETTY_ISO8601: "SYS:yyyy-mm-dd\"T\"HH:MM:ssp" = 'SYS:yyyy-mm-dd"T"HH:MM:ssp'
      Use on translateTime pino-pretty option to print timestamps in ISO8601 format
      
-
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/variables/factory.PRETTY_LEVELS.html b/variables/factory.PRETTY_LEVELS.html
index dea8021..4fa5e9c 100644
--- a/variables/factory.PRETTY_LEVELS.html
+++ b/variables/factory.PRETTY_LEVELS.html
@@ -1,3 +1,3 @@
 PRETTY_LEVELS | @foxxmd/logging Docs
      Variable PRETTY_LEVELSConst 
      PRETTY_LEVELS: Extract<PrettyOptions_["customLevels"], object> = ...
      Additional levels included in @foxxmd/logging as an object
      
-
      These are always applied when using prettyOptsFactory() but can be overridden
      
-
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+
      These are always applied when using prettyOptsFactory but can be overridden
      
+
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/variables/factory.PRETTY_LEVELS_STR.html b/variables/factory.PRETTY_LEVELS_STR.html
index 59df475..18bafe7 100644
--- a/variables/factory.PRETTY_LEVELS_STR.html
+++ b/variables/factory.PRETTY_LEVELS_STR.html
@@ -1,3 +1,3 @@
 PRETTY_LEVELS_STR | @foxxmd/logging Docs
      Variable PRETTY_LEVELS_STRConst 
      PRETTY_LEVELS_STR: Extract<PrettyOptions_["customLevels"], string> = 'verbose:25,log:21'
      Additional levels included in @foxxmd/logging as a string
      
-
      These are always applied when using prettyOptsFactory() but can be overridden
      
-
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+
      These are always applied when using prettyOptsFactory but can be overridden
      
+
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/variables/factory.prettyConsole.html b/variables/factory.prettyConsole.html
index 1806208..9f72001 100644
--- a/variables/factory.prettyConsole.html
+++ b/variables/factory.prettyConsole.html
@@ -1,4 +1,4 @@
-prettyConsole | @foxxmd/logging Docs
      Variable prettyConsoleConst 
      prettyConsole: PrettyOptions_ = ...
      Pre-defined pretty options for use with console/stream output
      
+prettyConsole | @foxxmd/logging Docs
      Variable prettyConsoleConst 
      prettyConsole: PrettyOptions_ = ...
      Pre-defined pino-pretty PrettyOptions for use with console/stream output
      
 
      Source
      const prettyConsole: PrettyOptions = prettyOptsFactory({sync: true})
 
      
-
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/variables/factory.prettyFile.html b/variables/factory.prettyFile.html
index f108b5b..342617c 100644
--- a/variables/factory.prettyFile.html
+++ b/variables/factory.prettyFile.html
@@ -1,4 +1,4 @@
-prettyFile | @foxxmd/logging Docs
      Variable prettyFileConst 
      prettyFile: PrettyOptions_ = ...
      Pre-defined pretty options for use with file output
      
+prettyFile | @foxxmd/logging Docs
      Variable prettyFileConst 
      prettyFile: PrettyOptions_ = ...
      Pre-defined pino-pretty PrettyOptions for use with file output
      
 
      Source
      const prettyFile: PrettyOptions = prettyOptsFactory({
          colorize: false,
          sync: false,
      })
 
      
-
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/variables/index.LOG_LEVELS.html b/variables/index.LOG_LEVELS.html
index 7b5a91a..f9a38ec 100644
--- a/variables/index.LOG_LEVELS.html
+++ b/variables/index.LOG_LEVELS.html
@@ -1 +1 @@
-LOG_LEVELS | @foxxmd/logging Docs
      Variable LOG_LEVELSConst 
      LOG_LEVELS: readonly ["silent", "fatal", "error", "warn", "info", "log", "verbose", "debug"] = ...
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+LOG_LEVELS | @foxxmd/logging Docs
      Variable LOG_LEVELSConst 
      LOG_LEVELS: readonly ["silent", "fatal", "error", "warn", "info", "log", "verbose", "debug"] = ...
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/variables/index.loggerDebug.html b/variables/index.loggerDebug.html
index ac38f3b..87ead6b 100644
--- a/variables/index.loggerDebug.html
+++ b/variables/index.loggerDebug.html
@@ -1,4 +1,4 @@
 loggerDebug | @foxxmd/logging Docs
      Variable loggerDebugConst 
      loggerDebug: Logger = ...
      A logger that ONLY logs to console at minimum 'debug' level. Useful for logging during startup before a loggerApp has been initialized
      
 
      Source
      const loggerDebug = buildLogger('debug', [buildDestinationStdout('debug')])
 
      
-
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/variables/index.loggerTest.html b/variables/index.loggerTest.html
index 3487419..a8aec30 100644
--- a/variables/index.loggerTest.html
+++ b/variables/index.loggerTest.html
@@ -1,4 +1,4 @@
 loggerTest | @foxxmd/logging Docs
      Variable loggerTestConst 
      loggerTest: Logger = ...
      A noop (no output) logger for use when testing a component that requires a Logger
      
 
      Source
      const loggerTest = buildLogger('silent', [buildDestinationStdout('debug')])
 
      
-
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
-- 
2.51.2