From 9f809513f11aad509e77bc2bb01d39d43e44ae74 Mon Sep 17 00:00:00 2001 From: FoxxMD Date: Fri, 8 Mar 2024 16:57:31 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20FoxxMD/l?= =?UTF-8?q?ogging@6ac3f1b6c267fa7ea3cd922838ea8795069b4923=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/navigation.js | 2 +- assets/search.js | 2 +- classes/index._internal_.EventEmitter.html | 36 +++++------ functions/factory.buildDestinationFile.html | 2 +- .../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.prettyOptsFactory.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 +- hierarchy.html | 2 +- interfaces/factory._internal_.Colorette.html | 42 +++++++++++++ ...factory._internal_.DestinationStream.html} | 2 +- ...=> factory._internal_.PrettyOptions_.html} | 56 ++++++++--------- ...=> factory._internal_.WritableStream.html} | 62 +++++++++---------- interfaces/index.FileLogOptions.html | 12 ++-- interfaces/index.LogOptions.html | 8 +-- ...Extras.html => index.LoggerAppExtras.html} | 10 +-- interfaces/index._internal_.Colorette.html | 42 ------------- .../index._internal_.DestinationStream.html | 2 +- ...index._internal_.FileLogOptionsStrong.html | 12 ++-- interfaces/index._internal_.FileOptions.html | 10 +-- .../index._internal_.PinoRollOptions.html | 6 +- interfaces/index._internal_.RollOptions.html | 4 +- modules/factory._internal_.html | 13 +++- modules/factory.html | 2 +- modules/index._internal_.html | 14 +---- modules/index.html | 3 +- types/factory.FileDestination.html | 2 +- types/factory.StreamDestination.html | 2 +- types/factory._internal_.BufferEncoding.html | 1 + types/factory._internal_.Color.html | 1 + .../factory._internal_.FileOptionsParsed.html | 2 +- ...tory._internal_.LevelPrettifierExtras.html | 1 + types/factory._internal_.LogDescriptor.html | 1 + .../factory._internal_.MessageFormatFunc.html | 1 + types/factory._internal_.Prettifier.html | 1 + .../factory._internal_.PrettifierExtras.html | 1 + types/index.LogData.html | 2 +- types/index.LogLevel.html | 2 +- types/index.LogLevelStreamEntry.html | 2 +- types/index.Logger.html | 2 +- types/index._internal_.BufferEncoding.html | 1 - types/index._internal_.Color.html | 1 - ...index._internal_.FileLogOptionsParsed.html | 2 +- ...ndex._internal_.LevelPrettifierExtras.html | 1 - types/index._internal_.LogDescriptor.html | 1 - types/index._internal_.LogOptionsParsed.html | 2 +- types/index._internal_.MessageFormatFunc.html | 1 - types/index._internal_.Prettifier.html | 1 - types/index._internal_.PrettifierExtras.html | 1 - variables/factory.PRETTY_COLORS.html | 4 +- variables/factory.PRETTY_COLORS_STR.html | 4 +- variables/factory.PRETTY_ISO8601.html | 2 +- variables/factory.PRETTY_LEVELS.html | 4 +- variables/factory.PRETTY_LEVELS_STR.html | 4 +- variables/factory.prettyConsole.html | 4 +- variables/factory.prettyFile.html | 4 +- variables/index.LOG_LEVELS.html | 2 +- variables/index.loggerDebug.html | 2 +- variables/index.loggerTest.html | 2 +- 66 files changed, 215 insertions(+), 215 deletions(-) create mode 100644 interfaces/factory._internal_.Colorette.html rename interfaces/{index._internal_.DestinationStream-1.html => factory._internal_.DestinationStream.html} (77%) rename interfaces/{index._internal_.PrettyOptions_.html => factory._internal_.PrettyOptions_.html} (74%) rename interfaces/{index._internal_.WritableStream.html => factory._internal_.WritableStream.html} (64%) rename interfaces/{index._internal_.LoggerAppExtras.html => index.LoggerAppExtras.html} (74%) delete mode 100644 interfaces/index._internal_.Colorette.html create mode 100644 types/factory._internal_.BufferEncoding.html create mode 100644 types/factory._internal_.Color.html create mode 100644 types/factory._internal_.LevelPrettifierExtras.html create mode 100644 types/factory._internal_.LogDescriptor.html create mode 100644 types/factory._internal_.MessageFormatFunc.html create mode 100644 types/factory._internal_.Prettifier.html create mode 100644 types/factory._internal_.PrettifierExtras.html delete mode 100644 types/index._internal_.BufferEncoding.html delete mode 100644 types/index._internal_.Color.html delete mode 100644 types/index._internal_.LevelPrettifierExtras.html delete mode 100644 types/index._internal_.LogDescriptor.html delete mode 100644 types/index._internal_.MessageFormatFunc.html delete mode 100644 types/index._internal_.Prettifier.html delete mode 100644 types/index._internal_.PrettifierExtras.html diff --git a/assets/navigation.js b/assets/navigation.js index fb8a35a..05bf885 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7VabW/bNhD+L9rXpGvcNGuDYUDqOENRZw7sYEVRBAEjnRUiMqlRVJB06H8fKNkxqRfySGZf7eee50jeHckTv/+bSHiSyWmyJqnk4jk5SEoi75PTZMOzuoDq1+0fb+7lpkgOkgfKsuR0cpCk97TIBLDk9PsLyV1Ni+wcKkkZkZSzJS8KyvILWsCeeF2zVP25p7aYmbInxz8PRsV8VTzpV1IA2fgItBZeEhmvpZ+EsvCTACE8JUAIl8Sc5zm4eVuYhexqObu+/nY7n/09m6/2dI9EUHKnh6MBNAnfTcYIb1fXSzSpAruJp4v5Yokl3oOxxGhSN+Hn1eLDydsjBOMWaaEsBUj5vChlddGtG/2V74Et699ip5xVXM/mvqsG0OmpWRvG2PoVwaBSf2uJseeTz6XG1YF1Cufbj78dvddZ2yqB4O0BXcy/UyZBMFL8MV7Vb3eYW1SBvyTiYQn/1FRANuanRqnDB709SNKCVJXiqLJDWh3CU2ubaOOYPUlBUonQ2yLDpdTaLcomfK+IqFCD7NkMr8vNzxtNiLIMnvrL0vyMWolSSc15vlUeyr+WrAO05F4jM17IWzoNZKEqGsA1VHIo61qmPcaScy3oHO7q3MXUgJxUZ2U5PrgXiHNoZ2W5PaUg2LZIC+mc53N4hKIbbi3R7l9Xws8Xf1p2zi3XC8YyVUNx1QT8mqS6V4MxNXl/ogd6hQlSHWWfJiM4O5PUi8mBKdpOZVtMZ0zqW9fQnGtABPc5kWSUT/3p4lDFBDX7JtC2ArZtoOXy3ATOqmeWLqHitUjB7anGPmTZcx1VqA2mvXhj6VQ2JY8mH1CSn+r1GsSMpTwz0l5fZU3RhEfsfo/A5GxDpQThNdkDhmFzffsXz6BhuyYiB4mT71oFap8vLv2lTaMw5ZUkkqbBsz9qHuaNToQIdx0eFu3DgqN1Q4cfdm4Ox+OCwwUmXvuXDsXWkaOPx+/eWtzRC8wdF1JtnP7Jdnj05sU6frWXsAYBLKUsHyl6Hn5hiONdDt8gLO6+3t4xyuqZWDYHfZLupuvbJSmd28sOGL6xnMOa1IVEK3bw4cJn7Hlp3AxGBLe4CCGRV24VkXfjyEPiC4ycHzWFLzB8dMQKTDAKk3CJOa0ksLFztSazA4ZLTUlRrKhEFq8dOizNvwralOBu49amaNqE6U55wd1z2aAiJlKZg0TP5A4eNiR1eYEqFbSUiKEZ6PAhXu3ahqrS3+LGadqEDbbhoGuKSIg9NHKYDUfTvXIXrK5BROKrC663/qBVuBOXUFUkhwsuNkRe1Cx1OtCziEijupJ804zI1lvQM6lrES6+YFN1+FVV7o6kD07pDj5cWEBGUul1MDNMgotI3g8ym6huEab5iTS9T2NhbYp7fKAeZeq2706iHTAyeXHJGimyECspMC0PAx0p+pXK+xUtgLnPiR38qwn7jbtvF+7ICgQlBf0B4qL3OajfadDAkWOf3hOWt00b/KFwxDDCFVwlji2/lm/7thLh+MCPby8NNKDtDaWxRjS2/qqFuiRlaYS0tf5qFsE1X49gR7HvxS/2xL3/JuW1qfXtImYWlyjd3tj/lhcxQq83nz0vkDP6WrkZqu8bt6E6MVUgVHMmBBdqt5qSukL1vAyDsHbyZwmCSC6+USiyJVR1gezlDxiGDXtHtARZCxbigm4Z64OpPpLJJjyiD6Y6kzsyjy91O5OIT3QNxV0Boeqaaehtnm9oBXP6gGyVaAZhimPvY3pK8S9jriji2qhA4RJLSLnAjEXBYt74pEWdgVNni4u4dG+oO/EUKGZVGFdPPrz2zo6R7YO+NzeSV3vIhOPVDFy8+6cKKyk49gA6ZIlXGn7B5RCxPeEaeiCDFAkQaN8O+fdLXoz6M6XeoN38ByNz+pH0LQAA" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7VabW/bNhD+L9rXpEvcJGuDYUBqO0NRew7sYEVRBAYtnRUiMqlRVJBs6H8f9GKbkijyRKZf7eee544vx+NR3/8LJLzI4DrYklBy8RqcBCmRj8F1sONRnkD2a/3Hu0e5S4KT4ImyKLgenQThI00iASy4/n4g2eQ0iSaQScqIpJwteZJQFt/SBI7E25yFxZ9HaoNZU/bq4sdJr9hQlYH0KymA7IYIVBaDJCKey2EShcUwCRBioAQIYZOY8TgGO28FM5DdLaf399/Ws+nf09nqSPdMBCUbdTk2gE3C96M+wvXqfokmLcB24vFitlhiiY9gLDGa1E74ebX4cHV2jmCskQbKVICUr4tUZrftvNGd+Q7YMP8VdsxZxtXd3HW1AbR62swNfWzdjNCgKv5WNsaRT76mClcL1kqcZx9/O79UWassgeDtAG3Mv1MmQTCS/NGf1dd7zBqV4D/l2y2IKQt5RFnc56lC2jTQenwShAnJsoIli05pdgovlXWgxPJVUFlMWTsLl0pbEurVm1Yt9csrlPKYJ1wgIi1x7gGW5iAlYGM7GLiFNePxBLJQ0FSiwmvg3cO82+eCIkOssbE2rdwCLjnolgIm2iPYM9SSY/oiBckGyVYm7uIzeIbEwQOtnbsbc8gyEsMtFzsib3MWIlzo2LjLG8o384KzVHHYNTcn4mkJ/+RUQISJXIG7B13OWSgRejXSXao46updeUdEhgqyY6M/xh5+PChClEXw0j3Fyp9RB1daSM14XCvrypWKrAU0lCqlTH/dW9EpIANVUgLuIZO6IqViOmIMJUoFmsAmj21MJchKdZOm/cEdINbQbtK0vtQh2GqkgXTG4zJRtZdbRbT/11YfzRZ/Gi4aNdcBYxgq3bpS8svBK+2aGl1eqQs9wyxSFWUeprh73B3c6axJzRDVQ1klwSmTaqWvG3MFiOCeEEl6+Yo/bRxFMkGNfhNomoHZfhm2z0zdjKpIE6mpFK/IBhbiN9krC5eQ8VyEYA9fYddZup1uDaajeGlpVW5Kno8+4M62Z2ByuqNSghgUtcbQLej1XzyCku2eiBgkTr5t5ag9WcyHSzeN3JRXkkgaOo9+r7mbNyoRYt2pcP9lh9jAKvy01Ua56BfU73R/7V9aFLUj5x8v3p8Z3FF3+oaL8iI9fLOdnr87WPvP9hK2IICFlMU92WeAXxhif5fdM7XB3bdL4r2sAzeWycEhm+6h7ducpPoSoe3InKTuN5kJbEmeSLRiC+8ufMNel426v0ewxnkIibjTAOiqiNjjtv8FeqpDReEL6AtDrMAIozDyaJzQTALrq5rVTkkN9Gj5kSRZ0Z6OX0dvj3bsYuaZ5LuyRDfdClS9toV7oAs2Lg62IoINCZ+s0i28u7CAiIRyUNJtmDi3VuNuy80kqlq4aX4iZdeiMbEmxSPeUY+yoqFvzyh7oGcr074de2/8eJGFWEmhedfQi+3RnqJfqXxc0QSY/Qxo4d9MeFjcXTt3R1YgKEnovyBuO+9e3VuEAvaMffxIWFxdyPAJv8fQwxVcJvZNv7guuKbEeZMeuLZ1ZL4s9rWQsPm3mKg5SdPGkjbmX8XCOeerK9iS7DvrF3uKH7vJgw61rp3HyOI2Svve+9P2hY/Q241nx4uftG5cdXx2oavmVAguitNiTPIMdZ9sGLi1aj5LEERy8Y1CEi0hyxNkn0xj6Bb2nmgJMhfMxQXV0teHpnrPTmrCPe6Yxa1/TzagHb038ehDlxSbBFzVFVPX7wv4jmYwo0/IC51i4KbY97LcUfJ/U76jiGtbAXKXWELIBSaWAubzOh4meQRWnRrncendUfvGK0A+s8J48Vg66OxqGZlerQZzI3mVTwBwvIqBjff4yLeSgmMLQJ0lXkn/7YNFxPTxg+5pGSmCEyi+rnj4H2oYd/X9LQAA" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index 76048f0..d73b600 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA71abWvbSBD+L9uvqut9k184Do42PQqBlCQUDhOMam8ccbLkk5Tc5UL++7GSbM3Is7Ikm/tUGj8zz+w8M7Orld5Ymvydsfnijf0Zxms2Fx6Lg61hcxbGa/MP89hzGrE52ybr58hkn4q/jp7ybcQ8toqCLDMZmzP27h17eAxWeZK+Hvmo/t7uRfsHP1/DyFwnm5tdHiZxdnAXxrlJH4PVISqMI9x7bBekJs4Pq6v5+FioA2FkXkzUi+fD3qSFrWHnIt8F+VM/7sqips6z9ccw+xjGTyYNc7MeGkoW/mv6hVJZXD6Ux9T89Wzi1Wu/eKDZ5YPKw63J8mC76xcUNLtIUGI8m3BdN951stmY9BBU/ro7xFP+1K83CPfXttzv8tQE26s4Bz3e4GriehKDIdBlAPwfzT+k8TuUdxi1dNpRVZfo8yhXSZwlfVhrg97ERAV9CfLAVTX2t8uUaGtd9qOQwPvN78vrqx9X13cH/y9BGgY/6x2yhvRj8UEhFq36266eLo/P8apIbUVyQJzPcZtEURhvTlNVwMG5Kx19MT+fN87kAcyZPPcmy0/QWMjg/K2ewmjdGLfN1AHMYJ5dkGbUGajJ1cAN5guzDmQQNFinXWry/PVzYxjVUu0PiwjXzrY/d7bwfQ07kFnQGUzfb6/u7/9Yfr65vrmlBsWeDOEuxbe8u7/tymmx5/M6B2KDs8tU7M7XbZ019nzeb3c3U3/MT5NWwL6MsOuLMrzZ5dnXxqNU3Yq4ZAH2DN6fz2G0/mKyPIwDy1Ie4FrIaYOLRrBOnvNeEViDy0ZgUmrIt0Rg0hMTv1cEaGad5h8yvVrYq32/ZxDA6txYnLss4u6yzx5zNY+PNl6wisYpck/YQJ1LWjbNadojXG/iA+UvxaE/DqJfHRc9yz1gOfzJzabp5KMbIAL4DqQjsIZBNyotzMc3K2300HzYjUpbKANuVvqF1uGGpS2+oTct/YLscOPSFuTQm5eTQTZuKspHpat/8jToVvMNmwvVfXEkGMz/4WDfsf6bC3eEta4n1/DkfGh4OTtE4gahkvm7faZakzcJOEiEHywhLKXvYZzYLbTP+GzYXKaUOs8tiv14drVq1Fz0ReYVGRc9swYGB3Xrq9nF9eo3J48SQ8/J1sQ4kkIcrPp2FmVzke7Cju/yNAEXYKf2labhZXQ7cfncJYZON9KNDe0oC5c4SdHR9T9SdQ2u19mKDu78Q1bXYPuftuiIL3Ts6hp2//MXHfaFDmItYXd6yNk/UnV9zOn25Ng23QjGI5NOMaBh8uBVT2DzN/Zi0sw+PM6ZGMnRjHnsMTTR2r7kL4P02CrZbq2zh+q3H8a6tIgS8mnMvMXYk5ORP509PHiLvUXxQ/GHAsaZt+AUjCOYYN5CUDCBYJJ5C+mJ2UhwH8EkginmLRQFUwimmbfQnvBHk7FEMI1gPvMWPgXzEWzCvMWEgk0QbMq8xZRa6RTBZsxbzCjYDKfXZpuTOvCGENyVO46l4DblnNYMq8Ft1jkpG8eCcJt4Lkkk1oTb3HNFIrEs3KafaxKJleFWAe572h9pqTASi8OtCHxCIrE+3OrASSE5lkgUEpFaCiyRsEKIMcUuGu1S9AsnkVgjYYUQgkRijYQVQpAaCayRsEIIUiOBNRJWCEFqJLBGwgohfBKJNRJWCDEhkVgjYYUQpEYCayStEILUSGKNZNFGpEYSayStEJLUSDamWjHWSI0k1khaIaQkkVgjaYWQikRijaQVQmoSiTWSVghJ9pHEGkkrhCQ1klgjaYWQpEYSa6SsEHLmSTHSU47HOtZIWSEUORQV1kgJ506BJVLStVeoxtajXLuFwgIp7dovFNZHWREUOY8V1kdZERQ5jxXWR1kRFNnrCuujrAiK7HWF9dFWBEX2usb6aO7ceLE8WriSqbE82oqgyOmhsT5audKuG4cDq4IiS1hjgXQhEFnCGgukJ649WGN99NRVlxrLo2fOVGJ1/LHzFIPF8bkrQT4WxxfOfvSxOn6hDjld/VKd4nD6YtLcrL+Vh9TFonylA+7wyk+a3tiyOsfKwzPHG5Oazd/e3+tzq/2fJWo6Scu3TUe+NPDld/SVVe/7gBsJ3KjubooXl8CNAG5kZzflG1jghgM3os1NVL04A7Y+sJ04bIvPVo5txbi2Fdxlu/+co7bjYNnctWx8qVsbK5B6NXUYHz43BqSA02XVKBYObVx5tUZr+KIO5HYCcusMNYxMlGyS3dFKQZbayGvjXfWUCZIFItCu1sFOsuruCziZAieunrFOiDUoUCKqLe/uJcxqD76rWMDVR20JKruI2mNKlf9qUf7rjx3+qg/ea19gGW6b8hkcVQAIXo0rUpeYYeaoA1gIrgxUN32AGtReScx5tXpXm0fJZln4QfQcjEzukj9KNuviK05gByLgrhl5PFRAsblapjQK7NeQgA7IzVtWWFqa6n0cqDPQ7KplmaV9uv9GEgQAeo23h74uP3kEtmDVfNZqmxefMQJTUGLCVZtRsjkqEA62Ve6aDXvDctMx5ffdtQ/A3RI1UdMcNBRvido9FkD0ysVdmDmaCsgtXB1ZXlADUsBZTZRqkmiX4LswTmyxULMRNJZ25WD/4hWYgXGgXIVemi1XSWQv8+C6AalwlTmyXmY53vVBo4kT/GGWlB/IAXNQM7J91cQwEqDJhDPn0PoofNBqwlk4hQfi6CLAUBOuoVZaN08TAlSPcPVbaZrs8ow4wkjQNNK1mbqKDaimXZtI+c6jNoIFWtV7tZfo/V7iymA5MFwHI6CBdHkA7wVqSyD/pIqoikxXHemTiXnw2C7cmSiMDZsvHt7f/wPu4ar/7jYAAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA71abWvbSBD+L9uvqut9k184Do42PQqBlCYUDhOMam8ccYrkk5Tc9UL++7GSbM1Is7Ikm/tUGj8zz+w8M7OrlV5ZmvydseXqlf0Zxlu2FB6LgyfDliyMt+Yf5rHnNGJL9pRsnyOTfSj+OnnMnyLmsU0UZJnJ2JKxN6/t4SHY5En6s+Wj+nu3F+0f/XwOI3Od7G72eZjE2dFdGOcmfQg2x6gwjnDvsX2Qmjg/rq7m41OhjoSReTHRIJ53B5MOtoadi3wf5I/DuCuLmjrPtu/D7H0YP5o0zM12bChZ+K8ZFkplcflQHlLz17OJNz+HxQPNLh9UHj6ZLA+e9sOCgmYXCUpMFzOu68a7TnY7kx6Dyn/uj/GUPw3rDcL9tS332zw1wdNVnIMeb3A1cQOJwRDoMwD+j+Yf0/g9yjuMOjqtVdUl+jzKTRJnyRDW2mAwMVFBn4I8cFWN/e0yJdpZl2cV486kv+33V//kadBdkRB4RlnuU5PnHdOPYnp3NDqhGFqMI4CtyfIwDk63YDuMhum4YHzQogfQMY6H53hTuK/COCKGZZzi+JZEURjvTlNVwGGMUjQYP5kfzzXZS5CGwY/64AUwZ/LcmSw/QWMho1mub35fX199v7q+dbLUkNEqbR7DaNvY7poCAcxonn2QZtQZtMnVwI3mC7MeZBA0WqdyRHxsbAa1VIfDOsJ1sx3O/R18n8MeZBZ0BtPXb1d3d3+sP95c33yjivBAhnCX4lvf3n3ry2mx5/M6m63B2afj+vP1W2eNPZ/3y+3N3J/y06QVcCij39xzb/Z59rnxKFu3Ii5ZgD2D98dzGG0/1ZtmeYDuIKcNLhrBNnnOB0VgDS4bgUmpId8RgUlPTPxBEaCZdZp/zPTqYK9OFwODAFbnxuLcZRF3n322zdU8vtt4wSoap/gDYQN1LmnZNKdpW7jBxEfKX4rzcxxEvzou2tYHwHr8w4pN08lHZ0AE8D1IJ2ANo260OpjbN1td9NB83I1WVygjbraGhdbjhqsrvrE3XcOC7HHj1RXk2Juvk0ESz/8V6Ks9kW/JewAQaRM/uvBh430N48QO4CHN17C5TAP2rnqKvV35nfo0F32Raifjoit+ZHBQt6GaXVyvYV3WSgzdZZ2JcSSF2JaHdhZlc5Huwo5v8zQBlzSnplLT8DK6nbg67hNDr/vkxjhsZeES+zAd3fANuW9wg3ZmOrjzt+i+wQ7fq+mIL7Rp9w17+O5Nh32hbbwj7F5H5MOBvO8hud9zR9d0IxhbJr1iQMPk3qvO78tX9mLSzD56LJmYyMmCeewhNNHWvqIvg/TYJnl6ss7uq9++G+vSIkrIhynzVlNPzib+fHF/760OFsUPxR8KGGfeilMwjmCCeStBwQSCSeatpCcWE8F9BJMIppi3UhRMIZhm3kp7wp/MphLBNIL5zFv5FMxHsBnzVjMKNkOwOfNWc2qlcwRbMG+1oGALnF6bbU7qwBtCcFfuOJaC25RzWjOsBrdZ56RsHAvCbeK5JJFYE25zzxWJxLJwm36uSSRWhlsFuE8isTjcisBnJBLrw60OfO5pf6KlwkgskSgkWlBIgSUSVghBiika7VL0C6mRwBoJK4SgWwtrJKwQQpJxYo2EFUIoEok1ElYIoUkk1khYIQSpkcAaCSuEIDUSWCNhhRBkswmskbRCCLLfJNZIFm1EaiSxRtIKIUmNZGOqFWON1EhijaQVQpIaSayRtEJIUiOJNZJWCElqJLFG0gohfRKJNZJWCDkjkVgjaYWQZB9JrJGyQkiyjxTWSFkhFKmRwhopK4QiNVJYI2WFUMKTYqLnHCMbm0+x+5CzTmGNlHbuU1gi5bt2KoUVUjPXXqWwQGru2q0U1kdZERQ5jxXWR1sRFDmPNdZHc+fGi+XRwrUcjdXRhTrk9NBYHa1cC9eNw0EhDjlmNFZHWw0UOWY0lkfPXHuwxvLouasyNJZHL5ypxOr4U+cpBovjc1eCfCyOL5wd4WN1/EIdcrr6pTrF4fTFpLnZfikPqatV+UIAfNVRfpD0ytbVOVbODkfqVybnbPn69lafW+3/LFHTSVq+q2j5mgNfi56+suptEXDjAzez/m6K117AjQZu/N5uyvd3wI0CbnSXm6h67QJsF7Wtmjpsi48e2rZC1rZCuWwPHwPUdlzUdlw67PBnPsAYVAN3VcPxY2FgB8xcVo1i4dBGdBht4Wue2l5NQW67SKNkl+xbKwVZ6iKvjffVUyaIACRLuyoDO8mquy/gBPSMdlWpdUKsQYESUa4SAbbEEkCB+q5iAVcftSXo0SJqj6lZ+a8W5b++q+Crz9VrX0BJt035DI6CBxoqWZG6xAwzRx2AKSFc+a9u+kBjg5lQEnNerd41sKJkty78YHpYhy4BomS3Lb7BBN0DIuAu6dtDBRSbq7tLo8B+sQfogCF3Tfajpak+tQT2IMvcmeWDfXr4jg84AIUqXEVSOtiWn+WBHIP6Eq5JUdrmxad2wBQMKeEqrSjZtQqEg12Du2bDwbDcdEz5dXbtAyy5I+VETXOwYN6RLPdYANErF3dh5mgqYC9cqy8vqAEp4Kwmiq56ylWr+zBObLFQsxFUnHbl4PDRLUgdmGvc1cql2XqTRPYyD64btIlw5g1ar7Mc7/pAdNkd9jrMkvLzKjCXwDiRrnFSmbeHkQR1I12Ngqyb4UvQL9LVL6UH4ugiQPJFd/KbpwkB9mLhLJfCNNnnGXGEkXCmuyaqq9hA4NqV9vKdR20EC7Sq92on1Ye9xFVC5cBwHYyABsqlAXgvUFuCHFZ7uZpXkVQd6ZNVce+xfbg3URgbtlzdv739B61K3RysNgAA"; \ No newline at end of file diff --git a/classes/index._internal_.EventEmitter.html b/classes/index._internal_.EventEmitter.html index a00f844..013ecf4 100644 --- a/classes/index._internal_.EventEmitter.html +++ b/classes/index._internal_.EventEmitter.html @@ -112,7 +112,7 @@ not prevent the listener from running.

Parameters

Returns Disposable

Disposable that removes the abort listener.

Since

v18.18.0

addListener

on

once

removeListener

off

  • off<K>(eventName, listener): this

  • Alias for emitter.removeListener().

    -

    Type Parameters

    • K

    Parameters

    Returns this

    Since

    v10.0.0

    +

    Type Parameters

    • K

    Parameters

    Returns this

    Since

    v10.0.0

removeAllListeners

  • removeAllListeners(event?): this

  • Removes all listeners, or those of the specified eventName.

    It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other @@ -180,26 +180,26 @@ modified for this specific EventEmitter instance. The value can be

getMaxListeners

  • getMaxListeners(): number

  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    Returns number

    Since

    v1.0.0

    -

listeners

  • listeners<K>(eventName): Listener<K, T, Function>[]

  • Returns a copy of the array of listeners for the event named eventName.

    +

listeners

  • listeners<K>(eventName): Listener<K, T, Function>[]

  • Returns a copy of the array of listeners for the event named eventName.

    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
    -

    Type Parameters

    • K

    Parameters

    Returns Listener<K, T, Function>[]

    Since

    v0.1.26

    -

rawListeners

  • rawListeners<K>(eventName): Listener<K, T, Function>[]

  • Returns a copy of the array of listeners for the event named eventName, +

    Type Parameters

    • K

    Parameters

    Returns Listener<K, T, Function>[]

    Since

    v0.1.26

    +

rawListeners

  • rawListeners<K>(eventName): Listener<K, T, Function>[]

  • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
    -

    Type Parameters

    • K

    Parameters

    Returns Listener<K, T, Function>[]

    Since

    v9.4.0

    +

    Type Parameters

    • K

    Parameters

    Returns Listener<K, T, Function>[]

    Since

    v9.4.0

emit

  • emit<K>(eventName, ...args): boolean

  • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
    -

    Type Parameters

    • K

    Parameters

    Returns boolean

    Since

    v0.1.26

    +

    Type Parameters

    • K

    Parameters

    Returns boolean

    Since

    v0.1.26

listenerCount

  • listenerCount<K>(eventName, listener?): number

  • Returns the number of listeners listening to the event named eventName.

    If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

    -

    Type Parameters

    • K

    Parameters

    • eventName: Key<K, T>

      The name of the event being listened for

      -
    • Optional listener: Listener<K, T, Function>

      The event handler function

      +

      Type Parameters

      • K

      Parameters

      • eventName: Key<K, T>

        The name of the event being listened for

        +
      • Optional listener: Listener<K, T, Function>

        The event handler function

      Returns number

      Since

      v3.2.0

prependListener

  • prependListener<K>(eventName, listener): this

  • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has @@ -208,16 +208,16 @@ times.

    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Type Parameters

    • K

    Parameters

    • eventName: Key<K, T>

      The name of the event.

      -
    • listener: Listener<K, T, ((...args) => void)>

      The callback function

      +

      Type Parameters

      • K

      Parameters

      • eventName: Key<K, T>

        The name of the event.

        +
      • listener: Listener<K, T, ((...args) => void)>

        The callback function

      Returns this

      Since

      v6.0.0

prependOnceListener

  • prependOnceListener<K>(eventName, listener): this

  • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Type Parameters

    • K

    Parameters

    • eventName: Key<K, T>

      The name of the event.

      -
    • listener: Listener<K, T, ((...args) => void)>

      The callback function

      +

      Type Parameters

      • K

      Parameters

      • eventName: Key<K, T>

        The name of the event.

        +
      • listener: Listener<K, T, ((...args) => void)>

        The callback function

      Returns this

      Since

      v6.0.0

eventNames

  • eventNames(): ((string | symbol) & Key2<unknown, T>)[]

  • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

    diff --git a/functions/factory.buildDestinationFile.html b/functions/factory.buildDestinationFile.html index 7131a9e..9fc8a52 100644 --- a/functions/factory.buildDestinationFile.html +++ b/functions/factory.buildDestinationFile.html @@ -1 +1 @@ -buildDestinationFile | @foxxmd/logging Docs

    Function buildDestinationFile

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function buildDestinationFile

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function buildDestinationRollingFile

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function buildDestinationRollingFile

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function buildDestinationStderr

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function buildDestinationStderr

    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 e631641..57586be 100644 --- a/functions/factory.buildDestinationStdout.html +++ b/functions/factory.buildDestinationStdout.html @@ -1 +1 @@ -buildDestinationStdout | @foxxmd/logging Docs

    Function buildDestinationStdout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function buildDestinationStdout

    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 2feaddb..6bb7687 100644 --- a/functions/factory.buildDestinationStream.html +++ b/functions/factory.buildDestinationStream.html @@ -1 +1 @@ -buildDestinationStream | @foxxmd/logging Docs

    Function buildDestinationStream

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function buildDestinationStream

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function buildLogger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function buildLogger

    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 155e5b7..7284db5 100644 --- a/functions/factory.prettyOptsFactory.html +++ b/functions/factory.prettyOptsFactory.html @@ -1 +1 @@ -prettyOptsFactory | @foxxmd/logging Docs

    Function prettyOptsFactory

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function prettyOptsFactory

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function childLogger

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

    • Parameters

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

        Returns Logger

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

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

      Function childLogger

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

      • Parameters

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

          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 82cb5f0..103f45b 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 bb45ffd..4fd2da9 100644 --- a/functions/index.loggerApp.html +++ b/functions/index.loggerApp.html @@ -1 +1 @@ -loggerApp | @foxxmd/logging Docs

        Function loggerApp

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

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

        Function loggerApp

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

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

        Function loggerAppRolling

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

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

        Function loggerAppRolling

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

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

        Function parseLogOptions

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

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

        Function parseLogOptions

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/hierarchy.html b/hierarchy.html index b5fcdc6..98862a6 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -1 +1 @@ -@foxxmd/logging Docs

        @foxxmd/logging Docs

        Class Hierarchy

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

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

        @foxxmd/logging Docs

        Class Hierarchy

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/factory._internal_.Colorette.html b/interfaces/factory._internal_.Colorette.html new file mode 100644 index 0000000..f9f7925 --- /dev/null +++ b/interfaces/factory._internal_.Colorette.html @@ -0,0 +1,42 @@ +Colorette | @foxxmd/logging Docs

        Interface Colorette

        interface Colorette {
            reset: Color;
            bold: Color;
            dim: Color;
            italic: Color;
            underline: Color;
            inverse: Color;
            hidden: Color;
            strikethrough: Color;
            black: Color;
            red: Color;
            green: Color;
            yellow: Color;
            blue: Color;
            magenta: Color;
            cyan: Color;
            white: Color;
            gray: Color;
            bgBlack: Color;
            bgRed: Color;
            bgGreen: Color;
            bgYellow: Color;
            bgBlue: Color;
            bgMagenta: Color;
            bgCyan: Color;
            bgWhite: Color;
            blackBright: Color;
            redBright: Color;
            greenBright: Color;
            yellowBright: Color;
            blueBright: Color;
            magentaBright: Color;
            cyanBright: Color;
            whiteBright: Color;
            bgBlackBright: Color;
            bgRedBright: Color;
            bgGreenBright: Color;
            bgYellowBright: Color;
            bgBlueBright: Color;
            bgMagentaBright: Color;
            bgCyanBright: Color;
            bgWhiteBright: Color;
        }

        Properties

        reset +bold +dim +italic +underline +inverse +hidden +strikethrough +black +red +green +yellow +blue +magenta +cyan +white +gray +bgBlack +bgRed +bgGreen +bgYellow +bgBlue +bgMagenta +bgCyan +bgWhite +blackBright +redBright +greenBright +yellowBright +blueBright +magentaBright +cyanBright +whiteBright +bgBlackBright +bgRedBright +bgGreenBright +bgYellowBright +bgBlueBright +bgMagentaBright +bgCyanBright +bgWhiteBright +

        Properties

        reset

        reset: Color

        bold

        bold: Color

        dim

        dim: Color

        italic

        italic: Color

        underline

        underline: Color

        inverse

        inverse: Color

        hidden

        hidden: Color

        strikethrough

        strikethrough: Color

        black

        black: Color

        red

        red: Color

        green

        green: Color

        yellow

        yellow: Color

        blue

        blue: Color

        magenta

        magenta: Color

        cyan

        cyan: Color

        white

        white: Color

        gray

        gray: Color

        bgBlack

        bgBlack: Color

        bgRed

        bgRed: Color

        bgGreen

        bgGreen: Color

        bgYellow

        bgYellow: Color

        bgBlue

        bgBlue: Color

        bgMagenta

        bgMagenta: Color

        bgCyan

        bgCyan: Color

        bgWhite

        bgWhite: Color

        blackBright

        blackBright: Color

        redBright

        redBright: Color

        greenBright

        greenBright: Color

        yellowBright

        yellowBright: Color

        blueBright

        blueBright: Color

        magentaBright

        magentaBright: Color

        cyanBright

        cyanBright: Color

        whiteBright

        whiteBright: Color

        bgBlackBright

        bgBlackBright: Color

        bgRedBright

        bgRedBright: Color

        bgGreenBright

        bgGreenBright: Color

        bgYellowBright

        bgYellowBright: Color

        bgBlueBright

        bgBlueBright: Color

        bgMagentaBright

        bgMagentaBright: Color

        bgCyanBright

        bgCyanBright: Color

        bgWhiteBright

        bgWhiteBright: Color

        Settings

        Member Visibility

        Theme

        On This Page

        resetbolddimitalicunderlineinversehiddenstrikethroughblackredgreenyellowbluemagentacyanwhitegraybgBlackbgRedbgGreenbgYellowbgBluebgMagentabgCyanbgWhiteblackBrightredBrightgreenBrightyellowBrightblueBrightmagentaBrightcyanBrightwhiteBrightbgBlackBrightbgRedBrightbgGreenBrightbgYellowBrightbgBlueBrightbgMagentaBrightbgCyanBrightbgWhiteBright

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/index._internal_.DestinationStream-1.html b/interfaces/factory._internal_.DestinationStream.html similarity index 77% rename from interfaces/index._internal_.DestinationStream-1.html rename to interfaces/factory._internal_.DestinationStream.html index 042de40..3d96c7b 100644 --- a/interfaces/index._internal_.DestinationStream-1.html +++ b/interfaces/factory._internal_.DestinationStream.html @@ -1,2 +1,2 @@ -DestinationStream | @foxxmd/logging Docs

        Interface DestinationStream

        interface DestinationStream {
            write(msg): void;
        }

        Hierarchy (view full)

        Methods

        write +DestinationStream | @foxxmd/logging Docs

        Interface DestinationStream

        interface DestinationStream {
            write(msg): void;
        }

        Hierarchy (view full)

        Methods

        write

        Methods

        write

        • write(msg): void

        • Parameters

          • msg: string

          Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        write

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/index._internal_.PrettyOptions_.html b/interfaces/factory._internal_.PrettyOptions_.html similarity index 74% rename from interfaces/index._internal_.PrettyOptions_.html rename to interfaces/factory._internal_.PrettyOptions_.html index 94fb49a..23503c4 100644 --- a/interfaces/index._internal_.PrettyOptions_.html +++ b/interfaces/factory._internal_.PrettyOptions_.html @@ -1,27 +1,27 @@ -PrettyOptions_ | @foxxmd/logging Docs

        Interface PrettyOptions_

        interface PrettyOptions_ {
            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>;
            };
            customLevels?: string | object;
            customColors?: string | object;
        }

        Properties

        hideObject? -translateTime? -levelFirst? -levelKey? -levelLabel? -messageKey? -singleLine? -timestampKey? -minimumLevel? -messageFormat? -colorize? -colorizeObjects? -crlf? -errorLikeObjectKeys? -errorProps? -ignore? -include? -sync? -destination? -append? -mkdir? -customPrettifiers? -customLevels? -customColors? +PrettyOptions_ | @foxxmd/logging Docs

        Interface PrettyOptions_

        interface PrettyOptions_ {
            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>;
            };
            customLevels?: string | object;
            customColors?: string | object;
        }

        Properties

        hideObject? +translateTime? +levelFirst? +levelKey? +levelLabel? +messageKey? +singleLine? +timestampKey? +minimumLevel? +messageFormat? +colorize? +colorizeObjects? +crlf? +errorLikeObjectKeys? +errorProps? +ignore? +include? +sync? +destination? +append? +mkdir? +customPrettifiers? +customLevels? +customColors?

        Properties

        Optional hideObject

        hideObject?: boolean

        Hide objects from output (but not error object).

        Default

        false
        @@ -56,7 +56,7 @@ to translate time to yyyy-mm-dd HH:MM:ss.l o in system timezone.

        Optional minimumLevel

        minimumLevel?: Level

        The minimum log level to include in the output.

        Default

        "trace"
        -

        Optional messageFormat

        messageFormat?: string | false | MessageFormatFunc

        Format output of message, e.g. {level} - {pid} will output message: INFO - 1123

        +

        Optional messageFormat

        messageFormat?: string | false | MessageFormatFunc

        Format output of message, e.g. {level} - {pid} will output message: INFO - 1123

        Default

        false

        Example

        {
          messageFormat: (log, messageKey) => {
            const message = log[messageKey];
            if (log.requestId) return `[${log.requestId}] ${message}`;
            return message;
          }
        }
@@ -87,7 +87,7 @@ Will be overridden by the option include if include is presented.

        Optional sync

        sync?: boolean

        Makes messaging synchronous.

        Default

        false
        -

        Optional destination

        destination?: string | number | DestinationStream | WritableStream

        The file, file descriptor, or stream to write to. Defaults to 1 (stdout).

        +

        Optional destination

        destination?: string | number | DestinationStream | WritableStream

        The file, file descriptor, or stream to write to. Defaults to 1 (stdout).

        Default

        1

        Optional append

        append?: boolean

        Opens the file with the 'a' flag.

        @@ -96,11 +96,11 @@ Will be overridden by the option include if include is presented.

        Optional mkdir

        mkdir?: boolean

        Ensure directory for destination file exists.

        Default

        false
        -

        Optional customPrettifiers

        customPrettifiers?: Record<string, Prettifier<object>> & {
            level?: Prettifier<LevelPrettifierExtras>;
        }

        Provides the ability to add a custom prettify function for specific log properties. +

        Optional customPrettifiers

        customPrettifiers?: Record<string, Prettifier<object>> & {
            level?: Prettifier<LevelPrettifierExtras>;
        }

        Provides the ability to add a custom prettify function for specific log properties. customPrettifiers is an object, where keys are log properties that will be prettified and value is the prettify function itself. For example, if a log line contains a query property, you can specify a prettifier for it:

        -

        Type declaration

        Default

        {}
+

        Type declaration

        Default

        {}

        Example

        {
          customPrettifiers: {
            query: prettifyQuery
          }
        }
        //...
        const prettifyQuery = value => {
         // do some prettify magic
        }
        diff --git a/interfaces/index._internal_.WritableStream.html b/interfaces/factory._internal_.WritableStream.html similarity index 64% rename from interfaces/index._internal_.WritableStream.html rename to interfaces/factory._internal_.WritableStream.html index 9053554..6c2261a 100644 --- a/interfaces/index._internal_.WritableStream.html +++ b/interfaces/factory._internal_.WritableStream.html @@ -1,25 +1,25 @@ -WritableStream | @foxxmd/logging Docs

        Interface WritableStream

        interface WritableStream {
            [captureRejectionSymbol]?<K>(error, event, ...args): void;
            addListener<K>(eventName, listener): this;
            on<K>(eventName, listener): this;
            once<K>(eventName, listener): this;
            removeListener<K>(eventName, listener): this;
            off<K>(eventName, listener): this;
            removeAllListeners(event?): this;
            setMaxListeners(n): this;
            getMaxListeners(): number;
            listeners<K>(eventName): Function[];
            rawListeners<K>(eventName): Function[];
            emit<K>(eventName, ...args): boolean;
            listenerCount<K>(eventName, listener?): number;
            prependListener<K>(eventName, listener): this;
            prependOnceListener<K>(eventName, listener): this;
            eventNames(): (string | symbol)[];
            writable: boolean;
            write(buffer, cb?): boolean;
            write(str, encoding?, cb?): boolean;
            end(cb?): this;
            end(data, cb?): this;
            end(str, encoding?, cb?): this;
        }

        Hierarchy

        • EventEmitter
          • WritableStream

        Properties

        writable -

        Methods

        [captureRejectionSymbol]? -addListener -on -once -removeListener -off -removeAllListeners -setMaxListeners -getMaxListeners -listeners -rawListeners -emit -listenerCount -prependListener -prependOnceListener -eventNames -write -end -

        Properties

        writable

        writable: boolean

        Methods

        Optional [captureRejectionSymbol]

        • [captureRejectionSymbol]<K>(error, event, ...args): void

        • Type Parameters

          • K

          Parameters

          • error: Error
          • event: string | symbol
          • Rest ...args: AnyRest

          Returns void

        addListener

        • addListener<K>(eventName, listener): this

        • Alias for emitter.on(eventName, listener).

          +WritableStream | @foxxmd/logging Docs

          Interface WritableStream

          interface WritableStream {
              [captureRejectionSymbol]?<K>(error, event, ...args): void;
              addListener<K>(eventName, listener): this;
              on<K>(eventName, listener): this;
              once<K>(eventName, listener): this;
              removeListener<K>(eventName, listener): this;
              off<K>(eventName, listener): this;
              removeAllListeners(event?): this;
              setMaxListeners(n): this;
              getMaxListeners(): number;
              listeners<K>(eventName): Function[];
              rawListeners<K>(eventName): Function[];
              emit<K>(eventName, ...args): boolean;
              listenerCount<K>(eventName, listener?): number;
              prependListener<K>(eventName, listener): this;
              prependOnceListener<K>(eventName, listener): this;
              eventNames(): (string | symbol)[];
              writable: boolean;
              write(buffer, cb?): boolean;
              write(str, encoding?, cb?): boolean;
              end(cb?): this;
              end(data, cb?): this;
              end(str, encoding?, cb?): this;
          }

          Hierarchy

          • EventEmitter
            • WritableStream

          Properties

          writable +

          Methods

          [captureRejectionSymbol]? +addListener +on +once +removeListener +off +removeAllListeners +setMaxListeners +getMaxListeners +listeners +rawListeners +emit +listenerCount +prependListener +prependOnceListener +eventNames +write +end +

          Properties

          writable

          writable: boolean

          Methods

          Optional [captureRejectionSymbol]

          • [captureRejectionSymbol]<K>(error, event, ...args): void

          • Type Parameters

            • K

            Parameters

            • error: Error
            • event: string | symbol
            • Rest ...args: AnyRest

            Returns void

          addListener

          • addListener<K>(eventName, listener): this

          • Alias for emitter.on(eventName, listener).

            Type Parameters

            • K

            Parameters

            • eventName: string | symbol
            • listener: ((...args) => void)
                • (...args): void

                • Parameters

                  • Rest ...args: any[]

                  Returns void

            Returns this

            Since

            v0.1.26

            -

          on

          • on<K>(eventName, listener): this

          • Adds the listener function to the end of the listeners array for the +

          on

          • on<K>(eventName, listener): this

          • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

            @@ -33,7 +33,7 @@ event listener to the beginning of the listeners array.

            Type Parameters

            • K

            Parameters

            • eventName: string | symbol

              The name of the event.

            • listener: ((...args) => void)

              The callback function

                • (...args): void

                • Parameters

                  • Rest ...args: any[]

                  Returns void

            Returns this

            Since

            v0.1.101

            -

          once

          • once<K>(eventName, listener): this

          • Adds a one-timelistener function for the event named eventName. The +

          once

          • once<K>(eventName, listener): this

          • Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

            server.once('connection', (stream) => {
              console.log('Ah, we have our first user!');
            });
            @@ -45,7 +45,7 @@ event listener to the beginning of the listeners array.

            Type Parameters

            • K

            Parameters

            • eventName: string | symbol

              The name of the event.

            • listener: ((...args) => void)

              The callback function

                • (...args): void

                • Parameters

                  • Rest ...args: any[]

                  Returns void

            Returns this

            Since

            v0.3.0

            -

          removeListener

          • removeListener<K>(eventName, listener): this

          • Removes the specified listener from the listener array for the event namedeventName.

            +

          removeListener

          • removeListener<K>(eventName, listener): this

          • Removes the specified listener from the listener array for the event namedeventName.

            const callback = (stream) => {
              console.log('someone connected!');
            };
            server.on('connection', callback);
            // ...
            server.removeListener('connection', callback);

            removeListener() will remove, at most, one instance of a listener from the @@ -69,7 +69,7 @@ recently added instance. In the example the once('ping')lis

            Returns a reference to the EventEmitter, so that calls can be chained.

            Type Parameters

            • K

            Parameters

            • eventName: string | symbol
            • listener: ((...args) => void)
                • (...args): void

                • Parameters

                  • Rest ...args: any[]

                  Returns void

            Returns this

            Since

            v0.1.26

            -

          off

          • off<K>(eventName, listener): this

          • Alias for emitter.removeListener().

            +

          off

          • off<K>(eventName, listener): this

          • Alias for emitter.removeListener().

            Type Parameters

            • K

            Parameters

            • eventName: string | symbol
            • listener: ((...args) => void)
                • (...args): void

                • Parameters

                  • Rest ...args: any[]

                  Returns void

            Returns this

            Since

            v10.0.0

          removeAllListeners

          • removeAllListeners(event?): this

          • Removes all listeners, or those of the specified eventName.

            It is bad practice to remove listeners added elsewhere in the code, @@ -86,28 +86,28 @@ modified for this specific EventEmitter instance. The value can be

          getMaxListeners

          • getMaxListeners(): number

          • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

            Returns number

            Since

            v1.0.0

            -

          listeners

          • listeners<K>(eventName): Function[]

          • Returns a copy of the array of listeners for the event named eventName.

            +

          listeners

          • listeners<K>(eventName): Function[]

          • Returns a copy of the array of listeners for the event named eventName.

            server.on('connection', (stream) => {
              console.log('someone connected!');
            });
            console.log(util.inspect(server.listeners('connection')));
            // Prints: [ [Function] ]

            Type Parameters

            • K

            Parameters

            • eventName: string | symbol

            Returns Function[]

            Since

            v0.1.26

            -

          rawListeners

          • rawListeners<K>(eventName): Function[]

          • Returns a copy of the array of listeners for the event named eventName, +

          rawListeners

          • rawListeners<K>(eventName): Function[]

          • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

            const emitter = new EventEmitter();
            emitter.once('log', () => console.log('log once'));

            // Returns a new Array with a function `onceWrapper` which has a property
            // `listener` which contains the original listener bound above
            const listeners = emitter.rawListeners('log');
            const logFnWrapper = listeners[0];

            // Logs "log once" to the console and does not unbind the `once` event
            logFnWrapper.listener();

            // Logs "log once" to the console and removes the listener
            logFnWrapper();

            emitter.on('log', () => console.log('log persistently'));
            // Will return a new Array with a single function bound by `.on()` above
            const newListeners = emitter.rawListeners('log');

            // Logs "log persistently" twice
            newListeners[0]();
            emitter.emit('log');

            Type Parameters

            • K

            Parameters

            • eventName: string | symbol

            Returns Function[]

            Since

            v9.4.0

            -

          emit

          • emit<K>(eventName, ...args): boolean

          • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments +

          emit

          • emit<K>(eventName, ...args): boolean

          • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

            Returns true if the event had listeners, false otherwise.

            const EventEmitter = require('events');
            const myEmitter = new EventEmitter();

            // First listener
            myEmitter.on('event', function firstListener() {
              console.log('Helloooo! first listener');
            });
            // Second listener
            myEmitter.on('event', function secondListener(arg1, arg2) {
              console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
            });
            // Third listener
            myEmitter.on('event', function thirdListener(...args) {
              const parameters = args.join(', ');
              console.log(`event with parameters ${parameters} in third listener`);
            });

            console.log(myEmitter.listeners('event'));

            myEmitter.emit('event', 1, 2, 3, 4, 5);

            // Prints:
            // [
            //   [Function: firstListener],
            //   [Function: secondListener],
            //   [Function: thirdListener]
            // ]
            // Helloooo! first listener
            // event with parameters 1, 2 in second listener
            // event with parameters 1, 2, 3, 4, 5 in third listener

            Type Parameters

            • K

            Parameters

            • eventName: string | symbol
            • Rest ...args: AnyRest

            Returns boolean

            Since

            v0.1.26

            -

          listenerCount

          • listenerCount<K>(eventName, listener?): number

          • Returns the number of listeners listening to the event named eventName.

            +

          listenerCount

          • listenerCount<K>(eventName, listener?): number

          • Returns the number of listeners listening to the event named eventName.

            If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

            Type Parameters

            • K

            Parameters

            • eventName: string | symbol

              The name of the event being listened for

            • Optional listener: Function

              The event handler function

            Returns number

            Since

            v3.2.0

            -

          prependListener

          • prependListener<K>(eventName, listener): this

          • Adds the listener function to the beginning of the listeners array for the +

          prependListener

          • prependListener<K>(eventName, listener): this

          • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

            @@ -117,7 +117,7 @@ times.

            Type Parameters

            • K

            Parameters

            • eventName: string | symbol

              The name of the event.

            • listener: ((...args) => void)

              The callback function

                • (...args): void

                • Parameters

                  • Rest ...args: any[]

                  Returns void

            Returns this

            Since

            v6.0.0

            -

          prependOnceListener

          • prependOnceListener<K>(eventName, listener): this

          • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

          prependOnceListener

          • prependOnceListener<K>(eventName, listener): this

          • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

            server.prependOnceListener('connection', (stream) => {
              console.log('Ah, we have our first user!');
            });
            @@ -130,4 +130,4 @@ listeners. The values in the array are strings or Symbols.

            const EventEmitter = require('events');
            const myEE = new EventEmitter();
            myEE.on('foo', () => {});
            myEE.on('bar', () => {});

            const sym = Symbol('symbol');
            myEE.on(sym, () => {});

            console.log(myEE.eventNames());
            // Prints: [ 'foo', 'bar', Symbol(symbol) ]

            Returns (string | symbol)[]

            Since

            v6.0.0

            -

          write

          • write(buffer, cb?): boolean

          • Parameters

            • buffer: string | Uint8Array
            • Optional cb: ((err?) => void)
                • (err?): void

                • Parameters

                  • Optional err: Error

                  Returns void

            Returns boolean

          • write(str, encoding?, cb?): boolean

          • Parameters

            • str: string
            • Optional encoding: BufferEncoding
            • Optional cb: ((err?) => void)
                • (err?): void

                • Parameters

                  • Optional err: Error

                  Returns void

            Returns boolean

          end

          • end(cb?): this

          • Parameters

            • Optional cb: (() => void)
                • (): void

                • Returns void

            Returns this

          • end(data, cb?): this

          • Parameters

            • data: string | Uint8Array
            • Optional cb: (() => void)
                • (): void

                • Returns void

            Returns this

          • end(str, encoding?, cb?): this

          • Parameters

            • str: string
            • Optional encoding: BufferEncoding
            • Optional cb: (() => void)
                • (): void

                • Returns void

            Returns this

          Settings

          Member Visibility

          Theme

          On This Page

          writable[captureRejectionSymbol]addListenerononceremoveListeneroffremoveAllListenerssetMaxListenersgetMaxListenerslistenersrawListenersemitlistenerCountprependListenerprependOnceListenereventNameswriteend

          Generated using TypeDoc

          \ No newline at end of file +

        write

        • write(buffer, cb?): boolean

        • Parameters

          • buffer: string | Uint8Array
          • Optional cb: ((err?) => void)
              • (err?): void

              • Parameters

                • Optional err: Error

                Returns void

          Returns boolean

        • write(str, encoding?, cb?): boolean

        • Parameters

          • str: string
          • Optional encoding: BufferEncoding
          • Optional cb: ((err?) => void)
              • (err?): void

              • Parameters

                • Optional err: Error

                Returns void

          Returns boolean

        end

        • end(cb?): this

        • Parameters

          • Optional cb: (() => void)
              • (): void

              • Returns void

          Returns this

        • end(data, cb?): this

        • Parameters

          • data: string | Uint8Array
          • Optional cb: (() => void)
              • (): void

              • Returns void

          Returns this

        • end(str, encoding?, cb?): this

        • Parameters

          • str: string
          • Optional encoding: BufferEncoding
          • Optional cb: (() => void)
              • (): void

              • Returns void

          Returns this

        Settings

        Member Visibility

        Theme

        On This Page

        writable[captureRejectionSymbol]addListenerononceremoveListeneroffremoveAllListenerssetMaxListenersgetMaxListenerslistenersrawListenersemitlistenerCountprependListenerprependOnceListenereventNameswriteend

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/index.FileLogOptions.html b/interfaces/index.FileLogOptions.html index f1186a8..8ec52aa 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 d1a74bc..d8bbd46 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._internal_.LoggerAppExtras.html b/interfaces/index.LoggerAppExtras.html similarity index 74% rename from interfaces/index._internal_.LoggerAppExtras.html rename to interfaces/index.LoggerAppExtras.html index 9cf5250..054c9cf 100644 --- a/interfaces/index._internal_.LoggerAppExtras.html +++ b/interfaces/index.LoggerAppExtras.html @@ -1,5 +1,5 @@ -LoggerAppExtras | @foxxmd/logging Docs

        Interface LoggerAppExtras

        interface LoggerAppExtras {
            pretty?: PrettyOptions_;
            destinations?: LogLevelStreamEntry[];
        }

        Properties

        pretty? -destinations? -

        Properties

        Optional pretty

        pretty?: PrettyOptions_

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

        -

        Optional destinations

        destinations?: LogLevelStreamEntry[]

        Additional logging destinations to use alongside the built-in console/log stream. These can be any created by buildDestination* functions or other Pino Transports

        -

        Settings

        Member Visibility

        Theme

        On This Page

        prettydestinations

        Generated using TypeDoc

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

        Interface LoggerAppExtras

        interface LoggerAppExtras {
            pretty?: PrettyOptions_;
            destinations?: LogLevelStreamEntry[];
        }

        Properties

        pretty? +destinations? +

        Properties

        Optional pretty

        pretty?: PrettyOptions_

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

        +

        Optional destinations

        destinations?: LogLevelStreamEntry[]

        Additional logging destinations to use alongside the built-in console/log stream. These can be any created by buildDestination* functions or other Pino Transports

        +

        Settings

        Member Visibility

        Theme

        On This Page

        prettydestinations

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/index._internal_.Colorette.html b/interfaces/index._internal_.Colorette.html deleted file mode 100644 index 7a943c3..0000000 --- a/interfaces/index._internal_.Colorette.html +++ /dev/null @@ -1,42 +0,0 @@ -Colorette | @foxxmd/logging Docs

        Interface Colorette

        interface Colorette {
            reset: Color;
            bold: Color;
            dim: Color;
            italic: Color;
            underline: Color;
            inverse: Color;
            hidden: Color;
            strikethrough: Color;
            black: Color;
            red: Color;
            green: Color;
            yellow: Color;
            blue: Color;
            magenta: Color;
            cyan: Color;
            white: Color;
            gray: Color;
            bgBlack: Color;
            bgRed: Color;
            bgGreen: Color;
            bgYellow: Color;
            bgBlue: Color;
            bgMagenta: Color;
            bgCyan: Color;
            bgWhite: Color;
            blackBright: Color;
            redBright: Color;
            greenBright: Color;
            yellowBright: Color;
            blueBright: Color;
            magentaBright: Color;
            cyanBright: Color;
            whiteBright: Color;
            bgBlackBright: Color;
            bgRedBright: Color;
            bgGreenBright: Color;
            bgYellowBright: Color;
            bgBlueBright: Color;
            bgMagentaBright: Color;
            bgCyanBright: Color;
            bgWhiteBright: Color;
        }

        Properties

        reset -bold -dim -italic -underline -inverse -hidden -strikethrough -black -red -green -yellow -blue -magenta -cyan -white -gray -bgBlack -bgRed -bgGreen -bgYellow -bgBlue -bgMagenta -bgCyan -bgWhite -blackBright -redBright -greenBright -yellowBright -blueBright -magentaBright -cyanBright -whiteBright -bgBlackBright -bgRedBright -bgGreenBright -bgYellowBright -bgBlueBright -bgMagentaBright -bgCyanBright -bgWhiteBright -

        Properties

        reset

        reset: Color

        bold

        bold: Color

        dim

        dim: Color

        italic

        italic: Color

        underline

        underline: Color

        inverse

        inverse: Color

        hidden

        hidden: Color

        strikethrough

        strikethrough: Color

        black

        black: Color

        red

        red: Color

        green

        green: Color

        yellow

        yellow: Color

        blue

        blue: Color

        magenta

        magenta: Color

        cyan

        cyan: Color

        white

        white: Color

        gray

        gray: Color

        bgBlack

        bgBlack: Color

        bgRed

        bgRed: Color

        bgGreen

        bgGreen: Color

        bgYellow

        bgYellow: Color

        bgBlue

        bgBlue: Color

        bgMagenta

        bgMagenta: Color

        bgCyan

        bgCyan: Color

        bgWhite

        bgWhite: Color

        blackBright

        blackBright: Color

        redBright

        redBright: Color

        greenBright

        greenBright: Color

        yellowBright

        yellowBright: Color

        blueBright

        blueBright: Color

        magentaBright

        magentaBright: Color

        cyanBright

        cyanBright: Color

        whiteBright

        whiteBright: Color

        bgBlackBright

        bgBlackBright: Color

        bgRedBright

        bgRedBright: Color

        bgGreenBright

        bgGreenBright: Color

        bgYellowBright

        bgYellowBright: Color

        bgBlueBright

        bgBlueBright: Color

        bgMagentaBright

        bgMagentaBright: Color

        bgCyanBright

        bgCyanBright: Color

        bgWhiteBright

        bgWhiteBright: Color

        Settings

        Member Visibility

        Theme

        On This Page

        resetbolddimitalicunderlineinversehiddenstrikethroughblackredgreenyellowbluemagentacyanwhitegraybgBlackbgRedbgGreenbgYellowbgBluebgMagentabgCyanbgWhiteblackBrightredBrightgreenBrightyellowBrightblueBrightmagentaBrightcyanBrightwhiteBrightbgBlackBrightbgRedBrightbgGreenBrightbgYellowBrightbgBlueBrightbgMagentaBrightbgCyanBrightbgWhiteBright

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/index._internal_.DestinationStream.html b/interfaces/index._internal_.DestinationStream.html index 6916248..c2e27c8 100644 --- a/interfaces/index._internal_.DestinationStream.html +++ b/interfaces/index._internal_.DestinationStream.html @@ -1,2 +1,2 @@ -DestinationStream | @foxxmd/logging Docs

        Interface DestinationStream

        interface DestinationStream {
            write(msg): void;
        }

        Hierarchy (view full)

        Methods

        write +DestinationStream | @foxxmd/logging Docs

        Interface DestinationStream

        interface DestinationStream {
            write(msg): void;
        }

        Hierarchy (view full)

        Methods

        write

        Methods

        write

        • write(msg): void

        • Parameters

          • msg: string

          Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        write

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/index._internal_.FileLogOptionsStrong.html b/interfaces/index._internal_.FileLogOptionsStrong.html index 7fb15af..13fb8bf 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 f7da077..c03e507 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 11af602..c6ea3bf 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 77c829a..9022379 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._internal_.html b/modules/factory._internal_.html index 79e414d..3ed45f4 100644 --- a/modules/factory._internal_.html +++ b/modules/factory._internal_.html @@ -1,4 +1,15 @@ -<internal> | @foxxmd/logging Docs

        Module <internal>

        Index

        Type Aliases

        MarkRequired +<internal> | @foxxmd/logging Docs

        Module <internal>

        Index

        Interfaces

        WritableStream +Colorette +PrettyOptions_ +DestinationStream +

        Type Aliases

        BufferEncoding +Color +LogDescriptor +Prettifier +PrettifierExtras +LevelPrettifierExtras +MessageFormatFunc +MarkRequired Extract FileOptionsParsed

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

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

        Module factory

        Index

        Modules

        <internal> +factory | @foxxmd/logging Docs

        Module factory

        Index

        Modules

        <internal>

        Type Aliases

        FileDestination StreamDestination

        Variables

        PRETTY_LEVELS diff --git a/modules/index._internal_.html b/modules/index._internal_.html index d2ffba0..fdb8c6a 100644 --- a/modules/index._internal_.html +++ b/modules/index._internal_.html @@ -8,9 +8,6 @@ _DOMEventTarget StaticEventEmitterOptions CallSite -WritableStream -Colorette -PrettyOptions_ redactOptions LoggerExtras BaseLogger @@ -20,7 +17,6 @@ LogFn ChildLoggerOptions ChildLoggerOptions -DestinationStream LogFn StreamEntry IteratorYieldResult @@ -32,21 +28,13 @@ RollOptions FileOptions FileLogOptionsStrong -LoggerAppExtras -

        Type Aliases

        BufferEncoding -EventMap +

        Type Aliases

        EventMap DefaultEventMap AnyRest Args Key Key2 Listener -Color -LogDescriptor -Prettifier -PrettifierExtras -LevelPrettifierExtras -MessageFormatFunc CustomLevelLogger OnChildCallback Bindings diff --git a/modules/index.html b/modules/index.html index 8631c74..952e22f 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,6 +1,7 @@ -index | @foxxmd/logging Docs

        Module index

        Index

        Modules

        <internal> +index | @foxxmd/logging Docs

        Module index

        Index

        Modules

        <internal>

        Interfaces

        LogOptions FileLogOptions +LoggerAppExtras

        Type Aliases

        LogLevel Logger LogLevelStreamEntry diff --git a/types/factory.FileDestination.html b/types/factory.FileDestination.html index bcad0cc..e972ce4 100644 --- a/types/factory.FileDestination.html +++ b/types/factory.FileDestination.html @@ -1 +1 @@ -FileDestination | @foxxmd/logging Docs

        Type alias FileDestination

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

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

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

        Type alias FileDestination

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

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/factory.StreamDestination.html b/types/factory.StreamDestination.html index 56de735..160789d 100644 --- a/types/factory.StreamDestination.html +++ b/types/factory.StreamDestination.html @@ -1 +1 @@ -StreamDestination | @foxxmd/logging Docs

        Type alias StreamDestination

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

        Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

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

        Type alias StreamDestination

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

        Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/factory._internal_.BufferEncoding.html b/types/factory._internal_.BufferEncoding.html new file mode 100644 index 0000000..14aff5a --- /dev/null +++ b/types/factory._internal_.BufferEncoding.html @@ -0,0 +1 @@ +BufferEncoding | @foxxmd/logging Docs

        Type alias BufferEncoding

        BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/factory._internal_.Color.html b/types/factory._internal_.Color.html new file mode 100644 index 0000000..542aa53 --- /dev/null +++ b/types/factory._internal_.Color.html @@ -0,0 +1 @@ +Color | @foxxmd/logging Docs

        Type alias Color

        Color: ((text) => string)

        Type declaration

          • (text): string

          • Parameters

            • text: string | number

            Returns string

        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 41983d1..313520c 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_.LevelPrettifierExtras.html b/types/factory._internal_.LevelPrettifierExtras.html new file mode 100644 index 0000000..5d0b9a5 --- /dev/null +++ b/types/factory._internal_.LevelPrettifierExtras.html @@ -0,0 +1 @@ +LevelPrettifierExtras | @foxxmd/logging Docs

        Type alias LevelPrettifierExtras

        LevelPrettifierExtras: {
            label: string;
            labelColorized: string;
        }

        Type declaration

        • label: string
        • labelColorized: string

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/factory._internal_.LogDescriptor.html b/types/factory._internal_.LogDescriptor.html new file mode 100644 index 0000000..15626d7 --- /dev/null +++ b/types/factory._internal_.LogDescriptor.html @@ -0,0 +1 @@ +LogDescriptor | @foxxmd/logging Docs

        Type alias LogDescriptor

        LogDescriptor: Record<string, unknown>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/factory._internal_.MessageFormatFunc.html b/types/factory._internal_.MessageFormatFunc.html new file mode 100644 index 0000000..328d2a0 --- /dev/null +++ b/types/factory._internal_.MessageFormatFunc.html @@ -0,0 +1 @@ +MessageFormatFunc | @foxxmd/logging Docs

        Type alias MessageFormatFunc

        MessageFormatFunc: ((log, messageKey, levelLabel, extras) => string)

        Type declaration

          • (log, messageKey, levelLabel, extras): string

          • Parameters

            Returns string

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/factory._internal_.Prettifier.html b/types/factory._internal_.Prettifier.html new file mode 100644 index 0000000..fac3fed --- /dev/null +++ b/types/factory._internal_.Prettifier.html @@ -0,0 +1 @@ +Prettifier | @foxxmd/logging Docs

        Type alias Prettifier<T>

        Prettifier<T>: ((inputData, key, log, extras) => string)

        Type Parameters

        • T = object

        Type declaration

          • (inputData, key, log, extras): string

          • Parameters

            Returns string

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/factory._internal_.PrettifierExtras.html b/types/factory._internal_.PrettifierExtras.html new file mode 100644 index 0000000..999abea --- /dev/null +++ b/types/factory._internal_.PrettifierExtras.html @@ -0,0 +1 @@ +PrettifierExtras | @foxxmd/logging Docs

        Type alias PrettifierExtras<T>

        PrettifierExtras<T>: {
            colors: Colorette;
        } & T

        Type Parameters

        • T = object

        Type declaration

        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 aea120c..2d03aa6 100644 --- a/types/index.LogData.html +++ b/types/index.LogData.html @@ -1 +1 @@ -LogData | @foxxmd/logging Docs

        Type alias LogData

        LogData: Record<string, any> & {
            level: number;
            time: number;
            pid: number;
            hostname: string;
            labels: any[];
            msg: string | Error | ErrorWithCause;
        }

        Type declaration

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

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

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

        Type alias LogData

        LogData: Record<string, any> & {
            level: number;
            time: number;
            pid: number;
            hostname: string;
            labels: any[];
            msg: string | Error | ErrorWithCause;
        }

        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 def896f..a58fa06 100644 --- a/types/index.LogLevel.html +++ b/types/index.LogLevel.html @@ -1 +1 @@ -LogLevel | @foxxmd/logging Docs

        Type alias LogLevel

        LogLevel: typeof LOG_LEVELS[number]

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

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

        Type alias LogLevel

        LogLevel: typeof LOG_LEVELS[number]

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

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

        Type alias LogLevelStreamEntry

        LogLevelStreamEntry: StreamEntry<LogLevel>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

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

        Type alias LogLevelStreamEntry

        LogLevelStreamEntry: StreamEntry<LogLevel>

        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 68d1e11..3a01993 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_.BufferEncoding.html b/types/index._internal_.BufferEncoding.html deleted file mode 100644 index f567d2b..0000000 --- a/types/index._internal_.BufferEncoding.html +++ /dev/null @@ -1 +0,0 @@ -BufferEncoding | @foxxmd/logging Docs

        Type alias BufferEncoding

        BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/index._internal_.Color.html b/types/index._internal_.Color.html deleted file mode 100644 index 15175c1..0000000 --- a/types/index._internal_.Color.html +++ /dev/null @@ -1 +0,0 @@ -Color | @foxxmd/logging Docs

        Type alias Color

        Color: ((text) => string)

        Type declaration

          • (text): string

          • Parameters

            • text: string | number

            Returns string

        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 8b61596..6bd5885 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_.LevelPrettifierExtras.html b/types/index._internal_.LevelPrettifierExtras.html deleted file mode 100644 index d5f56bf..0000000 --- a/types/index._internal_.LevelPrettifierExtras.html +++ /dev/null @@ -1 +0,0 @@ -LevelPrettifierExtras | @foxxmd/logging Docs

        Type alias LevelPrettifierExtras

        LevelPrettifierExtras: {
            label: string;
            labelColorized: string;
        }

        Type declaration

        • label: string
        • labelColorized: string

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/index._internal_.LogDescriptor.html b/types/index._internal_.LogDescriptor.html deleted file mode 100644 index 282e7db..0000000 --- a/types/index._internal_.LogDescriptor.html +++ /dev/null @@ -1 +0,0 @@ -LogDescriptor | @foxxmd/logging Docs

        Type alias LogDescriptor

        LogDescriptor: Record<string, unknown>

        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 8ff8566..5e898f2 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/types/index._internal_.MessageFormatFunc.html b/types/index._internal_.MessageFormatFunc.html deleted file mode 100644 index f46f424..0000000 --- a/types/index._internal_.MessageFormatFunc.html +++ /dev/null @@ -1 +0,0 @@ -MessageFormatFunc | @foxxmd/logging Docs

        Type alias MessageFormatFunc

        MessageFormatFunc: ((log, messageKey, levelLabel, extras) => string)

        Type declaration

          • (log, messageKey, levelLabel, extras): string

          • Parameters

            Returns string

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/index._internal_.Prettifier.html b/types/index._internal_.Prettifier.html deleted file mode 100644 index a386d78..0000000 --- a/types/index._internal_.Prettifier.html +++ /dev/null @@ -1 +0,0 @@ -Prettifier | @foxxmd/logging Docs

        Type alias Prettifier<T>

        Prettifier<T>: ((inputData, key, log, extras) => string)

        Type Parameters

        • T = object

        Type declaration

          • (inputData, key, log, extras): string

          • Parameters

            Returns string

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/index._internal_.PrettifierExtras.html b/types/index._internal_.PrettifierExtras.html deleted file mode 100644 index b08f724..0000000 --- a/types/index._internal_.PrettifierExtras.html +++ /dev/null @@ -1 +0,0 @@ -PrettifierExtras | @foxxmd/logging Docs

        Type alias PrettifierExtras<T>

        PrettifierExtras<T>: {
            colors: Colorette;
        } & T

        Type Parameters

        • T = object

        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 70ee414..f30554f 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

        +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 dd14b21..3c30935 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

        +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 80abbac..d79c61e 100644 --- a/variables/factory.PRETTY_ISO8601.html +++ b/variables/factory.PRETTY_ISO8601.html @@ -1,2 +1,2 @@ PRETTY_ISO8601 | @foxxmd/logging Docs

        Variable PRETTY_ISO8601Const

        PRETTY_ISO8601: "SYS:yyyy-mm-dd\"T\"HH:MM:ssp" = 'SYS:yyyy-mm-dd"T"HH:MM:ssp'

        Use on translateTime pino-pretty option to print timestamps in ISO8601 format

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/variables/factory.PRETTY_LEVELS.html b/variables/factory.PRETTY_LEVELS.html index 94348d3..dea8021 100644 --- a/variables/factory.PRETTY_LEVELS.html +++ b/variables/factory.PRETTY_LEVELS.html @@ -1,3 +1,3 @@ -PRETTY_LEVELS | @foxxmd/logging Docs

        Variable PRETTY_LEVELSConst

        PRETTY_LEVELS: Extract<PrettyOptions_["customLevels"], object> = ...

        Additional levels included in @foxxmd/logging as an object

        +PRETTY_LEVELS | @foxxmd/logging Docs

        Variable PRETTY_LEVELSConst

        PRETTY_LEVELS: Extract<PrettyOptions_["customLevels"], object> = ...

        Additional levels included in @foxxmd/logging as an object

        These are always applied when using prettyOptsFactory() but can be overridden

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/variables/factory.PRETTY_LEVELS_STR.html b/variables/factory.PRETTY_LEVELS_STR.html index 122a4d3..59df475 100644 --- a/variables/factory.PRETTY_LEVELS_STR.html +++ b/variables/factory.PRETTY_LEVELS_STR.html @@ -1,3 +1,3 @@ -PRETTY_LEVELS_STR | @foxxmd/logging Docs

        Variable PRETTY_LEVELS_STRConst

        PRETTY_LEVELS_STR: Extract<PrettyOptions_["customLevels"], string> = 'verbose:25,log:21'

        Additional levels included in @foxxmd/logging as a string

        +PRETTY_LEVELS_STR | @foxxmd/logging Docs

        Variable PRETTY_LEVELS_STRConst

        PRETTY_LEVELS_STR: Extract<PrettyOptions_["customLevels"], string> = 'verbose:25,log:21'

        Additional levels included in @foxxmd/logging as a string

        These are always applied when using prettyOptsFactory() but can be overridden

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/variables/factory.prettyConsole.html b/variables/factory.prettyConsole.html index 2e200d8..1806208 100644 --- a/variables/factory.prettyConsole.html +++ b/variables/factory.prettyConsole.html @@ -1,4 +1,4 @@ -prettyConsole | @foxxmd/logging Docs

        Variable prettyConsoleConst

        prettyConsole: PrettyOptions_ = ...

        Pre-defined pretty options for use with console/stream output

        +prettyConsole | @foxxmd/logging Docs

        Variable prettyConsoleConst

        prettyConsole: PrettyOptions_ = ...

        Pre-defined pretty options for use with console/stream output

        Source

        const prettyConsole: PrettyOptions = prettyOptsFactory({sync: true})
        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/variables/factory.prettyFile.html b/variables/factory.prettyFile.html index a83dd91..f108b5b 100644 --- a/variables/factory.prettyFile.html +++ b/variables/factory.prettyFile.html @@ -1,4 +1,4 @@ -prettyFile | @foxxmd/logging Docs

        Variable prettyFileConst

        prettyFile: PrettyOptions_ = ...

        Pre-defined pretty options for use with file output

        +prettyFile | @foxxmd/logging Docs

        Variable prettyFileConst

        prettyFile: PrettyOptions_ = ...

        Pre-defined pretty options for use with file output

        Source

        const prettyFile: PrettyOptions = prettyOptsFactory({
            colorize: false,
            sync: false,
        })
        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/variables/index.LOG_LEVELS.html b/variables/index.LOG_LEVELS.html index 863fe04..7b5a91a 100644 --- a/variables/index.LOG_LEVELS.html +++ b/variables/index.LOG_LEVELS.html @@ -1 +1 @@ -LOG_LEVELS | @foxxmd/logging Docs

        Variable LOG_LEVELSConst

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

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

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

        Variable LOG_LEVELSConst

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

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/variables/index.loggerDebug.html b/variables/index.loggerDebug.html index 00203b5..ac38f3b 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 96edf75..3487419 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