From 1b491d3e432884674d74fd0338e300fc7473c047 Mon Sep 17 00:00:00 2001 From: FoxxMD Date: Mon, 11 Mar 2024 19:12:41 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20FoxxMD/l?= =?UTF-8?q?ogging@0d03411d111beee0a087b0f7917844c66cedee56=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 +- 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.loggerApp.html | 2 +- functions/index.loggerAppRolling.html | 2 +- functions/index.parseLogOptions.html | 2 +- interfaces/index.FileLogOptions.html | 12 ++++++------ interfaces/index.LogOptions.html | 8 ++++---- interfaces/index.LoggerAppExtras.html | 8 ++++---- interfaces/index.PrettyOptionsExtra.html | 6 +++--- .../index._internal_.FileLogOptionsStrong.html | 12 ++++++------ 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.StreamDestination.html | 2 +- types/factory._internal_.FileOptionsParsed.html | 2 +- types/factory._internal_.PinoLoggerOptions.html | 2 +- types/index.LogData.html | 2 +- types/index.LogLevel.html | 2 +- types/index.LogLevelStreamEntry.html | 2 +- types/index.Logger.html | 2 +- types/index._internal_.FileLogOptionsParsed.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 +- 42 files changed, 67 insertions(+), 67 deletions(-) diff --git a/functions/factory.buildDestinationFile.html b/functions/factory.buildDestinationFile.html index 0396bcf..96359c9 100644 --- a/functions/factory.buildDestinationFile.html +++ b/functions/factory.buildDestinationFile.html @@ -1,2 +1,2 @@ buildDestinationFile | @foxxmd/logging Docs

Function buildDestinationFile

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns LogLevelStreamEntry

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 0b5272a..13ac5b7 100644 --- a/functions/factory.buildDestinationRollingFile.html +++ b/functions/factory.buildDestinationRollingFile.html @@ -1,2 +1,2 @@ buildDestinationRollingFile | @foxxmd/logging Docs

Function buildDestinationRollingFile

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<LogLevelStreamEntry>

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 4dbf2b9..b918390 100644 --- a/functions/factory.buildDestinationStderr.html +++ b/functions/factory.buildDestinationStderr.html @@ -2,4 +2,4 @@

Parameters

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 +

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 fc6a313..49291bc 100644 --- a/functions/factory.buildDestinationStdout.html +++ b/functions/factory.buildDestinationStdout.html @@ -2,4 +2,4 @@

Parameters

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 +

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 9309c50..e1e566f 100644 --- a/functions/factory.buildDestinationStream.html +++ b/functions/factory.buildDestinationStream.html @@ -1,3 +1,3 @@ buildDestinationStream | @foxxmd/logging Docs

Function buildDestinationStream

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/functions/factory.buildLogger.html b/functions/factory.buildLogger.html index d93664b..10d891d 100644 --- a/functions/factory.buildLogger.html +++ b/functions/factory.buildLogger.html @@ -1,4 +1,4 @@ buildLogger | @foxxmd/logging Docs

Function buildLogger

  • buildLogger(defaultLevel, streams, extras?): 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

    Returns Logger

    See

    Logger

    -

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/functions/factory.prettyOptsConsoleFactory.html b/functions/factory.prettyOptsConsoleFactory.html index 8528d74..bf91e70 100644 --- a/functions/factory.prettyOptsConsoleFactory.html +++ b/functions/factory.prettyOptsConsoleFactory.html @@ -1,4 +1,4 @@ prettyOptsConsoleFactory | @foxxmd/logging Docs

Function prettyOptsConsoleFactory

  • prettyOptsConsoleFactory(opts?): PrettyOptions_

  • Generate pino-pretty PrettyOptions for use with console/stream output

    Parameters

    Returns PrettyOptions_

    Source

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

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/functions/factory.prettyOptsFactory.html b/functions/factory.prettyOptsFactory.html index b967e2e..82f51d4 100644 --- a/functions/factory.prettyOptsFactory.html +++ b/functions/factory.prettyOptsFactory.html @@ -1,2 +1,2 @@ prettyOptsFactory | @foxxmd/logging Docs

Function prettyOptsFactory

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns PrettyOptions_

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.prettyOptsFileFactory.html b/functions/factory.prettyOptsFileFactory.html index 21d403d..43e7810 100644 --- a/functions/factory.prettyOptsFileFactory.html +++ b/functions/factory.prettyOptsFileFactory.html @@ -1,4 +1,4 @@ prettyOptsFileFactory | @foxxmd/logging Docs

Function prettyOptsFileFactory

  • prettyOptsFileFactory(opts?): PrettyOptions_

  • Generate pino-pretty PrettyOptions for use with file output

    Parameters

    Returns PrettyOptions_

    Source

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

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/functions/index.childLogger.html b/functions/index.childLogger.html index 1ad1143..b983600 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: {} = {}

    object

    -

    • Returns Logger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    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 4705e7b..09af509 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 3ac54a5..854d2e8 100644 --- a/functions/index.loggerApp.html +++ b/functions/index.loggerApp.html @@ -1,2 +1,2 @@ loggerApp | @foxxmd/logging Docs

    Function loggerApp

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Logger

    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 919fb6a..d99e09c 100644 --- a/functions/index.loggerAppRolling.html +++ b/functions/index.loggerAppRolling.html @@ -1,2 +1,2 @@ loggerAppRolling | @foxxmd/logging Docs

    Function loggerAppRolling

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<Logger>

    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 7ab071a..a8f86fa 100644 --- a/functions/index.parseLogOptions.html +++ b/functions/index.parseLogOptions.html @@ -1,2 +1,2 @@ parseLogOptions | @foxxmd/logging Docs

    Function parseLogOptions

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns LogOptionsParsed

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.FileLogOptions.html b/interfaces/index.FileLogOptions.html index 778d1b9..4d349ef 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 3da68ae..98cfc79 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 72be8eb..2ef7b38 100644 --- a/interfaces/index.LoggerAppExtras.html +++ b/interfaces/index.LoggerAppExtras.html @@ -1,7 +1,7 @@ -LoggerAppExtras | @foxxmd/logging Docs

    Interface LoggerAppExtras

    interface LoggerAppExtras {
        pretty?: PrettyOptionsExtra;
        destinations?: LogLevelStreamEntry[];
        pino?: PinoLoggerOptions;
    }

    Properties

    pretty? +LoggerAppExtras | @foxxmd/logging Docs

    Interface LoggerAppExtras

    interface LoggerAppExtras {
        pretty?: PrettyOptionsExtra;
        destinations?: LogLevelStreamEntry[];
        pino?: PinoLoggerOptions;
    }

    Properties

    pretty? destinations? pino?

    Properties

    Optional pretty

    pretty?: PrettyOptionsExtra

    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

    -

    Optional pino

    pino?: PinoLoggerOptions

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    prettydestinationspino

    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

    +

    Optional pino

    pino?: PinoLoggerOptions

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

    +

    Settings

    Member Visibility

    Theme

    On This Page

    prettydestinationspino

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.PrettyOptionsExtra.html b/interfaces/index.PrettyOptionsExtra.html index 987ed3f..7f638b0 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;
        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;
        redactCwd?: boolean;
        padLevels?: boolean;
    }

    Hierarchy (view full)

    Properties

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

    NOTE: Only applies to log message and errors. If you need to redact arbitrary properties you should use pino's redact or pino-pretty's customPrettifiers

    Default

    true
    -

    Optional padLevels

    padLevels?: boolean

    Pads levels in log string so all are the same length

    +

    Optional padLevels

    padLevels?: boolean

    Pads levels in log string so all are the same length

    Default

    true
    -

    Settings

    Member Visibility

    Theme

    On This Page

    hideObjecttranslateTimelevelFirstlevelKeylevelLabelmessageKeysingleLinetimestampKeyminimumLevelmessageFormatcolorizecolorizeObjectscrlferrorLikeObjectKeyserrorPropsignoreincludesyncdestinationappendmkdircustomPrettifierscustomColorsredactCwdpadLevels

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    hideObjecttranslateTimelevelFirstlevelKeylevelLabelmessageKeysingleLinetimestampKeyminimumLevelmessageFormatcolorizecolorizeObjectscrlferrorLikeObjectKeyserrorPropsignoreincludesyncdestinationappendmkdircustomPrettifierscustomColorsredactCwdpadLevels

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index._internal_.FileLogOptionsStrong.html b/interfaces/index._internal_.FileLogOptionsStrong.html index c47624c..84151eb 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 154ee84..a039f45 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 692e182..a15b07a 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 d4533ea..42260f8 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 63eea11..74ea132 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_OPTS_CONSOLE diff --git a/modules/index.html b/modules/index.html index 0a93291..65db7d4 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 762288e..cab0079 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

    Theme

    Generated using TypeDoc

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

    Type alias FileDestination

    FileDestination: Omit<PrettyOptionsExtra, "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 29b8792..d3d418e 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;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias StreamDestination

    StreamDestination: Omit<PrettyOptionsExtra, "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 565d76b..f536fb2 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/factory._internal_.PinoLoggerOptions.html b/types/factory._internal_.PinoLoggerOptions.html index 319257c..dbea5f9 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

    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/types/index.LogData.html b/types/index.LogData.html index 4518219..d20b1c4 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 | 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 +

    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 6bde267..04ae982 100644 --- a/types/index.LogLevel.html +++ b/types/index.LogLevel.html @@ -1 +1 @@ -LogLevel | @foxxmd/logging Docs

    Type alias LogLevel

    LogLevel: typeof LOG_LEVEL_NAMES[number]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias LogLevel

    LogLevel: typeof LOG_LEVEL_NAMES[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 9b1ab5c..6c63632 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

    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/types/index.Logger.html b/types/index.Logger.html index 505a732..6fdba12 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 2d0e1f6..a3bdbcc 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 3353cb6..7b226ff 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 b331f20..95d4315 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 +

    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 6d6042e..b48f011 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 +

    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 8ea8d17..2349499 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_OPTS_CONSOLE.html b/variables/factory.PRETTY_OPTS_CONSOLE.html index c9f50ce..957317c 100644 --- a/variables/factory.PRETTY_OPTS_CONSOLE.html +++ b/variables/factory.PRETTY_OPTS_CONSOLE.html @@ -1,4 +1,4 @@ PRETTY_OPTS_CONSOLE | @foxxmd/logging Docs

    Variable PRETTY_OPTS_CONSOLEConst

    PRETTY_OPTS_CONSOLE: PrettyOptions_ = ...

    Pre-defined pino-pretty PrettyOptions for use with console/stream output

    Source

    const PRETTY_OPTS_CONSOLE: PrettyOptions = prettyOptsConsoleFactory()
    -

    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_OPTS_FILE.html b/variables/factory.PRETTY_OPTS_FILE.html index adeaccf..071d974 100644 --- a/variables/factory.PRETTY_OPTS_FILE.html +++ b/variables/factory.PRETTY_OPTS_FILE.html @@ -1,4 +1,4 @@ PRETTY_OPTS_FILE | @foxxmd/logging Docs

    Variable PRETTY_OPTS_FILEConst

    PRETTY_OPTS_FILE: PrettyOptions_ = ...

    Pre-defined pino-pretty PrettyOptions for use with file output

    Source

    const PRETTY_OPTS_FILE: PrettyOptions = prettyOptsFileFactory()
    -

    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_LEVEL_NAMES.html b/variables/index.LOG_LEVEL_NAMES.html index 3aee2c2..bb08191 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"] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable LOG_LEVEL_NAMESConst

    LOG_LEVEL_NAMES: 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 196ac42..8024ff8 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 951e16c..6c7f87b 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