From 5e0faf68f969adc3fffae5e4f6060ac55449b119 Mon Sep 17 00:00:00 2001 From: FoxxMD Date: Sat, 28 Feb 2026 02:35:17 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20FoxxMD/l?= =?UTF-8?q?ogging@2fd94ec2e431e7110cfb6c0ecf610709c9723440=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- functions/factory.buildDestinationFile.html | 2 +- .../factory.buildDestinationJsonPrettyStream.html | 2 +- functions/factory.buildDestinationRollingFile.html | 2 +- functions/factory.buildDestinationStderr.html | 2 +- functions/factory.buildDestinationStdout.html | 2 +- functions/factory.buildDestinationStream.html | 2 +- functions/factory.buildLogger.html | 2 +- functions/factory.prettyOptsConsoleFactory.html | 2 +- functions/factory.prettyOptsFactory.html | 2 +- functions/factory.prettyOptsFileFactory.html | 2 +- functions/index.childLogger.html | 2 +- functions/index.isLogOptions.html | 2 +- functions/index.labelFiltersFromEnvSingleton.html | 2 +- functions/index.labelFiltersFromStr.html | 2 +- functions/index.labelsDisableFromEnv.html | 2 +- functions/index.labelsDisableFromEnvSingleton.html | 2 +- functions/index.labelsEnableFromEnv.html | 2 +- functions/index.labelsEnableFromEnvSingleton.html | 2 +- functions/index.labelsFilterFromEnv.html | 2 +- functions/index.labelsStrBuilder.html | 2 +- functions/index.loggerApp.html | 2 +- functions/index.loggerAppRolling.html | 2 +- functions/index.parseLogOptions.html | 2 +- index.html | 11 ++++++++++- interfaces/index.ChildLoggerOptions.html | 4 ++-- interfaces/index.FileLogOptions.html | 12 ++++++------ interfaces/index.LogOptions.html | 8 ++++---- interfaces/index.LoggerAppExtras.html | 12 ++++++------ interfaces/index.PrettyOptionsExtra.html | 6 +++--- .../index._internal_.FileLogOptionsStrong.html | 12 ++++++------ interfaces/index._internal_.FileLogPathOptions.html | 6 +++--- interfaces/index._internal_.FileOptions.html | 10 +++++----- interfaces/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.JsonPrettyDestination.html | 2 +- types/factory.StreamDestination.html | 2 +- types/factory._internal_.FileOptionsParsed.html | 2 +- types/factory._internal_.PinoLoggerOptions.html | 2 +- types/index.LogData.html | 2 +- types/index.LogDataPretty.html | 2 +- types/index.LogLevel.html | 2 +- types/index.LogLevelStreamEntry.html | 2 +- types/index.Logger.html | 2 +- types/index._internal_.ChildLabel.html | 2 +- types/index._internal_.FileLogOptionsParsed.html | 2 +- types/index._internal_.FilterLabelsFunc.html | 2 +- types/index._internal_.LogOptionsParsed.html | 2 +- variables/factory.PRETTY_COLORS.html | 2 +- variables/factory.PRETTY_COLORS_STR.html | 2 +- variables/factory.PRETTY_ISO8601.html | 2 +- variables/factory.PRETTY_OPTS_CONSOLE.html | 2 +- variables/factory.PRETTY_OPTS_FILE.html | 2 +- variables/index.LOG_LEVEL_NAMES.html | 2 +- variables/index.loggerDebug.html | 2 +- variables/index.loggerTest.html | 2 +- variables/index.loggerTrace.html | 2 +- 59 files changed, 98 insertions(+), 89 deletions(-) diff --git a/functions/factory.buildDestinationFile.html b/functions/factory.buildDestinationFile.html index 1359a29..46c59c1 100644 --- a/functions/factory.buildDestinationFile.html +++ b/functions/factory.buildDestinationFile.html @@ -1,2 +1,2 @@ buildDestinationFile | @foxxmd/logging Docs

Function buildDestinationFile

Creates a LogLevelStreamEntry stream that writes to a static file at or above the minimum level

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/factory.buildDestinationJsonPrettyStream.html b/functions/factory.buildDestinationJsonPrettyStream.html index 34f3246..efb48fd 100644 --- a/functions/factory.buildDestinationJsonPrettyStream.html +++ b/functions/factory.buildDestinationJsonPrettyStream.html @@ -7,4 +7,4 @@
  • the destination stream passed MUST be set to objectMode: true

    • See

    DestinationStream

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/factory.buildDestinationRollingFile.html b/functions/factory.buildDestinationRollingFile.html index d344517..3c0b215 100644 --- a/functions/factory.buildDestinationRollingFile.html +++ b/functions/factory.buildDestinationRollingFile.html @@ -1,2 +1,2 @@ buildDestinationRollingFile | @foxxmd/logging Docs

    Function buildDestinationRollingFile

    Creates a LogLevelStreamEntry stream that writes to a rolling file at or above the minimum level

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/factory.buildDestinationStderr.html b/functions/factory.buildDestinationStderr.html index aa4e830..4c0c608 100644 --- a/functions/factory.buildDestinationStderr.html +++ b/functions/factory.buildDestinationStderr.html @@ -3,4 +3,4 @@

    See

    buildDestinationStream

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/factory.buildDestinationStdout.html b/functions/factory.buildDestinationStdout.html index f98aece..17f9d8f 100644 --- a/functions/factory.buildDestinationStdout.html +++ b/functions/factory.buildDestinationStdout.html @@ -3,4 +3,4 @@

    See

    buildDestinationStream

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/factory.buildDestinationStream.html b/functions/factory.buildDestinationStream.html index 8700ac7..d4bbdd4 100644 --- a/functions/factory.buildDestinationStream.html +++ b/functions/factory.buildDestinationStream.html @@ -1,3 +1,3 @@ buildDestinationStream | @foxxmd/logging Docs

    Function buildDestinationStream

    Creates a LogLevelStreamEntry stream that writes to a NodeJs.WriteableStream or Sonic Boom DestinationStream at or above the minimum level

    See

    DestinationStream

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/factory.buildLogger.html b/functions/factory.buildLogger.html index e4ba415..c27defc 100644 --- a/functions/factory.buildLogger.html +++ b/functions/factory.buildLogger.html @@ -1,4 +1,4 @@ buildLogger | @foxxmd/logging Docs

    Function buildLogger

    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.

    See

    Logger

    -
    • buildLogger(defaultLevel, streams, extras?): Logger

    • Parameters

      • defaultLevel:
            | "silent"
            | "fatal"
            | "error"
            | "warn"
            | "info"
            | "log"
            | "verbose"
            | "debug"
            | "trace"
      • streams: LogLevelStreamEntry[]
      • extras: PinoLoggerOptions = {}

      Returns Logger

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/factory.prettyOptsConsoleFactory.html b/functions/factory.prettyOptsConsoleFactory.html index 5aa625c..2454442 100644 --- a/functions/factory.prettyOptsConsoleFactory.html +++ b/functions/factory.prettyOptsConsoleFactory.html @@ -2,4 +2,4 @@

    Source

    const prettyOptsConsoleFactory = (opts: PrettyOptionsExtra = {}): PrettyOptions => prettyOptsFactory({...opts, ...PRETTY_OPTS_CONSOLE_DEFAULTS})
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/factory.prettyOptsFactory.html b/functions/factory.prettyOptsFactory.html index 0c28ba0..3ac4aa7 100644 --- a/functions/factory.prettyOptsFactory.html +++ b/functions/factory.prettyOptsFactory.html @@ -1,2 +1,2 @@ prettyOptsFactory | @foxxmd/logging Docs

    Function prettyOptsFactory

    Builds the opinionated @foxxmd/logging defaults for pino-pretty PrettyOptions and merges them with an optional user-provided PrettyOptions object

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/factory.prettyOptsFileFactory.html b/functions/factory.prettyOptsFileFactory.html index bfd8b07..518e66a 100644 --- a/functions/factory.prettyOptsFileFactory.html +++ b/functions/factory.prettyOptsFileFactory.html @@ -2,4 +2,4 @@

    Source

    const prettyOptsFileFactory = (opts: PrettyOptionsExtra = {}): PrettyOptions => prettyOptsFactory({...opts, ...PRETTY_OPTS_FILE_DEFAULTS})
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/index.childLogger.html b/functions/index.childLogger.html index ec8a6df..2813ed6 100644 --- a/functions/index.childLogger.html +++ b/functions/index.childLogger.html @@ -3,4 +3,4 @@
  • 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: ChildLoggerOptions = {}

    ChildLoggerOptions

    -

    • Returns Logger

    Settings

    Member Visibility
    +

    Returns Logger

    Settings

    Member Visibility
    diff --git a/functions/index.isLogOptions.html b/functions/index.isLogOptions.html index da18dec..f4304a7 100644 --- a/functions/index.isLogOptions.html +++ b/functions/index.isLogOptions.html @@ -1 +1 @@ -isLogOptions | @foxxmd/logging Docs

    Function isLogOptions

    Settings

    Member Visibility
    +isLogOptions | @foxxmd/logging Docs

    Function isLogOptions

    Settings

    Member Visibility
    diff --git a/functions/index.labelFiltersFromEnvSingleton.html b/functions/index.labelFiltersFromEnvSingleton.html index 30b73e8..d182eb9 100644 --- a/functions/index.labelFiltersFromEnvSingleton.html +++ b/functions/index.labelFiltersFromEnvSingleton.html @@ -1 +1 @@ -labelFiltersFromEnvSingleton | @foxxmd/logging Docs

    Function labelFiltersFromEnvSingleton

    Settings

    Member Visibility
    +labelFiltersFromEnvSingleton | @foxxmd/logging Docs

    Function labelFiltersFromEnvSingleton

    Settings

    Member Visibility
    diff --git a/functions/index.labelFiltersFromStr.html b/functions/index.labelFiltersFromStr.html index c9a546c..b69491f 100644 --- a/functions/index.labelFiltersFromStr.html +++ b/functions/index.labelFiltersFromStr.html @@ -1 +1 @@ -labelFiltersFromStr | @foxxmd/logging Docs

    Function labelFiltersFromStr

    • labelFiltersFromStr(str?): RegExp[]

    • Parameters

      • Optionalstr: string

      Returns RegExp[]

    Settings

    Member Visibility
    +labelFiltersFromStr | @foxxmd/logging Docs

    Function labelFiltersFromStr

    • labelFiltersFromStr(str?): RegExp[]

    • Parameters

      • Optionalstr: string

      Returns RegExp[]

    Settings

    Member Visibility
    diff --git a/functions/index.labelsDisableFromEnv.html b/functions/index.labelsDisableFromEnv.html index 277dd83..76ecb13 100644 --- a/functions/index.labelsDisableFromEnv.html +++ b/functions/index.labelsDisableFromEnv.html @@ -1 +1 @@ -labelsDisableFromEnv | @foxxmd/logging Docs

    Function labelsDisableFromEnv

    Settings

    Member Visibility
    +labelsDisableFromEnv | @foxxmd/logging Docs

    Function labelsDisableFromEnv

    Settings

    Member Visibility
    diff --git a/functions/index.labelsDisableFromEnvSingleton.html b/functions/index.labelsDisableFromEnvSingleton.html index 5c72206..bfedbb6 100644 --- a/functions/index.labelsDisableFromEnvSingleton.html +++ b/functions/index.labelsDisableFromEnvSingleton.html @@ -1 +1 @@ -labelsDisableFromEnvSingleton | @foxxmd/logging Docs

    Function labelsDisableFromEnvSingleton

    Settings

    Member Visibility
    +labelsDisableFromEnvSingleton | @foxxmd/logging Docs

    Function labelsDisableFromEnvSingleton

    Settings

    Member Visibility
    diff --git a/functions/index.labelsEnableFromEnv.html b/functions/index.labelsEnableFromEnv.html index 7c5c523..4511f3d 100644 --- a/functions/index.labelsEnableFromEnv.html +++ b/functions/index.labelsEnableFromEnv.html @@ -1 +1 @@ -labelsEnableFromEnv | @foxxmd/logging Docs

    Function labelsEnableFromEnv

    Settings

    Member Visibility
    +labelsEnableFromEnv | @foxxmd/logging Docs

    Function labelsEnableFromEnv

    Settings

    Member Visibility
    diff --git a/functions/index.labelsEnableFromEnvSingleton.html b/functions/index.labelsEnableFromEnvSingleton.html index 739d1be..415c11e 100644 --- a/functions/index.labelsEnableFromEnvSingleton.html +++ b/functions/index.labelsEnableFromEnvSingleton.html @@ -1 +1 @@ -labelsEnableFromEnvSingleton | @foxxmd/logging Docs

    Function labelsEnableFromEnvSingleton

    Settings

    Member Visibility
    +labelsEnableFromEnvSingleton | @foxxmd/logging Docs

    Function labelsEnableFromEnvSingleton

    Settings

    Member Visibility
    diff --git a/functions/index.labelsFilterFromEnv.html b/functions/index.labelsFilterFromEnv.html index 7bfdb74..f33784a 100644 --- a/functions/index.labelsFilterFromEnv.html +++ b/functions/index.labelsFilterFromEnv.html @@ -1 +1 @@ -labelsFilterFromEnv | @foxxmd/logging Docs

    Function labelsFilterFromEnv

    Settings

    Member Visibility
    +labelsFilterFromEnv | @foxxmd/logging Docs

    Function labelsFilterFromEnv

    Settings

    Member Visibility
    diff --git a/functions/index.labelsStrBuilder.html b/functions/index.labelsStrBuilder.html index db2e933..2870a0f 100644 --- a/functions/index.labelsStrBuilder.html +++ b/functions/index.labelsStrBuilder.html @@ -1 +1 @@ -labelsStrBuilder | @foxxmd/logging Docs

    Function labelsStrBuilder

    Settings

    Member Visibility
    +labelsStrBuilder | @foxxmd/logging Docs

    Function labelsStrBuilder

    Settings

    Member Visibility
    diff --git a/functions/index.loggerApp.html b/functions/index.loggerApp.html index 274e179..0d141f2 100644 --- a/functions/index.loggerApp.html +++ b/functions/index.loggerApp.html @@ -1,2 +1,2 @@ loggerApp | @foxxmd/logging Docs

    Function loggerApp

    A Logger that logs to console and a static file

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/index.loggerAppRolling.html b/functions/index.loggerAppRolling.html index 550eb65..257ed37 100644 --- a/functions/index.loggerAppRolling.html +++ b/functions/index.loggerAppRolling.html @@ -1,2 +1,2 @@ loggerAppRolling | @foxxmd/logging Docs

    Function loggerAppRolling

    A Logger that logs to console and a rolling file

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/index.parseLogOptions.html b/functions/index.parseLogOptions.html index cc03c16..5faec27 100644 --- a/functions/index.parseLogOptions.html +++ b/functions/index.parseLogOptions.html @@ -1,2 +1,2 @@ parseLogOptions | @foxxmd/logging Docs

    Function parseLogOptions

    Takes an object and parses it into a fully-populated LogOptions object based on opinionated defaults

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/index.html b/index.html index eb3271e..dbb4d18 100644 --- a/index.html +++ b/index.html @@ -75,9 +75,18 @@

    Filtering By Label

    Logs can be filtered by labels similar to how debug-js works.

    By default no filtering is done. Your child loggers follow the Pino Child Logger behavior of inherting parent log level.

    Using either LOG_FILTER_ENABLE or LOG_FILTER_DISABLE you can enable or disable a child logger and it's children.

    -

    /*
     * process.env.LOG_FILTER_ENABLE = 'Third:Fourth,Second:*:Foo,Bar'
     */

    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'], { level: 'silent' });
    nestedChild2.info('I do not log because of set level and not enabled by filter');

    const nestedChild3 = childLogger(nestedChild2, ['Fourth']);
    nestedChild3.info('I do log because of filter Third:Fourth');

    const nestedChild4 = childLogger(nestedChild3, ['Foo']);
    nestedChild4.info('I do log because of filter Second:*:Foo');

    const nestedChild5 = childLogger(nestedChild4, ['Bar']);
    nestedChild5.info('I do log because of filter Bar');
+

    /*
     * process.env.LOG_FILTER_ENABLE = 'Third:Fourth,Second:*:Foo,Bar'
     */

    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'], { level: 'silent' });
    nestedChild2.info('I do not log because of set level and not enabled by filter');

    // without LOG_FILTER_ENABLE from above set, the below logging would be silent
    // because they inherit the level from their parent

    const nestedChild3 = childLogger(nestedChild2, ['Fourth']);
    nestedChild3.info('I do log because of filter Third:Fourth');

    const nestedChild4 = childLogger(nestedChild3, ['Foo']);
    nestedChild4.info('I do log because of filter Second:*:Foo');

    const nestedChild5 = childLogger(nestedChild4, ['Bar']);
    nestedChild5.info('I do log because of filter Bar');
 
    
 
+
    The minimum level a child logger is "enabled" to is ENV LOG_FILTER_ENABLE_LEVEL or trace, by default. It can also be specified by passing labelEnableLevel to childLogger options.
    
+
    The minimum level a child logger is "disabled" to is ENV LOG_FILTER_DISABLE_LEVEL or silent, by default. It can also be specified by passing labelDisableLevel to childLogger options.
    
+
    There are also options for passing your own function to determine if a child logger should be enabled or disabled. See childLogger docs for full a full reference.
    
+
    A caveat to be aware of: enable/disable by filter is evaluated once, when childLogger is instantiated. This means:
    
+
      
+
    • Only the labels added by childLogger insantiation are applicable. Labels added during logging, IE logger.info({labels: ['Runtime']}, "a log"), are not considered.
      • 
+
    • Labels that are functions are evaluated once, when childLogger is instantiated
      • 
+
    • Changing the LOG_FILTER_* envs after a childLogger is created will have no effect on it
      • 
+
    
 
    Serializing Objects and Errors
    Passing an object or array as the first argument to the logger will cause the object to be JSONified and pretty printed below the log message
    
 
    logger.debug({myProp: 'a string', nested: {anotherProps: ['val1', 'val2'], boolProp: true}}, 'Test');
     /*
    [2024-03-07 11:39:37.687 -0500] DEBUG: Test
      myProp: "a string"
      nested: {
        "anotherProps": [
          "val1",
          "val2"
         ],
       "boolProp": true
      }
      */
 
    
diff --git a/interfaces/index.ChildLoggerOptions.html b/interfaces/index.ChildLoggerOptions.html
index b6bb6be..2c1d1ef 100644
--- a/interfaces/index.ChildLoggerOptions.html
+++ b/interfaces/index.ChildLoggerOptions.html
@@ -1,5 +1,5 @@
-ChildLoggerOptions | @foxxmd/logging Docs
    Interface ChildLoggerOptions
    interface ChildLoggerOptions { 
        labelEnable?: ((labels: ChildLabel[]) => boolean); 
        labelEnableLevel?: 
            | "silent"
            | "fatal"
            | "error"
            | "warn"
            | "info"
            | "log"
            | "verbose"
            | "debug"
            | "trace"; 
        labelDisable?: ((labels: ChildLabel[]) => boolean); 
        labelDisableLevel?: 
            | "silent"
            | "fatal"
            | "error"
            | "warn"
            | "info"
            | "log"
            | "verbose"
            | "debug"
            | "trace"; 
        [key: string]: any; 
    }
    Indexable
    • [key: string]: any
    Properties
    labelEnable?
+ChildLoggerOptions | @foxxmd/logging Docs
    Interface ChildLoggerOptions
    interface ChildLoggerOptions { 
        labelEnable?: ((labels: ChildLabel[]) => boolean); 
        labelEnableLevel?: 
            | "silent"
            | "fatal"
            | "error"
            | "warn"
            | "info"
            | "log"
            | "verbose"
            | "debug"
            | "trace"; 
        labelDisable?: ((labels: ChildLabel[]) => boolean); 
        labelDisableLevel?: 
            | "silent"
            | "fatal"
            | "error"
            | "warn"
            | "info"
            | "log"
            | "verbose"
            | "debug"
            | "trace"; 
        [key: string]: any; 
    }
    Indexable
    • [key: string]: any
    Properties
    labelEnable?
 labelEnableLevel?
 labelDisable?
 labelDisableLevel?
-
     Properties
    OptionallabelEnable
    labelEnable?: ((labels: ChildLabel[]) => boolean)
    OptionallabelEnableLevel
    labelEnableLevel?: 
        | "silent"
        | "fatal"
        | "error"
        | "warn"
        | "info"
        | "log"
        | "verbose"
        | "debug"
        | "trace"
    OptionallabelDisable
    labelDisable?: ((labels: ChildLabel[]) => boolean)
    OptionallabelDisableLevel
    labelDisableLevel?: 
        | "silent"
        | "fatal"
        | "error"
        | "warn"
        | "info"
        | "log"
        | "verbose"
        | "debug"
        | "trace"
    Settings
    Member Visibility
    On This Page
    Properties
    
+
     Properties
    OptionallabelEnable
    labelEnable?: ((labels: ChildLabel[]) => boolean)
    OptionallabelEnableLevel
    labelEnableLevel?: 
        | "silent"
        | "fatal"
        | "error"
        | "warn"
        | "info"
        | "log"
        | "verbose"
        | "debug"
        | "trace"
    OptionallabelDisable
    labelDisable?: ((labels: ChildLabel[]) => boolean)
    OptionallabelDisableLevel
    labelDisableLevel?: 
        | "silent"
        | "fatal"
        | "error"
        | "warn"
        | "info"
        | "log"
        | "verbose"
        | "debug"
        | "trace"
    Settings
    Member Visibility
    On This Page
    Properties
    
diff --git a/interfaces/index.FileLogOptions.html b/interfaces/index.FileLogOptions.html
index 150de09..daaf12d 100644
--- a/interfaces/index.FileLogOptions.html
+++ b/interfaces/index.FileLogOptions.html
@@ -2,7 +2,7 @@
 
    const fileLogger = loggerRollingApp({
      file: {
          level: 'warn', // file will log `warn` and higher
          path: '/my/cool/path/output.log', // output to log file at this path
          frequency: 'daily', // rotate hourly
          size: '20MB', // rotate if file size grows larger than 20MB
          timestamp: 'unix' // use unix epoch timestamp instead of iso8601 in rolling file
      }
    });
 
    
 
-
    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"
            | "trace"; 
    }
    Hierarchy (view full)
    Properties
    size?
+
    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"
            | "trace"; 
    }
    Hierarchy (view full)
    Properties
    size?
 frequency?
 timestamp?
 path?
@@ -13,13 +13,13 @@
 
    Default
    '10MB'
 
    
 
-
    Optionalfrequency
    frequency?: number | "daily" | "hourly"
    The amount of time a given rolling log file is used. Can be combined with size.
    
+
    Optionalfrequency
    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'
 
    
 
-
    Optionaltimestamp
    timestamp?: "unix" | "iso" | "auto"
    For rolling log files
    
+
    Optionaltimestamp
    timestamp?: "unix" | "iso" | "auto"
    For rolling log files
    
 
    When
    
 
      
 
    • value passed to rolling destination is a string (path from LogOptions is a string) and
      • 
@@ -39,7 +39,7 @@
 
    Default
    'auto'
 
    
 
-
    Optionalpath
    path?: string | (() => string)
    The path and filename to use for log files.
    
+
    Optionalpath
    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 logBaseDir (in LoggerAppExtras) which defaults to CWD
    
@@ -47,5 +47,5 @@

    See

    LoggerAppExtras

    -

    Optionallevel

    level?:
        | false
        | "silent"
        | "fatal"
        | "error"
        | "warn"
        | "info"
        | "log"
        | "verbose"
        | "debug"
        | "trace"

    Specify the minimum log level to output to rotating files. If false no log files will be created.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionallevel

    level?:
        | false
        | "silent"
        | "fatal"
        | "error"
        | "warn"
        | "info"
        | "log"
        | "verbose"
        | "debug"
        | "trace"

    Specify the minimum log level to output to rotating files. If false no log files will be created.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/index.LogOptions.html b/interfaces/index.LogOptions.html index eb229a3..4cfb91d 100644 --- a/interfaces/index.LogOptions.html +++ b/interfaces/index.LogOptions.html @@ -2,7 +2,7 @@ 
    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
    });

    const fileLogger = loggerRollingApp({
      console: 'debug', // console will log `debug` and higher
      file: {
          level: 'warn', // file will log `warn` and higher
          path: '/my/cool/path/output.log', // optionally, output to log file at this path
          frequency: 'hourly', // optionally, rotate hourly
      }
    });
    -
    interface LogOptions {
        level?:
            | "silent"
            | "fatal"
            | "error"
            | "warn"
            | "info"
            | "log"
            | "verbose"
            | "debug"
            | "trace";
        file?:
            | false
            | "silent"
            | "fatal"
            | "error"
            | "warn"
            | "info"
            | "log"
            | "verbose"
            | "debug"
            | "trace"
            | FileLogOptions;
        console?:
            | "silent"
            | "fatal"
            | "error"
            | "warn"
            | "info"
            | "log"
            | "verbose"
            | "debug"
            | "trace";
    }

    Properties

    level? +
    interface LogOptions {
        level?:
            | "silent"
            | "fatal"
            | "error"
            | "warn"
            | "info"
            | "log"
            | "verbose"
            | "debug"
            | "trace";
        file?:
            | false
            | "silent"
            | "fatal"
            | "error"
            | "warn"
            | "info"
            | "log"
            | "verbose"
            | "debug"
            | "trace"
            | FileLogOptions;
        console?:
            | "silent"
            | "fatal"
            | "error"
            | "warn"
            | "info"
            | "log"
            | "verbose"
            | "debug"
            | "trace";
    }

    Properties

    level? file? console?

    Properties

    Optionallevel

    level?:
        | "silent"
        | "fatal"
        | "error"
        | "warn"
        | "info"
        | "log"
        | "verbose"
        | "debug"
        | "trace"

    Specify the minimum log level for all log outputs without their own level specified.

    @@ -10,6 +10,6 @@

    Default

    'info'
    -

    Optionalfile

    file?:
        | false
        | "silent"
        | "fatal"
        | "error"
        | "warn"
        | "info"
        | "log"
        | "verbose"
        | "debug"
        | "trace"
        | FileLogOptions

    Specify the minimum log level to output to rotating files or file output options. If false no log files will be created.

    -

    Optionalconsole

    console?:
        | "silent"
        | "fatal"
        | "error"
        | "warn"
        | "info"
        | "log"
        | "verbose"
        | "debug"
        | "trace"

    Specify the minimum log level streamed to the console (or docker container)

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalfile

    file?:
        | false
        | "silent"
        | "fatal"
        | "error"
        | "warn"
        | "info"
        | "log"
        | "verbose"
        | "debug"
        | "trace"
        | FileLogOptions

    Specify the minimum log level to output to rotating files or file output options. If false no log files will be created.

    +

    Optionalconsole

    console?:
        | "silent"
        | "fatal"
        | "error"
        | "warn"
        | "info"
        | "log"
        | "verbose"
        | "debug"
        | "trace"

    Specify the minimum log level streamed to the console (or docker container)

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/index.LoggerAppExtras.html b/interfaces/index.LoggerAppExtras.html index 2289e76..1c91b89 100644 --- a/interfaces/index.LoggerAppExtras.html +++ b/interfaces/index.LoggerAppExtras.html @@ -1,5 +1,5 @@ LoggerAppExtras | @foxxmd/logging Docs

    Interface LoggerAppExtras

    Additional settings and Pino Transports to apply to the returned Logger.

    -
    interface LoggerAppExtras {
        logBaseDir?: string;
        logDefaultPath?: string;
        pretty?: PrettyOptionsExtra;
        destinations?: LogLevelStreamEntry[];
        pino?: PinoLoggerOptions;
    }

    Hierarchy (view full)

    Properties

    logBaseDir? +
    interface LoggerAppExtras {
        logBaseDir?: string;
        logDefaultPath?: string;
        pretty?: PrettyOptionsExtra;
        destinations?: LogLevelStreamEntry[];
        pino?: PinoLoggerOptions;
    }

    Hierarchy (view full)

    Properties

    logBaseDir? logDefaultPath? pretty? destinations? @@ -9,13 +9,13 @@

    Default

    'CWD'
    -

    OptionallogDefaultPath

    logDefaultPath?: string

    The default path to use when parsing file logging options.

    +

    OptionallogDefaultPath

    logDefaultPath?: string

    The default path to use when parsing file logging options.

    If this path is relative it is joined with logBaseDir

    See

    FileOptions

    Default

    './logs/app.log'
    -

    Optionalpretty

    pretty?: PrettyOptionsExtra

    Additional pino-pretty options that are applied to the built-in console/log streams

    -

    Optionaldestinations

    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

    -

    Optionalpino

    pino?: PinoLoggerOptions

    Additional Pino Log options that are passed to pino() on logger creation

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalpretty

    pretty?: PrettyOptionsExtra

    Additional pino-pretty options that are applied to the built-in console/log streams

    +

    Optionaldestinations

    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

    +

    Optionalpino

    pino?: PinoLoggerOptions

    Additional Pino Log options that are passed to pino() on logger creation

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/index.PrettyOptionsExtra.html b/interfaces/index.PrettyOptionsExtra.html index 0ea497d..cf09d76 100644 --- a/interfaces/index.PrettyOptionsExtra.html +++ b/interfaces/index.PrettyOptionsExtra.html @@ -1,5 +1,5 @@ PrettyOptionsExtra | @foxxmd/logging Docs

    Interface PrettyOptionsExtra

    pino-pretty options and additional options specific to how @foxxmd/logging uses pino-pretty

    -
    interface PrettyOptionsExtra {
        hideObject?: boolean;
        translateTime?: string | boolean;
        levelFirst?: boolean;
        levelKey?: string;
        levelLabel?: string;
        messageKey?: string;
        singleLine?: boolean;
        timestampKey?: string;
        minimumLevel?: Level;
        messageFormat?: string | false | MessageFormatFunc;
        colorize?: boolean;
        colorizeObjects?: boolean;
        crlf?: boolean;
        errorLikeObjectKeys?: string[];
        errorProps?: string;
        ignore?: string;
        include?: string;
        sync?: boolean;
        destination?:
            | string
            | number
            | DestinationStream
            | WritableStream;
        append?: boolean;
        mkdir?: boolean;
        customPrettifiers?: Record<string, Prettifier<object>> & {
            level?: Prettifier<LevelPrettifierExtras>;
        };
        customColors?: string | object;
        useOnlyCustomProps?: boolean;
        redactCwd?: boolean;
        padLevels?: boolean;
    }

    Hierarchy (view full)

    Properties

    hideObject? +
    interface PrettyOptionsExtra {
        hideObject?: boolean;
        translateTime?: string | boolean;
        levelFirst?: boolean;
        levelKey?: string;
        levelLabel?: string;
        messageKey?: string;
        singleLine?: boolean;
        timestampKey?: string;
        minimumLevel?: Level;
        messageFormat?: string | false | MessageFormatFunc;
        colorize?: boolean;
        colorizeObjects?: boolean;
        crlf?: boolean;
        errorLikeObjectKeys?: string[];
        errorProps?: string;
        ignore?: string;
        include?: string;
        sync?: boolean;
        destination?:
            | string
            | number
            | DestinationStream
            | WritableStream;
        append?: boolean;
        mkdir?: boolean;
        customPrettifiers?: Record<string, Prettifier<object>> & {
            level?: Prettifier<LevelPrettifierExtras>;
        };
        customColors?: string | object;
        useOnlyCustomProps?: boolean;
        redactCwd?: boolean;
        padLevels?: boolean;
    }

    Hierarchy (view full)

    Properties

    hideObject? translateTime? levelFirst? levelKey? @@ -150,8 +150,8 @@ Also supports 'default' as level_name for fallback color.

    Default

    true
    -

    OptionalpadLevels

    padLevels?: boolean

    Pads levels in log string so all are the same length

    +

    OptionalpadLevels

    padLevels?: boolean

    Pads levels in log string so all are the same length

    Default

    true
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/index._internal_.FileLogOptionsStrong.html b/interfaces/index._internal_.FileLogOptionsStrong.html index a155889..920f1fa 100644 --- a/interfaces/index._internal_.FileLogOptionsStrong.html +++ b/interfaces/index._internal_.FileLogOptionsStrong.html @@ -2,7 +2,7 @@ 
    const fileLogger = loggerRollingApp({
      file: {
          level: 'warn', // file will log `warn` and higher
          path: '/my/cool/path/output.log', // output to log file at this path
          frequency: 'daily', // rotate hourly
          size: '20MB', // rotate if file size grows larger than 20MB
          timestamp: 'unix' // use unix epoch timestamp instead of iso8601 in rolling file
      }
    });
    -
    interface FileLogOptionsStrong {
        size?: string | number;
        frequency?: number | "daily" | "hourly";
        timestamp?: "unix" | "iso" | "auto";
        level:
            | "silent"
            | "fatal"
            | "error"
            | "warn"
            | "info"
            | "log"
            | "verbose"
            | "debug"
            | "trace";
        path: string | (() => string);
    }

    Hierarchy (view full)

    Properties

    size? +
    interface FileLogOptionsStrong {
        size?: string | number;
        frequency?: number | "daily" | "hourly";
        timestamp?: "unix" | "iso" | "auto";
        level:
            | "silent"
            | "fatal"
            | "error"
            | "warn"
            | "info"
            | "log"
            | "verbose"
            | "debug"
            | "trace";
        path: string | (() => string);
    }

    Hierarchy (view full)

    Properties

    size? frequency? timestamp? level @@ -13,13 +13,13 @@

    Default

    '10MB'
    -

    Optionalfrequency

    frequency?: number | "daily" | "hourly"

    The amount of time a given rolling log file is used. Can be combined with size.

    +

    Optionalfrequency

    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'
    -

    Optionaltimestamp

    timestamp?: "unix" | "iso" | "auto"

    For rolling log files

    +

    Optionaltimestamp

    timestamp?: "unix" | "iso" | "auto"

    For rolling log files

    When

    • value passed to rolling destination is a string (path from LogOptions is a string) and
      • @@ -39,8 +39,8 @@

    Default

    'auto'
    -

    level

    level:
        | "silent"
        | "fatal"
        | "error"
        | "warn"
        | "info"
        | "log"
        | "verbose"
        | "debug"
        | "trace"

    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"
        | "trace"

    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 logBaseDir (in LoggerAppExtras) which defaults to CWD

    @@ -48,4 +48,4 @@

    See

    LoggerAppExtras

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/index._internal_.FileLogPathOptions.html b/interfaces/index._internal_.FileLogPathOptions.html index c8ead43..05bb2bd 100644 --- a/interfaces/index._internal_.FileLogPathOptions.html +++ b/interfaces/index._internal_.FileLogPathOptions.html @@ -1,14 +1,14 @@ -FileLogPathOptions | @foxxmd/logging Docs

    Interface FileLogPathOptions

    interface FileLogPathOptions {
        logBaseDir?: string;
        logDefaultPath?: string;
    }

    Hierarchy (view full)

    Properties

    logBaseDir? +FileLogPathOptions | @foxxmd/logging Docs

    Interface FileLogPathOptions

    interface FileLogPathOptions {
        logBaseDir?: string;
        logDefaultPath?: string;
    }

    Hierarchy (view full)

    Properties

    logBaseDir? logDefaultPath?

    Properties

    OptionallogBaseDir

    logBaseDir?: string

    The base path to use when parsing file logging options.

    See

    FileOptions

    Default

    'CWD'
    -

    OptionallogDefaultPath

    logDefaultPath?: string

    The default path to use when parsing file logging options.

    +

    OptionallogDefaultPath

    logDefaultPath?: string

    The default path to use when parsing file logging options.

    If this path is relative it is joined with logBaseDir

    See

    FileOptions

    Default

    './logs/app.log'
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/index._internal_.FileOptions.html b/interfaces/index._internal_.FileOptions.html index 23fb701..0fe3fae 100644 --- a/interfaces/index._internal_.FileOptions.html +++ b/interfaces/index._internal_.FileOptions.html @@ -2,7 +2,7 @@ 
    const fileLogger = loggerRollingApp({
      file: {
          level: 'warn', // file will log `warn` and higher
          path: '/my/cool/path/output.log', // output to log file at this path
          frequency: 'daily', // rotate hourly
          size: '20MB', // rotate if file size grows larger than 20MB
          timestamp: 'unix' // use unix epoch timestamp instead of iso8601 in rolling file
      }
    });
    -
    interface FileOptions {
        size?: string | number;
        frequency?: number | "daily" | "hourly";
        timestamp?: "unix" | "iso" | "auto";
        path?: string | (() => string);
    }

    Hierarchy (view full)

    Properties

    size? +
    interface FileOptions {
        size?: string | number;
        frequency?: number | "daily" | "hourly";
        timestamp?: "unix" | "iso" | "auto";
        path?: string | (() => string);
    }

    Hierarchy (view full)

    Properties

    size? frequency? timestamp? path? @@ -12,13 +12,13 @@

    Default

    '10MB'
    -

    Optionalfrequency

    frequency?: number | "daily" | "hourly"

    The amount of time a given rolling log file is used. Can be combined with size.

    +

    Optionalfrequency

    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'
    -

    Optionaltimestamp

    timestamp?: "unix" | "iso" | "auto"

    For rolling log files

    +

    Optionaltimestamp

    timestamp?: "unix" | "iso" | "auto"

    For rolling log files

    When

    • value passed to rolling destination is a string (path from LogOptions is a string) and
      • @@ -38,7 +38,7 @@

    Default

    'auto'
    -

    Optionalpath

    path?: string | (() => string)

    The path and filename to use for log files.

    +

    Optionalpath

    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 logBaseDir (in LoggerAppExtras) which defaults to CWD

    @@ -46,4 +46,4 @@

    See

    LoggerAppExtras

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/index._internal_.PinoRollOptions.html b/interfaces/index._internal_.PinoRollOptions.html index 12cc01b..6285b72 100644 --- a/interfaces/index._internal_.PinoRollOptions.html +++ b/interfaces/index._internal_.PinoRollOptions.html @@ -1,4 +1,4 @@ -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

    Optionalsize

    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.

    @@ -6,10 +6,10 @@

    Default

    '10MB'
    -

    Optionalfrequency

    frequency?: number | "daily" | "hourly"

    The amount of time a given rolling log file is used. Can be combined with size.

    +

    Optionalfrequency

    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

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/index._internal_.RollOptions.html b/interfaces/index._internal_.RollOptions.html index 23c448b..c1edc0c 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

    Optionaltimestamp

    timestamp?: "unix" | "iso" | "auto"

    For rolling log files

    When

      @@ -19,4 +19,4 @@

    Default

    'auto'
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/modules/factory.html b/modules/factory.html index c8ea2a9..5f6255d 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 JsonPrettyDestination diff --git a/modules/index.html b/modules/index.html index 94bfa4f..de46774 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

    ChildLoggerOptions LogOptions FileLogOptions diff --git a/types/factory.FileDestination.html b/types/factory.FileDestination.html index c543fa6..58e63e5 100644 --- a/types/factory.FileDestination.html +++ b/types/factory.FileDestination.html @@ -1 +1 @@ -FileDestination | @foxxmd/logging Docs

    Type Alias FileDestination

    FileDestination: Omit<PrettyOptionsExtra, "destination" | "sync"> & FileOptionsParsed

    Settings

    Member Visibility
    +FileDestination | @foxxmd/logging Docs

    Type Alias FileDestination

    FileDestination: Omit<PrettyOptionsExtra, "destination" | "sync"> & FileOptionsParsed

    Settings

    Member Visibility
    diff --git a/types/factory.JsonPrettyDestination.html b/types/factory.JsonPrettyDestination.html index 5521689..918f85b 100644 --- a/types/factory.JsonPrettyDestination.html +++ b/types/factory.JsonPrettyDestination.html @@ -1,2 +1,2 @@ JsonPrettyDestination | @foxxmd/logging Docs

    Type Alias JsonPrettyDestination

    JsonPrettyDestination: StreamDestination & {
        object?: boolean;
    }

    Type declaration

    • Optionalobject?: boolean

      Specify if the stream should output log as object or stringified JSON

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/types/factory.StreamDestination.html b/types/factory.StreamDestination.html index c42e2ee..13e9c06 100644 --- a/types/factory.StreamDestination.html +++ b/types/factory.StreamDestination.html @@ -1 +1 @@ -StreamDestination | @foxxmd/logging Docs

    Type Alias StreamDestination

    StreamDestination: Omit<PrettyOptionsExtra, "destination"> & {
        destination: number | DestinationStream | WritableStream;
    }

    Settings

    Member Visibility
    +StreamDestination | @foxxmd/logging Docs

    Type Alias StreamDestination

    StreamDestination: Omit<PrettyOptionsExtra, "destination"> & {
        destination: number | DestinationStream | WritableStream;
    }

    Settings

    Member Visibility
    diff --git a/types/factory._internal_.FileOptionsParsed.html b/types/factory._internal_.FileOptionsParsed.html index 743050a..2c286d2 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
    +FileOptionsParsed | @foxxmd/logging Docs

    Type Alias FileOptionsParsed

    FileOptionsParsed: MarkRequired<FileOptions, "path">

    Settings

    Member Visibility
    diff --git a/types/factory._internal_.PinoLoggerOptions.html b/types/factory._internal_.PinoLoggerOptions.html index 18b2898..ecbf257 100644 --- a/types/factory._internal_.PinoLoggerOptions.html +++ b/types/factory._internal_.PinoLoggerOptions.html @@ -1,2 +1,2 @@ PinoLoggerOptions | @foxxmd/logging Docs

    Type Alias PinoLoggerOptions

    PinoLoggerOptions: Omit<LoggerOptions,
        | "level"
        | "mixin"
        | "mixinMergeStrategy"
        | "customLevels"
        | "useOnlyCustomLevels"
        | "transport">

    Additional Pino Log options that are passed to pino() on logger creation

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/types/index.LogData.html b/types/index.LogData.html index 868c4c3..17f1917 100644 --- a/types/index.LogData.html +++ b/types/index.LogData.html @@ -1,2 +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;
    }

    The structure of a Log object when returned by a stream data event

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/types/index.LogDataPretty.html b/types/index.LogDataPretty.html index 93a02e5..027b025 100644 --- a/types/index.LogDataPretty.html +++ b/types/index.LogDataPretty.html @@ -1 +1 @@ -LogDataPretty | @foxxmd/logging Docs

    Type Alias LogDataPretty

    LogDataPretty: LogData & {
        line: string;
    }

    Settings

    Member Visibility
    +LogDataPretty | @foxxmd/logging Docs

    Type Alias LogDataPretty

    LogDataPretty: LogData & {
        line: string;
    }

    Settings

    Member Visibility
    diff --git a/types/index.LogLevel.html b/types/index.LogLevel.html index 80148b2..7a34eb2 100644 --- a/types/index.LogLevel.html +++ b/types/index.LogLevel.html @@ -12,4 +12,4 @@
  • silent (will never output anything)

    • When used in LogOptions specifies the minimum level the output should log at.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/types/index.LogLevelStreamEntry.html b/types/index.LogLevelStreamEntry.html index 344b92e..3ea1daa 100644 --- a/types/index.LogLevelStreamEntry.html +++ b/types/index.LogLevelStreamEntry.html @@ -1,3 +1,3 @@ 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
    +

    Settings

    Member Visibility
    diff --git a/types/index.Logger.html b/types/index.Logger.html index 4e5fcaa..e13dd0c 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: any) => void);
    }

    Settings

    Member Visibility
    +Logger | @foxxmd/logging Docs

    Type Alias Logger

    Logger: Logger<LogLevel> & {
        labels: any[];
        addLabel: ((value: any) => void);
    }

    Settings

    Member Visibility
    diff --git a/types/index._internal_.ChildLabel.html b/types/index._internal_.ChildLabel.html index 1d831f7..4f51a8b 100644 --- a/types/index._internal_.ChildLabel.html +++ b/types/index._internal_.ChildLabel.html @@ -1 +1 @@ -ChildLabel | @foxxmd/logging Docs

    Type Alias ChildLabel

    ChildLabel: string | CallableFunction

    Settings

    Member Visibility
    +ChildLabel | @foxxmd/logging Docs

    Type Alias ChildLabel

    ChildLabel: string | CallableFunction

    Settings

    Member Visibility
    diff --git a/types/index._internal_.FileLogOptionsParsed.html b/types/index._internal_.FileLogOptionsParsed.html index bda37d4..b1cfc7e 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
    +FileLogOptionsParsed | @foxxmd/logging Docs

    Type Alias FileLogOptionsParsed

    FileLogOptionsParsed: Omit<FileLogOptions, "file"> & {
        level: false;
    } | FileLogOptionsStrong

    Settings

    Member Visibility
    diff --git a/types/index._internal_.FilterLabelsFunc.html b/types/index._internal_.FilterLabelsFunc.html index 7156b5d..833319c 100644 --- a/types/index._internal_.FilterLabelsFunc.html +++ b/types/index._internal_.FilterLabelsFunc.html @@ -1 +1 @@ -FilterLabelsFunc | @foxxmd/logging Docs

    Type Alias FilterLabelsFunc

    FilterLabelsFunc: ((labels: ChildLabel[]) => boolean)

    Settings

    Member Visibility
    +FilterLabelsFunc | @foxxmd/logging Docs

    Type Alias FilterLabelsFunc

    FilterLabelsFunc: ((labels: ChildLabel[]) => boolean)

    Settings

    Member Visibility
    diff --git a/types/index._internal_.LogOptionsParsed.html b/types/index._internal_.LogOptionsParsed.html index f233215..a3a3434 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;
    }

    Settings

    Member Visibility
    +LogOptionsParsed | @foxxmd/logging Docs

    Type Alias LogOptionsParsed

    LogOptionsParsed: Omit<Required<LogOptions>, "file"> & {
        file: FileLogOptionsParsed;
    }

    Settings

    Member Visibility
    diff --git a/variables/factory.PRETTY_COLORS.html b/variables/factory.PRETTY_COLORS.html index dd22b13..f1696a4 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
    +

    Settings

    Member Visibility
    diff --git a/variables/factory.PRETTY_COLORS_STR.html b/variables/factory.PRETTY_COLORS_STR.html index 0c12caa..7e9e45e 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
    +

    Settings

    Member Visibility
    diff --git a/variables/factory.PRETTY_ISO8601.html b/variables/factory.PRETTY_ISO8601.html index 3b15553..f65ff85 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
    +

    Settings

    Member Visibility
    diff --git a/variables/factory.PRETTY_OPTS_CONSOLE.html b/variables/factory.PRETTY_OPTS_CONSOLE.html index e40a8ba..0324fb8 100644 --- a/variables/factory.PRETTY_OPTS_CONSOLE.html +++ b/variables/factory.PRETTY_OPTS_CONSOLE.html @@ -2,4 +2,4 @@

    Source

    const PRETTY_OPTS_CONSOLE: PrettyOptions = prettyOptsConsoleFactory()
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/factory.PRETTY_OPTS_FILE.html b/variables/factory.PRETTY_OPTS_FILE.html index ea5f721..d4924a3 100644 --- a/variables/factory.PRETTY_OPTS_FILE.html +++ b/variables/factory.PRETTY_OPTS_FILE.html @@ -2,4 +2,4 @@

    Source

    const PRETTY_OPTS_FILE: PrettyOptions = prettyOptsFileFactory()
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/index.LOG_LEVEL_NAMES.html b/variables/index.LOG_LEVEL_NAMES.html index b6693f7..6229a3e 100644 --- a/variables/index.LOG_LEVEL_NAMES.html +++ b/variables/index.LOG_LEVEL_NAMES.html @@ -1 +1 @@ -LOG_LEVEL_NAMES | @foxxmd/logging Docs

    Variable LOG_LEVEL_NAMESConst

    LOG_LEVEL_NAMES: readonly ["silent", "fatal", "error", "warn", "info", "log", "verbose", "debug", "trace"] = ...

    Settings

    Member Visibility
    +LOG_LEVEL_NAMES | @foxxmd/logging Docs

    Variable LOG_LEVEL_NAMESConst

    LOG_LEVEL_NAMES: readonly ["silent", "fatal", "error", "warn", "info", "log", "verbose", "debug", "trace"] = ...

    Settings

    Member Visibility
    diff --git a/variables/index.loggerDebug.html b/variables/index.loggerDebug.html index 90607ff..fdcd5a0 100644 --- a/variables/index.loggerDebug.html +++ b/variables/index.loggerDebug.html @@ -2,4 +2,4 @@

    Source

    const loggerDebug = buildLogger('debug', [buildDestinationStdout('trace')])
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/index.loggerTest.html b/variables/index.loggerTest.html index e912d01..c72920a 100644 --- a/variables/index.loggerTest.html +++ b/variables/index.loggerTest.html @@ -2,4 +2,4 @@

    Source

    const loggerTest = buildLogger('silent', [buildDestinationStdout('trace')])
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/index.loggerTrace.html b/variables/index.loggerTrace.html index d969f04..e376c63 100644 --- a/variables/index.loggerTrace.html +++ b/variables/index.loggerTrace.html @@ -2,4 +2,4 @@

    Source

    const loggerTrace = buildLogger('trace', [buildDestinationStdout('trace')])
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    -- 2.51.2