diff --git a/assets/highlight.css b/assets/highlight.css index c8f854a..9010506 100644 --- a/assets/highlight.css +++ b/assets/highlight.css @@ -17,6 +17,8 @@ --dark-hl-7: #6A9955; --light-hl-8: #267F99; --dark-hl-8: #4EC9B0; + --light-hl-9: #CD3131; + --dark-hl-9: #F44747; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -31,6 +33,7 @@ --hl-6: var(--light-hl-6); --hl-7: var(--light-hl-7); --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); --code-background: var(--light-code-background); } } @@ -44,6 +47,7 @@ --hl-6: var(--dark-hl-6); --hl-7: var(--dark-hl-7); --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); --code-background: var(--dark-code-background); } } @@ -57,6 +61,7 @@ --hl-6: var(--light-hl-6); --hl-7: var(--light-hl-7); --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); --code-background: var(--light-code-background); } @@ -70,6 +75,7 @@ --hl-6: var(--dark-hl-6); --hl-7: var(--dark-hl-7); --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); --code-background: var(--dark-code-background); } @@ -82,4 +88,5 @@ .hl-6 { color: var(--hl-6); } .hl-7 { color: var(--hl-7); } .hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } pre, code { background: var(--code-background); } diff --git a/assets/search.js b/assets/search.js index 72070c9..281af25 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA61YXY+bOhD9L3NfrTRjEhJ4q+5uq0orrdRWfUHRig1Oii4BBGRvV1H+e2UgeExsEpJ9TDgfwxx7wBygyP4vwQ8O8F+cRuBzBmm4E+BDnEbiDzDYFwn4sMuifSLKT/W/k9/VLgEG6yQsS1GCD3Bk5wqbcF1lxfuZRvv/sMrUW+BcaT1l260oOqnqPe+KaS4Z1BjkYSHSqruZQfkn8SaSH1Uhwt1jWpGye1593EjjuUtNn/MqztKy84rTShSbcE0NW8w4H5zyWWeUyJKv9vjnBB9wIhyb6SZOxPWeLfo+y3WWltkYV0UYbWxYQQ9hFdpWjbz2MUt0cF2Os3CI+vPXl6fHX49PPzr9t7CIw1e16RVknItLFmK9VT/neWey2afrurWtSYe43+N7liRxur1s1QJv7l0j9CBe91tr8wjmTp+foqwu2EjIzf1b/46TqDdu+60jmJt98rAohWEE9r16uJv94vIKMwq6Oae8EFX1/m9vGKmoTs8/DTfsdnqUDvh9ia8wk6CxTjSzWuQ5r8ovvWe7aqRuSLB3+L7u4yR6EGUVp6F0aR6/A+ZmwodWEGX7alQFkvCxFYjCtEUHKhDFhf06qgJtxV32v3Pt9eXaqT2yCMK6txbrjNS8r5mSndeKtXPFP8CbKMo4S8EHPnEmHjDYxCKJ5Mt6UwaDdbbbSYVVe+2XkDoS0UA+TYEFU8a9CXcXqxULToz6Qv1HDUNgAZpgqME4sICbYFyDOcACxwRzNNgMWDAzwWYabA4smJtgcw3mAgtcE8zVYAtgwcIEW2iwJbBgaYItNZgHLPBMME9vr+w2GnPAXhB1EshmzsSboo7Us0DZc+RGpB4HyrajMRDUE0HZeTRmgnooKJuPc6O7ngvK/qNrROrRoIwAF0akng7KFNCYD+oBoQwCjRGhnhGXQfCpyZ3rGXEZBDdmxHv7pd4wxoy4nhGXQXDHiNQz4jIIPjMi9Yy4DIIbM+J6RlwGwY0Z8Sajei69iaIS0bdmPgVBMwQjNVqbI9wBXtoRpg5mB+Az8A/HoxpZ8pc06osUzXw+05oTrfmVWmX7hCQyDpFxrpepH/VEhhMZfrVM885CZJDI4JBM0j5qCNclXNfCrV/Tz7lImom2ZnZHY8VbKNrCwuo++RA3YmZj9dIm92a7tfbrlOJMFWdq45RJts1OJwBSIbkxtN1Z+1FEsUgTbT1Msu1LzdPtSKloqzXJtlH9OUHxloq2tLP664Qsk0FSKA/lpEgamy23jlmcjtpEgDjjsHXUnJwJl2xTtG3ThlvVp2FCJUMHbUMnybZncXqK512gNTtZNB8JlQIpeqBmw/ojJdsqrg/BltVLdgvatktzGDPsaSSrCm3LqmH3dymSlqGtZw01y6vSMBo42QncuBNWDPI4F0mcCvCD1fH4FyNAaJuxFgAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA61Y246jOBD9l5pXK5NyyI231XbPaqSWerUzmhcUtejgpNESQOD0bivKv4+MCZSJTULSjwnnYuq4CswBiuy/EvzgAP/GaQQ+Z5CGOwE+xGkk/gcG+yIBH3ZZtE9E+bX6d/QmdwkwWCdhWYoSfIAjO1fYhGuZFR9nGvX//Srj5RynrdZTtt2KopGSH3mzGH3JosYgDwuRyuZmeuWfxLtIfshChLvHVJJld7y6uIHG0xk1fc5lnKVl4xWnUhSbcE0Na8wwHxxzrzFK1JKv9vhygvc4EY7LdBMn4nrPGn2/5d+hfBtmWzPus15naZkNueGWMNjYsnkfQhm6Nqy69jnd0dsSwywmRP35r5enx1+PTz8a/fewiMPXdt60kGEuM9ID1ZT4I88bk80+XVelrU0axP0e/2RJEqfby1Y18ObaaaEH8brfOotHMHf6/BSlvGCjIDfXb/0WJ1Fn0ndLRzA3++RhUQrL9O16dXA3+8XlFWYUdHNOeSGk/PizM4zaqE6PXgPX73Z6ivf4fYuvMFOgoU40s0rkOZflt85rRVtI05Bg7/B93cdJ9CBKGaehctFP/h5zO+FTVxBlezloBYrwuSsQha1Fe1Ygigv9OmgFxo677H/n3uvK1VN74CII6961OGek4X3NlGy8VqyeK/4B3kVRxlkKPvDRZLQEBptYJJE6J+hlMFhnu51SWNXXfgmloxAa8nUMLBgzvhzNcLFaseDEqC5Uf1QwBBagDYYGjAMLuA3GDdgEWDCxwSYGzAMWeDaYZ8CmwIKpDTY1YDNgwcwGmxmwObBgboPNDdgCWLCwwRYGbAksWNpgS7O8qtpozQE7QVRJ2KMws0BVc+TM80Yen5tIMw5UZceJFWkmgqryaM0EzVBQFR+tsaCZC6r648zqbkaDKgKcW5FmOqhSwIUVaQaEKgi0RoRmRlwFwa0ZcTMjroLgaHPnnX6pGsaaETcz4ioIbs2ImxlxFQT3rEgzI66C4FMr0syIqyC4NSNuZsRVENyaEdcZVRPsXRRSRN/1JAsCPS6jdgjrc+YBXuphx6enyXoAPgX/cDy2w039UkZdkUJP8jOtGdGaXalV1s9SIuMRGe96meqlgMhMiMzkahn9dkNkOJHhfTJJ/VAi3Dnhzh3c6oX+nIukmOgqZnOIbnmLlrZwsJrvUsSNmLlYnbTJ+lzLU5S8+rrQ0khJXBWpv7y1nHHLGbs4ZZJts9MRg9wYqQe6ClJ/8GlZpClcPZFk25eKZ9rRQroqmWTbqPpe0fKWLW3pZnW3F9ldvaRQnfrJIgkRLzKL01meCJDWQldraYFIH80Jl3Q3urpbc2V13CZUEgv25HIWJ5INhK4ddCLqESD0J9BWg9xyzx1bdiC5X9ftVudsx/4l/YKuhtHnPcswQLKv0LWxNPtsmJOacVfNNDXLZWmZKZz0Arf2wopBHuciiVMBfrA6Hn8DcIkTRI8XAAA="; \ No newline at end of file diff --git a/functions/factory.buildDestinationFile.html b/functions/factory.buildDestinationFile.html index 6ff4716..404e1d0 100644 --- a/functions/factory.buildDestinationFile.html +++ b/functions/factory.buildDestinationFile.html @@ -1 +1 @@ -buildDestinationFile | @foxxmd/logging Docs

Generated using TypeDoc

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

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.buildDestinationRollingFile.html b/functions/factory.buildDestinationRollingFile.html index fbd865d..a528363 100644 --- a/functions/factory.buildDestinationRollingFile.html +++ b/functions/factory.buildDestinationRollingFile.html @@ -1 +1 @@ -buildDestinationRollingFile | @foxxmd/logging Docs

Function buildDestinationRollingFile

Generated using TypeDoc

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

Function buildDestinationRollingFile

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.buildDestinationStderr.html b/functions/factory.buildDestinationStderr.html index 64694e9..e1e44e1 100644 --- a/functions/factory.buildDestinationStderr.html +++ b/functions/factory.buildDestinationStderr.html @@ -1 +1 @@ -buildDestinationStderr | @foxxmd/logging Docs

Generated using TypeDoc

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

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.buildDestinationStdout.html b/functions/factory.buildDestinationStdout.html index 896c341..235c7af 100644 --- a/functions/factory.buildDestinationStdout.html +++ b/functions/factory.buildDestinationStdout.html @@ -1 +1 @@ -buildDestinationStdout | @foxxmd/logging Docs

Generated using TypeDoc

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

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.buildDestinationStream.html b/functions/factory.buildDestinationStream.html index 26046bd..9743f20 100644 --- a/functions/factory.buildDestinationStream.html +++ b/functions/factory.buildDestinationStream.html @@ -1 +1 @@ -buildDestinationStream | @foxxmd/logging Docs

Generated using TypeDoc

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

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.buildLogger.html b/functions/factory.buildLogger.html index 83bc302..1dd9334 100644 --- a/functions/factory.buildLogger.html +++ b/functions/factory.buildLogger.html @@ -1 +1 @@ -buildLogger | @foxxmd/logging Docs

Generated using TypeDoc

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

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.prettyOptsFactory.html b/functions/factory.prettyOptsFactory.html index dfe1b55..2093747 100644 --- a/functions/factory.prettyOptsFactory.html +++ b/functions/factory.prettyOptsFactory.html @@ -1 +1 @@ -prettyOptsFactory | @foxxmd/logging Docs
  • Parameters

    • opts: PrettyOptions_ = {}

    Returns PrettyOptions_

Generated using TypeDoc

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

    • opts: PrettyOptions_ = {}

    Returns PrettyOptions_

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/index.childLogger.html b/functions/index.childLogger.html index 26febeb..e7f72d7 100644 --- a/functions/index.childLogger.html +++ b/functions/index.childLogger.html @@ -1 +1 @@ -childLogger | @foxxmd/logging Docs
  • Parameters

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

      Returns Logger

    Generated using TypeDoc

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

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

        Returns Logger

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/index.isLogOptions.html b/functions/index.isLogOptions.html index 2b7df23..7c4fe35 100644 --- a/functions/index.isLogOptions.html +++ b/functions/index.isLogOptions.html @@ -1 +1 @@ -isLogOptions | @foxxmd/logging Docs

      Generated using TypeDoc

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

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/index.loggerApp.html b/functions/index.loggerApp.html index 3af22b7..afad120 100644 --- a/functions/index.loggerApp.html +++ b/functions/index.loggerApp.html @@ -1 +1 @@ -loggerApp | @foxxmd/logging Docs

      Generated using TypeDoc

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

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/index.loggerAppRolling.html b/functions/index.loggerAppRolling.html index f210b2d..80b3ec1 100644 --- a/functions/index.loggerAppRolling.html +++ b/functions/index.loggerAppRolling.html @@ -1 +1 @@ -loggerAppRolling | @foxxmd/logging Docs

      Generated using TypeDoc

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

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/index.parseLogOptions.html b/functions/index.parseLogOptions.html index 3f55c72..a30941d 100644 --- a/functions/index.parseLogOptions.html +++ b/functions/index.parseLogOptions.html @@ -1 +1 @@ -parseLogOptions | @foxxmd/logging Docs

      Generated using TypeDoc

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

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/index.LogOptions.html b/interfaces/index.LogOptions.html index 36cab02..9ec9a71 100644 --- a/interfaces/index.LogOptions.html +++ b/interfaces/index.LogOptions.html @@ -1,10 +1,16 @@ -LogOptions | @foxxmd/logging Docs
      interface LogOptions {
          level?: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug";
          file?: false | "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug";
          console?: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug";
      }

      Properties

      level? +LogOptions | @foxxmd/logging Docs
      interface LogOptions {
          level?: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug";
          file?: false | "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug";
          filePath?: string | (() => string);
          console?: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug";
      }

      Properties

      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'
       
      -
      file?: 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.

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

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

      -

      Generated using TypeDoc

      \ No newline at end of file +
      file?: 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.

      +
      filePath?: string | (() => string)

      The full 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

      +

      Type declaration

        • (): string
        • Returns string

      Default

      'CWD/logs/app.log
      +
      +
      console?: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"

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

      +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/modules/factory.html b/modules/factory.html index 939f0de..57da2c3 100644 --- a/modules/factory.html +++ b/modules/factory.html @@ -1,4 +1,4 @@ -factory | @foxxmd/logging Docs

      Index

      Variables

      prettyConsole +factory | @foxxmd/logging Docs

      Index

      Variables

      Functions

      buildDestinationRollingFile buildDestinationFile diff --git a/modules/index.html b/modules/index.html index 44a3986..c1b05af 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,4 +1,4 @@ -index | @foxxmd/logging Docs

      Index

      Interfaces

      LogOptions +index | @foxxmd/logging Docs

      Index

      Interfaces

      Type Aliases

      LogLevel Logger LogLevelStreamEntry diff --git a/types/index.LogData.html b/types/index.LogData.html index d9b4346..8f61c1d 100644 --- a/types/index.LogData.html +++ b/types/index.LogData.html @@ -1 +1 @@ -LogData | @foxxmd/logging Docs
      LogData: Record<string, any> & {
          level: number;
          time: number;
          pid: number;
          hostname: string;
          labels: any[];
          msg: string | Error | ErrorWithCause;
      }

      Type declaration

      • level: number
      • time: number
      • pid: number
      • hostname: string
      • labels: any[]
      • msg: string | Error | ErrorWithCause

      Generated using TypeDoc

      \ No newline at end of file +LogData | @foxxmd/logging Docs
      LogData: Record<string, any> & {
          level: number;
          time: number;
          pid: number;
          hostname: string;
          labels: any[];
          msg: string | Error | ErrorWithCause;
      }

      Type declaration

      • level: number
      • time: number
      • pid: number
      • hostname: string
      • labels: any[]
      • msg: string | Error | ErrorWithCause

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/index.LogLevel.html b/types/index.LogLevel.html index 7ae3b51..2fff266 100644 --- a/types/index.LogLevel.html +++ b/types/index.LogLevel.html @@ -1 +1 @@ -LogLevel | @foxxmd/logging Docs
      LogLevel: typeof LOG_LEVELS[number]

      Generated using TypeDoc

      \ No newline at end of file +LogLevel | @foxxmd/logging Docs
      LogLevel: typeof LOG_LEVELS[number]

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/index.LogLevelStreamEntry.html b/types/index.LogLevelStreamEntry.html index b3b04ea..a0f0bba 100644 --- a/types/index.LogLevelStreamEntry.html +++ b/types/index.LogLevelStreamEntry.html @@ -1 +1 @@ -LogLevelStreamEntry | @foxxmd/logging Docs

      Type alias LogLevelStreamEntry

      LogLevelStreamEntry: StreamEntry<LogLevel>

      Generated using TypeDoc

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

      Type alias LogLevelStreamEntry

      LogLevelStreamEntry: StreamEntry<LogLevel>

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/index.Logger.html b/types/index.Logger.html index a0c5cfc..25687e7 100644 --- a/types/index.Logger.html +++ b/types/index.Logger.html @@ -1 +1 @@ -Logger | @foxxmd/logging Docs
      Logger: PinoLogger<LogLevel> & {
          labels: any[];
          addLabel: ((value) => void);
      }

      Type declaration

      • labels: any[]
      • addLabel: ((value) => void)
          • (value): void
          • Parameters

            • value: any

            Returns void

      Generated using TypeDoc

      \ No newline at end of file +Logger | @foxxmd/logging Docs
      Logger: PinoLogger<LogLevel> & {
          labels: any[];
          addLabel: ((value) => void);
      }

      Type declaration

      • labels: any[]
      • addLabel: ((value) => void)
          • (value): void
          • Parameters

            • value: any

            Returns void

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/factory.prettyConsole.html b/variables/factory.prettyConsole.html index fae38e2..70a8da6 100644 --- a/variables/factory.prettyConsole.html +++ b/variables/factory.prettyConsole.html @@ -1 +1 @@ -prettyConsole | @foxxmd/logging Docs

      Variable prettyConsoleConst

      prettyConsole: PrettyOptions = ...

      Generated using TypeDoc

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

      Variable prettyConsoleConst

      prettyConsole: PrettyOptions = ...

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/factory.prettyFile.html b/variables/factory.prettyFile.html index 369849e..fe2551d 100644 --- a/variables/factory.prettyFile.html +++ b/variables/factory.prettyFile.html @@ -1 +1 @@ -prettyFile | @foxxmd/logging Docs

      Variable prettyFileConst

      prettyFile: PrettyOptions = ...

      Generated using TypeDoc

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

      Variable prettyFileConst

      prettyFile: PrettyOptions = ...

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/index.LOG_LEVELS.html b/variables/index.LOG_LEVELS.html index e8cdb9a..35eb300 100644 --- a/variables/index.LOG_LEVELS.html +++ b/variables/index.LOG_LEVELS.html @@ -1 +1 @@ -LOG_LEVELS | @foxxmd/logging Docs

      Variable LOG_LEVELSConst

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

      Generated using TypeDoc

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

      Variable LOG_LEVELSConst

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

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/index.loggerDebug.html b/variables/index.loggerDebug.html index f5ead2e..bdafcb4 100644 --- a/variables/index.loggerDebug.html +++ b/variables/index.loggerDebug.html @@ -1 +1 @@ -loggerDebug | @foxxmd/logging Docs

      Variable loggerDebugConst

      loggerDebug: Logger = ...

      Generated using TypeDoc

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

      Variable loggerDebugConst

      loggerDebug: Logger = ...

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/index.loggerTest.html b/variables/index.loggerTest.html index 9a524b0..fece51a 100644 --- a/variables/index.loggerTest.html +++ b/variables/index.loggerTest.html @@ -1 +1 @@ -loggerTest | @foxxmd/logging Docs

      Variable loggerTestConst

      loggerTest: Logger = ...

      Generated using TypeDoc

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

      Variable loggerTestConst

      loggerTest: Logger = ...

      Generated using TypeDoc

      \ No newline at end of file