diff --git a/assets/navigation.js b/assets/navigation.js index 971f453..174f107 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8Vda5PbthX9L8pXO/E6tht7Op1Za7XJ1lpLlTZ2M4lHA1GQhCxFsiDkrNLpf++AIkW8CF5ccNpP8WTvOefidfG6hH7990jQJzF6N9qSROT8NHo2KojYj96NDvnmmNLyu/oP3+7FIR09Gz2ybDN69/LZKNmzdMNpNnr364VkfWTp5oaWgmVEsDxb5GnKst0tS2lLvD1mifxjS+2B6bJvXv3nWadYqEog/VJwSg4hAmdEkMQmP4owCYkIk6CcB0pQzvskpvluR/t5z2YesoJTIU6zQpS3Zoe0KS1jEPE4z8o8pUH8OsYjM19MHh5+Wc3mD8vVePZxOZtOWoWvhDOyVgeVw1wn//6lu3JYYAEUAND72zu469LW47cUV3pUyypOhcJomBkR58Xbv1y9VlnPwwvAaxn2MddFG8+ms8VytXxYAOqhNfZUhGYLJu0nvFvOfnjz4grAWFt6KP/KMkF5RtK/dc8Fq8ZmBZoW3qf5elZUXbPlrCi2JHHTKhBD4vWbZ6MkJWUp27ncPGflc/p0ho2UYkiCVqwCdCvpElcvf4BJHLdbyidZkm9YtuvqfaqUBnD2QpDwZyb2d4ciZQkT45zyxNP5FXkXDO/EuTAyMAp+lFrgpjWByAauaHxd3tI0ez1KB1K451e4Mn2gp9n6d5qIh1NBAS2q2eOb8gM9TZ6KnIvAQWricIX++x+PWAccUKQPZZ59pusP9ASWviBwitfl6XCggrPkAz3dUEFYCi62CxvZ4UCh8mKNjJcsI/w0ZY+Qrt0aR/Vr+ECKHkK3OT8QARM72+Ll/vn6xdvxniaPgQPGxOF6TcVCuWBblhBBQX3HwOB6UHCDWoE4rEl/LskOqFaZRoldp7ucM7E/BITfCwbXkGN+KkQeEPUuAJzeAztQ4PhvTPFVeg5VzWorcKA4wbhCzwqa3ecbSKEbU3yhgUJxIktBRPmelBRamxcArgYrOCjKVJa42LKgZGOe8XiUWnOc3GfOBA3QU+wjBD8taHlMBbTdVAyu6WQ1BYoqEOTOgO3uMmF0mp5lewvBd9HAEKNAcJq3KdldZxs7vvh1DRhSm6VUNlRY0+qoOOXA2jZg2PmSEkHboR/oQwc8xhclLKCcsfH4cS5335/pGuVNFx7fR34i2SaFD4oLAqc44TzLJ08JLfSTSL+qjoqreXMugdW3a0aBKsu+E66so/Bldk6g/YXunEfBa9hTQTfXnJMTZBV7Mcavtir4+VzpE6N/AFQNBF76hiXg2C5t0YcQAVsenMZdQwtabF2scUutcX4oUirUU8POtrrYRnSQ8pQlIZo6AC98oTBXAf2lda4AAqTlUJ6yjCKmGQWGnHmPvMz5PIdPtQ0AqZcfirykt9mccDXYeWu5BeAruWEEjZnmX7ghY0t57pyaf5mnO6+6pdwXU+b0Adf85gKtpa/evvr+hccB6+LS6rnB4i1DuA/N/B/jhc0R7kc1VcU4YRDgayKqClDKzUoopvg2B96PKAdQyjfHIqVPgTFc8UDD44LrmSIowl2EcaHugZOs3Ob8MCZpuibJIyCiK9IWHB/fL1T4FjApkGvqhiW0HS5AXFPMSVk+7Hl+3O1DlRUoTptsNtfrnIsl22nznp3F43ZAx5tJPSAXdlTc0C05puInttt/JoLye8Ifw33pIEI5VQ7lVAcRyqlblrFyT0MPnRRvDAbcONnWJOGV0SBRpbdlYRNEg4tep61WBc8PrGTb02qFL/zzq281poDK+KJGDVbQlGV0mR95Qm9rJ8KiuJsDH8p1vhhf4n1wRPMQNzpiepQnMdVikMR7pWQi3gnK5eoprhN5CAf1dl4NneGcNfgG9TXauXhvcOs7Ex3vR13NODdqcLwX+KnTYMBNnUVNEj57NEjU1GnLwqbOBvf/njoVP4aaOpE9ANfsrJxwnnPMkukCRTU8K+2DBbhyg8X1ufOQVYaaNzdWbe0aiUqUTfKsPB4oR+heoAHCarcKyKOISaFA3WwOeLmKvFON0nYf0PmFVUxcicGpOPZgCcmLQVSuAYu7QQVnAOGL+dsoyzf0XVn1xu8uA+63EWhmWknw6gxeXcCryLlpbaTWe+NjlwtrR2o/MFBW/4lTlxQobdLe0Ua6oDChPFlrX8rg2sD6hgao/XuprtRR2pICuRrRx0Qz+WGGRIONHRGBBzwdPkQd9gQulDtcQCyavzjifxPz5oSBP8FxYbFJfbJUcvGJmvMV4BCpPT/SjHKWyP8J/x7JQzGET/UBa5WySdIjDc/07OMa2MubPBvKyZZqCB/HeSZ4nqagBI4uaFw+hbOU4NSOHoZ4196fhFVg+4gF1pg+Llxr/pxtKE9PLNstWfZY3cyEOuehGMKncZqXjjOpEJ80iiF8WgoSW08axRA+VRmCcT5pFNE+VcfOY5IlNI1wy8EyjGfzYxrtl8oxjFexPcsmifWrijnGPQTUnRY7TO1gK2SI8YUbUkPMsdV5HnbKcFAMm7DtPSzTQeapMPCEbohU8ecvB16Rgb/h9zAMUBsdHiHXhvgnAHwrlMCKclFE1ZTfJ/zKK7autOpHV1cHy3B9C19pHTTYeuv6cMNbTToIGYGG+GQEG4F0lroyq5UatKd4GAaojQ6PQqpGoximd2BHVQ/LcPUVPqp6aLD19o8jPcrFiuBE0B34kxYDNoj2kv0JXuI5oMjPFFwvQvi1Ox+EgGrOKeUIXQOGPB386XoxWU0+fgKOiIs9qu+fs5Aon7JS3AkKya0yIRGvCtBSPm8xzznsoRjFHnkpl/NHykOv5FQQdkVRVvucKTsw+NfjOgrZk5un+qTzK3BH1lDI5Gt2oLeQfKmzYUQvYk8sAynVlpFS95TvaBPX4LoGDO9ENQ2DdGvLyEx++QrWA+E7GvoSgRsdkcovud6TMvTaxIWN9GLJsl3w3b4bHekJMg+uCx/pzf0xFQzrigrG+XF+BzZQXwOhdSdfaQa+/Gnskd8Wdb8e7JfteUT4f1fL2LWw/NBiQf91ZFrmXXfcVczxQbDKfQ54iLKxR35RXmdaB6lZ6TuhaqgyKjjkUndPeP2OQdCzmxYOtfT1qPdcw5tAbHe2iBDPnvo4kKl58jP+6ko/pEfoqCGU7e8BQjzoyP4P8SR0KGqgiLRI/Sm7Hs0GgNObPAlOEsg9fG2JD6NKFwW+1WcgBpHWnzoB1G0Lw45y+QZQPe/NCS9BM5eFcRZey4DP8o55uVPEwrhFvmgpVCzbqN81N5ls1f828O5cNFZOc/vZxDYZ7MykWpnJXmpWmawcCJ9h6KGsfO7+3YEznWLkoUorgwdaCtfEdmZqbcxJzCK6oevjro+pMuqlui6K7sJdTHqLdl0U9Y9qANhqSw/pNN9N6Veamn33TNT8tW8oTGc/rqaTT5Pp6uP1/cT5Hn5NqBt6Ks3Vw5TYcfGvaxNhLZ47S2h1KEf56nqob44zwa0no/QKUwwB3DdEkE4++cc+Dhm7QBWmG/ZX2nVRVLNQTyOolj5S7ZCrMvfw2sY+at+PHZz5lDAMCZrV0qI5D+yvWXNRYiAj1kQNk31e61fGnddWm+TJgQnh329a2g4grtCrj/mGVmznQyyYvIlCat/M7sOldRA2Q5kIlqBrvxOOXKQqRIB+p5rHdzvAAFbNoz+sjNf+xqCoHQl5PUnmiHbufPp8uKDjW3tBt5TTLGHZriP6BPgFIY53GR+pPe4OF8Q7WQMHls/BkEH3xfTtnhTu1YfpyD0pnCsR4BFqdTsPVjTsI7ai2Wmh7Qc6BGu7mD3vztoD2ip85970gSS0BzY7FOyXNcMEXkIUzMydAAl5iS2PjHplGkO8lEzvXLKObAJLr7FGJk3kad5fpsoqokASTgW4RI05+tbhhpYJZ4UAFE2zxhexWvazLQN0kNZ0CDlzo9Mr6tzvhAwEuVMM1neiohNCzj9jI09wex2wEBHd+ViK/FCVyLdJV3u0icCLz7KxXAx2ve1iSRv2eGFONyTx3uxb2hok5gqxdzdv3R927OpBmvL232xYn2Jrj9RjmfyRl/5B1BhGDl7YYI0UmfGl4I6fJXSLNdaRovIXBpcs1S7YfbKt/WDCYeW2cXhHlpQzkrI/Kbdzfuydt2IcWfbxnmS78yEGfJHUAYxwBRaJY8MvLKXCsS0YJKHCeZLrP2DpOtGFxl/ZUPekKLQu7Y2/CgId82/dl7mu5rT6L3Tl297MBE1qNi6iZmEDJeZX5ILGRYzQcPWJvT8N7TfobIyIUYjVrL77k7PFmBxL0BmMBsAdbzZJO78wmvp+ackSdwAj0o5EzhdUHHmGcUFFxvrgeonAIxz37ECbJNKVXOO+SInLtNJSU7Dq0fle9aOPnfktju3tBYBNvHcnC1pK8WmCcwbYtkkjvMSCJjmHlEWa4WUmT0l6tH/v0Y5FZ7uITe+B9Q88aRTTKlkuEw+C5i4D5LvpDeYG8ioJQDBeBdDH2965LwXPoQtAFxKu5M586hGBpT4Fi8AEZNrTl/8CMLEbW8mGAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8Vda5PbthX9L8pXO/E6tht7Op1Za7XJ1lpLlTZ2M4lHA1GQhCxFsiDkrNLpf++AIkW8CF5ccNpP8WTvOefidfG6hH7990jQJzF6N9qSROT8NHo2KojYj96NDvnmmNLyu/oP3+7FIR09Gz2ybDN69/LZKNmzdMNpNnr364VkfWTp5oaWgmVEsDxb5GnKst0tS2lLvD1mifxjS+2B6bJvXv3nWadYqEog/VJwSg4hAmdEkMQmP4owCYkIk6CcB0pQzvskpvluR/t5z2YesoJTIU6zQpS3Zoe0KS1jEPE4z8o8pUH8OsYjM19MHh5+Wc3mD8vVePZxOZtOWoWvhDOyVgeVw1wn//6lu3JYYAEUAND72zu469LW47cUV3pUyypOhcJomBkR58Xbv1y9VlnPwwvAaxn2MddFG8+ms8VytXxYAOqhNfZUhGYLJu0nvFvOfnjz4grAWFt6KP/KMkF5RtK/dc8Fq8ZmBZoW3qf5elZUXbPlrCi2JHHTKhBD4vWbZ6MkJWUp27ncPGflc/p0ho2UYkiCVqwCdCvpElcvf4BJHLdbyidZkm9YtuvqfaqUBnD2QpDwZyb2d4ciZQkT45zyxNP5FXkXDO/EuTAyMAp+lFrgpjWByAauaHxd3tI0ez1KB1K451e4Mn2gp9n6d5qIh1NBAS2q2eOb8gM9TZ6KnIvAQWricIX++x+PWAccUKQPZZ59pusP9ASWviBwitfl6XCggrPkAz3dUEFYCi62CxvZ4UCh8mKNjJcsI/w0ZY+Qrt0aR/Vr+ECKHkK3OT8QARM72+Ll/vn6xdvxniaPgQPGxOF6TcVCuWBblhBBQX3HwOB6UHCDWoE4rEl/LskOqFaZRoldp7ucM7E/BITfCwbXkGN+KkQeEPUuAJzeAztQ4PhvTPFVeg5VzWorcKA4wbhCzwqa3ecbSKEbU3yhgUJxIktBRPmelBRamxcArgYrOCjKVJa42LKgZGOe8XiUWnOc3GfOBA3QU+wjBD8taHlMBbTdVAyu6WQ1BYoqEOTOgO3uMmF0mp5lewvBd9HAEKNAcJq3KdldZxs7vvh1DRhSm6VUNlRY0+qoOOXA2jZg2PmSEkHboR/oQwc8xhclLKCcsfH4cS5335/pGuVNFx7fR34i2SaFD4oLAqc44TzLJ08JLfSTSL+qjoqreXMugdW3a0aBKsu+E66so/Bldk6g/YXunEfBa9hTQTfXnJMTZBV7Mcavtir4+VzpE6N/AFQNBF76hiXg2C5t0YcQAVsenMZdQwtabF2scUutcX4oUirUU8POtrrYRnSQ8pQlIZo6AC98oTBXAf2lda4AAqTlUJ6yjCKmGQWGnHmPvMz5PIdPtQ0AqZcfirykt9mccDXYeWu5BeAruWEEjZnmX7ghY0t57pyaf5mnO6+6pdwXU+b0Adf85gKtpa/evvr+hccB6+LS6rnB4i1DuA/N/B/jhc0R7kc1VcU4YRDgayKqClDKzUoopvg2B96PKAdQyjfHIqVPgTFc8UDD44LrmSIowl2EcaHugZOs3Ob8MCZpuibJIyCiK9IWHB/fL1T4FjApkGvqhiW0HS5AXFPMSVk+7Hl+3O1DlRUoTptsNtfrnIsl22nznp3F43ZAx5tJPSAXdlTc0C05puInttt/JoLye8Ifw33pIEI5VQ7lVAcRyqlblrFyT0MPnRRvDAbcONnWJOGV0SBRpbdlYRNEg4tep61WBc8PrGTb02qFL/zzq281poDK+KJGDVbQlGV0mR95Qm9rJ8KiuJsDH8p1vhhf4n1wRPMQNzpiepQnMdVikMR7pWQi3gnK5eoprhN5CAf1dl4NneGcNfgG9TXauXhvcOs7Ex3vR13NODdqcLwX+KnTYMBNnUVNEj57NEjU1GnLwqbOBvf/njoVP4aaOpE9ANfsrJxwnnPMkukCRTU8K+2DBbhyg8X1ufOQVYaaNzdWbe0aiUqUTfKsPB4oR+heoAHCarcKyKOISaFA3WwOeLmKvFON0nYf0PmFVUxcicGpOPZgCcmLQVSuAYu7QQVnAOGL+dsoyzf0XVn1xu8uA+63EWhmWknw6gxeXcCryLlpbaTWe+NjlwtrR2o/MFBW/4lTlxQobdLe0Ua6oDChPFlrX8rg2sD6hgao/XuprtRR2pICuRrRx0Qz+WGGRIONHRGBBzwdPkQd9gQulDtcQCyavzjifxPz5oSBP8FxYbFJfbJUcvGJmvMV4BCpPT/SjHKWyP8J/x7JQzGET/UBa5WySdIjDc/07OMa2MubPBvKyZZqCB/HeSZ4nqagBI4uaFw+hbOU4NSOHoZ4196fhFVg+4gF1pg+Llxr/pxtKE9PLNstWfZY3cyEOuehGMKncZqXjjOpEJ80iiF8WgoSW08axRA+VRmCcT5pFNE+VcfOY5IlNI1wy8EyjGfzYxrtl8oxjFexPcsmifWrijnGPQTUnRY7TO1gK2SI8YUbUkPMsdV5HnbKcFAMm7DtPSzTQeapMPCEbohU8ecvB16Rgb/h9zAMUBsdHiHXhvgnAHwrlMCKclFE1ZTfJ/zKK7autOpHV1cHy3B9C19pHTTYeuv6cMNbTToIGYGG+GQEG4F0lroyq5UatKd4GAaojQ6PQqpGoximd2BHVQ/LcPUVPqp6aLD19o8jPcrFiuBE0B34kxYDNoj2kv0JXuI5oMjPFFwvQvi1Ox+EgGrOKeUIXQOGPB386XoxWU0+fgKOiIs9qu+fs5Aon7JS3AkKya0yIRGvCtBSPm8xzznsoRjFHnkpl/NHykOv5FQQdkVRVvucKTsw+NfjOgrZk5un+qTzK3BH1lDI5Gt2oLeQfKmzYUQvYk8sAynVlpFS95TvaBPX4LoGDO9ENQ2DdGvLyEx++QrWA+E7GvoSgRsdkcovud6TMvTaxIWN9GLJsl3w3b4bHekJMg+uCx/pzf0xFQzrigrG+XF+BzZQXwOhdSdfaQa+/Gnskd8Wdb8e7JfteUT4f1fL2LWw/NBiQf91ZFrmXXfcVczxQbDKfQ54iLKxR35RXmdaB6lZ6TuhaqgyKjjkUndPeP2OQdCzmxYOtfT1qPdcw5tAbHe2iBDPnvo4kKl58jP+6ko/pEfoqCGU7e8BQjzoyP4P8SR0KGqgiLRI/Sm7Hs0GgNObPAlOEsg9fG2JD6NKFwW+1WcgBpHWnzoB1G0Lw45y+QZQPe/NCS9BM5eFcRZey4DP8o55uVPEwrhFvmgpVCzbqN81N5ls1f828O5cNFZOc/vZxDYZ7MykWpnJXmpWmawcCJ9h6KGsfO7+3YEznWLkoUorgwdaCtfEdmZqbcxJzCK6oevjro+pMuqlui6K7sJdTHqLdl0U9Y9qANhqSw/pNN9N6Veamn33TNT8tW8oTGc/rqaTT5Pp6uP1/cT5Hn5NqBt6Ks3Vw5TYcfGvaxNhLZ47S2h1KEf56nqob44zwa0no/QKUwwB3DdEkE4++cc+Dhm7QBWmG/ZX2nVRVLNQTyOolj5S7ZCrMvfw2sY+at+PHZz5lDAMCZrV0qI5D+yvWXNRYiAj1kQNk31e61fGnddWm+TJgQnh329a2g4grtCrj/mGVmznQyyYvIlCat/M7sOldRA2Q5kIlqBrvxOOXKQqRIB+p5rHdzvAAFbNoz+sjNf+xqCoHQl5PUnmiHbufPp8uKDjW3tBt5TTLGHZriP6BPgFIY53GR+pPe4OF8Q7WQMHls/BkEH3xfTtnhTu1YfpyD0pnCsR4BFqdTsPVjTsI7ai2Wmh7Qc6BGu7mD3vztoD2ip85970gSS0BzY7FOyXNcMEXkIUzMydAAl5iS2PjHplGkO81DhP836dyipShIqOnAW3mjRH3wTc0DLhrBCAomnW+CJWS3G2ZYBGa02HkDM3H72izj1ISOeUu7dgfScqOknj/NMy8lS11wELEdGdj6XID1WJfBtntUebCLz4LBvLBVrXeyuWtGGPF+Z0QxLvbbulrUFirvV6d9jWnV7HThukKW/kzYb1Kbb2SD2WyR9e6R9EjWHk4IUN1kiRGV8K7vipQLdYYx0pKn/1b8lS7dLbJ9vaDyYcVm4bh3dkSTkjKfuTcjsPx94NK8aRZR/vSbY7HyzAFy4dwAhXYJE4NvzC0hwcS/VBkhycp6v+Q4+uU1Zo/JUNdU+KQuvS3virINAx/9Z9wepqTqv/QlN429uSoEnNxkXULGygxPyyW9C4iBEarj6xd5qh/QadIRExCrGaTU7LL4ymvh8isrQdwDgPFlQceYZxQUXG+uD6UN8jHPdVfptD0ZV74r5niEtE0jI3sOrR6VD1m4id6R+OneYFgM1Ld+fSWUrxWXRzBthBSSO8xIImOYeURZrhZSZPSXq0fw7RPqU820XsPw+sf+BJo5hWyXJ5Lx80jRgg30VoMDeQV8mPgfEqgD7e9kp6KXgOXYu5kHAld2JQjwgsMyhYBCYgs4K+/BdVy7hz6IUAAA==" \ No newline at end of file diff --git a/classes/index._internal_.ErrorWithCause.html b/classes/index._internal_.ErrorWithCause.html deleted file mode 100644 index 4a8691f..0000000 --- a/classes/index._internal_.ErrorWithCause.html +++ /dev/null @@ -1,12 +0,0 @@ -ErrorWithCause | @foxxmd/logging Docs

Class ErrorWithCause<T>

Type Parameters

  • T = undefined

Hierarchy

  • Error
    • ErrorWithCause

Constructors

constructor -

Properties

prepareStackTrace? -stackTraceLimit -cause -name -message -stack? -

Methods

captureStackTrace -

Constructors

constructor

  • new ErrorWithCause<T>(message, __namedParameters?): ErrorWithCause<T>

  • Type Parameters

    • T = undefined

    Parameters

    • message: string
    • Optional __namedParameters: {
          cause?: T;
      }
      • Optional cause?: T

    Returns ErrorWithCause<T>

Properties

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

-

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

-

Static stackTraceLimit

stackTraceLimit: number

cause

cause: T

name

name: string

message

message: string

Optional stack

stack?: string

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorprepareStackTracestackTraceLimitcausenamemessagestackcaptureStackTrace

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.buildDestinationFile.html b/functions/factory.buildDestinationFile.html index 96359c9..be7b3c8 100644 --- a/functions/factory.buildDestinationFile.html +++ b/functions/factory.buildDestinationFile.html @@ -1,2 +1,2 @@ buildDestinationFile | @foxxmd/logging Docs

Function buildDestinationFile

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns LogLevelStreamEntry

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function buildDestinationRollingFile

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<LogLevelStreamEntry>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.buildDestinationStderr.html b/functions/factory.buildDestinationStderr.html index b918390..f097f11 100644 --- a/functions/factory.buildDestinationStderr.html +++ b/functions/factory.buildDestinationStderr.html @@ -2,4 +2,4 @@

Parameters

Returns LogLevelStreamEntry

Source

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

See

buildDestinationStream

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.buildDestinationStdout.html b/functions/factory.buildDestinationStdout.html index 49291bc..cdc4dd1 100644 --- a/functions/factory.buildDestinationStdout.html +++ b/functions/factory.buildDestinationStdout.html @@ -2,4 +2,4 @@

Parameters

Returns LogLevelStreamEntry

Source

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

See

buildDestinationStream

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function buildDestinationStream

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function buildLogger

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

  • Builds a Logger object for use in your application

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

    Parameters

    Returns Logger

    See

    Logger

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function prettyOptsConsoleFactory

  • prettyOptsConsoleFactory(opts?): PrettyOptions_

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

    Parameters

    Returns PrettyOptions_

    Source

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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function prettyOptsFactory

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns PrettyOptions_

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function prettyOptsFileFactory

  • prettyOptsFileFactory(opts?): PrettyOptions_

  • Generate pino-pretty PrettyOptions for use with file output

    Parameters

    Returns PrettyOptions_

    Source

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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/index.childLogger.html b/functions/index.childLogger.html index b983600..427e2a8 100644 --- a/functions/index.childLogger.html +++ b/functions/index.childLogger.html @@ -3,4 +3,4 @@
  • labelsVal: any = []

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

  • context: object = {}

    object Additional properties to always apply to logs from this logger

  • options: {} = {}

    object

    -

    • Returns Logger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Logger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/index.isLogOptions.html b/functions/index.isLogOptions.html index 09af509..3ea8ea0 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 854d2e8..083317e 100644 --- a/functions/index.loggerApp.html +++ b/functions/index.loggerApp.html @@ -1,2 +1,2 @@ loggerApp | @foxxmd/logging Docs

    Function loggerApp

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Logger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function loggerAppRolling

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<Logger>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function parseLogOptions

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns LogOptionsParsed

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.FileLogOptions.html b/interfaces/index.FileLogOptions.html index 4d349ef..4ac4e35 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 98cfc79..50b75e4 100644 --- a/interfaces/index.LogOptions.html +++ b/interfaces/index.LogOptions.html @@ -1,10 +1,10 @@ -LogOptions | @foxxmd/logging Docs

    Interface LogOptions

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

    Properties

    level? +LogOptions | @foxxmd/logging Docs

    Interface LogOptions

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

    Properties

    level? file? console?

    Properties

    Optional level

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

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

    Defaults to env LOG_LEVEL or info if not specified.

    Default

    'info'
    -

    Optional file

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

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

    -

    Optional console

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

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    levelfileconsole

    Generated using TypeDoc

    \ No newline at end of file +

    Optional file

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

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

    +

    Optional console

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

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

    +

    Settings

    Member Visibility

    Theme

    On This Page

    levelfileconsole

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.LoggerAppExtras.html b/interfaces/index.LoggerAppExtras.html index 2ef7b38..1f2417c 100644 --- a/interfaces/index.LoggerAppExtras.html +++ b/interfaces/index.LoggerAppExtras.html @@ -1,7 +1,7 @@ -LoggerAppExtras | @foxxmd/logging Docs

    Interface LoggerAppExtras

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

    Properties

    pretty? +LoggerAppExtras | @foxxmd/logging Docs

    Interface LoggerAppExtras

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

    Properties

    pretty? destinations? pino?

    Properties

    Optional pretty

    pretty?: PrettyOptionsExtra

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

    -

    Optional destinations

    destinations?: LogLevelStreamEntry[]

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

    -

    Optional pino

    pino?: PinoLoggerOptions

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    prettydestinationspino

    Generated using TypeDoc

    \ No newline at end of file +

    Optional destinations

    destinations?: LogLevelStreamEntry[]

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

    +

    Optional pino

    pino?: PinoLoggerOptions

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

    +

    Settings

    Member Visibility

    Theme

    On This Page

    prettydestinationspino

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.PrettyOptionsExtra.html b/interfaces/index.PrettyOptionsExtra.html index 7f638b0..9bca56a 100644 --- a/interfaces/index.PrettyOptionsExtra.html +++ b/interfaces/index.PrettyOptionsExtra.html @@ -1,5 +1,5 @@ PrettyOptionsExtra | @foxxmd/logging Docs

    Interface PrettyOptionsExtra

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

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

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

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

    Default

    true
    -

    Optional padLevels

    padLevels?: boolean

    Pads levels in log string so all are the same length

    +

    Optional padLevels

    padLevels?: boolean

    Pads levels in log string so all are the same length

    Default

    true
    -

    Settings

    Member Visibility

    Theme

    On This Page

    hideObjecttranslateTimelevelFirstlevelKeylevelLabelmessageKeysingleLinetimestampKeyminimumLevelmessageFormatcolorizecolorizeObjectscrlferrorLikeObjectKeyserrorPropsignoreincludesyncdestinationappendmkdircustomPrettifierscustomColorsredactCwdpadLevels

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    hideObjecttranslateTimelevelFirstlevelKeylevelLabelmessageKeysingleLinetimestampKeyminimumLevelmessageFormatcolorizecolorizeObjectscrlferrorLikeObjectKeyserrorPropsignoreincludesyncdestinationappendmkdircustomPrettifierscustomColorsredactCwdpadLevels

    Generated using TypeDoc

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

    Interface CallSite

    interface CallSite {
        getThis(): unknown;
        getTypeName(): string;
        getFunction(): Function;
        getFunctionName(): string;
        getMethodName(): string;
        getFileName(): string;
        getLineNumber(): number;
        getColumnNumber(): number;
        getEvalOrigin(): string;
        isToplevel(): boolean;
        isEval(): boolean;
        isNative(): boolean;
        isConstructor(): boolean;
    }

    Methods

    getThis -getTypeName -getFunction -getFunctionName -getMethodName -getFileName -getLineNumber -getColumnNumber -getEvalOrigin -isToplevel -isEval -isNative -isConstructor -

    Methods

    getThis

    • getThis(): unknown

    • Value of "this"

      -

      Returns unknown

    getTypeName

    • getTypeName(): string

    • Type of "this" as a string. -This is the name of the function stored in the constructor field of -"this", if available. Otherwise the object's [[Class]] internal -property.

      -

      Returns string

    getFunction

    • getFunction(): Function

    • Current function

      -

      Returns Function

    getFunctionName

    • getFunctionName(): string

    • Name of the current function, typically its name property. -If a name property is not available an attempt will be made to try -to infer a name from the function's context.

      -

      Returns string

    getMethodName

    • getMethodName(): string

    • Name of the property [of "this" or one of its prototypes] that holds -the current function

      -

      Returns string

    getFileName

    • getFileName(): string

    • Name of the script [if this function was defined in a script]

      -

      Returns string

    getLineNumber

    • getLineNumber(): number

    • Current line number [if this function was defined in a script]

      -

      Returns number

    getColumnNumber

    • getColumnNumber(): number

    • Current column number [if this function was defined in a script]

      -

      Returns number

    getEvalOrigin

    • getEvalOrigin(): string

    • A call site object representing the location where eval was called -[if this function was created using a call to eval]

      -

      Returns string

    isToplevel

    • isToplevel(): boolean

    • Is this a toplevel invocation, that is, is "this" the global object?

      -

      Returns boolean

    isEval

    • isEval(): boolean

    • Does this call take place in code defined by a call to eval?

      -

      Returns boolean

    isNative

    • isNative(): boolean

    • Is this call in native V8 code?

      -

      Returns boolean

    isConstructor

    • isConstructor(): boolean

    • Is this a constructor call?

      -

      Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    getThisgetTypeNamegetFunctiongetFunctionNamegetMethodNamegetFileNamegetLineNumbergetColumnNumbergetEvalOriginisToplevelisEvalisNativeisConstructor

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index._internal_.FileLogOptionsStrong.html b/interfaces/index._internal_.FileLogOptionsStrong.html index 84151eb..f176a9d 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 a039f45..732d18c 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 a15b07a..43be9f3 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 42260f8..9f89c32 100644 --- a/interfaces/index._internal_.RollOptions.html +++ b/interfaces/index._internal_.RollOptions.html @@ -1,4 +1,4 @@ -RollOptions | @foxxmd/logging Docs

    Interface RollOptions

    interface RollOptions {
        timestamp?: "unix" | "iso" | "auto";
    }

    Hierarchy (view full)

    Properties

    timestamp? +RollOptions | @foxxmd/logging Docs

    Interface RollOptions

    interface RollOptions {
        timestamp?: "unix" | "iso" | "auto";
    }

    Hierarchy (view full)

    Properties

    timestamp?

    Properties

    Optional timestamp

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

    For rolling log files

    When

      @@ -17,4 +17,4 @@

    Default

    'auto'
    -

    Settings

    Member Visibility

    Theme

    On This Page

    timestamp

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    timestamp

    Generated using TypeDoc

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

    Module factory

    Index

    Modules

    <internal> +factory | @foxxmd/logging Docs

    Module factory

    Index

    Modules

    <internal>

    Type Aliases

    FileDestination StreamDestination

    Variables

    PRETTY_OPTS_CONSOLE diff --git a/modules/index._internal_.html b/modules/index._internal_.html index 6efe22b..851166a 100644 --- a/modules/index._internal_.html +++ b/modules/index._internal_.html @@ -1,13 +1,11 @@ <internal> | @foxxmd/logging Docs

    Module <internal>

    Index

    Namespaces

    EventEmitter

    Classes

    AsyncResource EventEmitter -ErrorWithCause

    Interfaces

    AsyncResourceOptions EventEmitterOptions _NodeEventTarget _DOMEventTarget StaticEventEmitterOptions -CallSite Colorette redactOptions LoggerExtras diff --git a/modules/index.html b/modules/index.html index 65db7d4..69c2fa4 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,4 +1,4 @@ -index | @foxxmd/logging Docs

    Module index

    Index

    Modules

    <internal> +index | @foxxmd/logging Docs

    Module index

    Index

    Modules

    <internal>

    Interfaces

    LogOptions FileLogOptions LoggerAppExtras diff --git a/types/factory.FileDestination.html b/types/factory.FileDestination.html index cab0079..9818600 100644 --- a/types/factory.FileDestination.html +++ b/types/factory.FileDestination.html @@ -1 +1 @@ -FileDestination | @foxxmd/logging Docs

    Type alias FileDestination

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias FileDestination

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias StreamDestination

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias StreamDestination

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/factory._internal_.FileOptionsParsed.html b/types/factory._internal_.FileOptionsParsed.html index f536fb2..c5a055d 100644 --- a/types/factory._internal_.FileOptionsParsed.html +++ b/types/factory._internal_.FileOptionsParsed.html @@ -1 +1 @@ -FileOptionsParsed | @foxxmd/logging Docs

    Type alias FileOptionsParsed

    FileOptionsParsed: MarkRequired<FileOptions, "path">

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias FileOptionsParsed

    FileOptionsParsed: MarkRequired<FileOptions, "path">

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/factory._internal_.PinoLoggerOptions.html b/types/factory._internal_.PinoLoggerOptions.html index dbea5f9..e2b4b8c 100644 --- a/types/factory._internal_.PinoLoggerOptions.html +++ b/types/factory._internal_.PinoLoggerOptions.html @@ -1,2 +1,2 @@ PinoLoggerOptions | @foxxmd/logging Docs

    Type alias PinoLoggerOptions

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

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/index.LogData.html b/types/index.LogData.html index d20b1c4..d1b5cfa 100644 --- a/types/index.LogData.html +++ b/types/index.LogData.html @@ -1,2 +1,2 @@ -LogData | @foxxmd/logging Docs

    Type alias LogData

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

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

    -

    Type declaration

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias LogData

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

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

    +

    Type declaration

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

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

    Type alias LogLevel

    LogLevel: typeof LOG_LEVEL_NAMES[number]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias LogLevel

    LogLevel: typeof LOG_LEVEL_NAMES[number]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/index.LogLevelStreamEntry.html b/types/index.LogLevelStreamEntry.html index 6c63632..20beaf2 100644 --- a/types/index.LogLevelStreamEntry.html +++ b/types/index.LogLevelStreamEntry.html @@ -1,3 +1,3 @@ LogLevelStreamEntry | @foxxmd/logging Docs

    Type alias LogLevelStreamEntry

    LogLevelStreamEntry: StreamEntry<LogLevel>

    An object with a write function that can be used by pino as a Transport

    All buildDestination* functions return this type as well as any Pino Transport

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/index.Logger.html b/types/index.Logger.html index 6fdba12..1e8a0b0 100644 --- a/types/index.Logger.html +++ b/types/index.Logger.html @@ -1 +1 @@ -Logger | @foxxmd/logging Docs

    Type alias Logger

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

    Type declaration

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

        • Parameters

          • value: any

          Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias Logger

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

    Type declaration

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

        • Parameters

          • value: any

          Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/index._internal_.FileLogOptionsParsed.html b/types/index._internal_.FileLogOptionsParsed.html index a3bdbcc..16aba7f 100644 --- a/types/index._internal_.FileLogOptionsParsed.html +++ b/types/index._internal_.FileLogOptionsParsed.html @@ -1 +1 @@ -FileLogOptionsParsed | @foxxmd/logging Docs

    Type alias FileLogOptionsParsed

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias FileLogOptionsParsed

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/index._internal_.LogOptionsParsed.html b/types/index._internal_.LogOptionsParsed.html index 7b226ff..91f46c8 100644 --- a/types/index._internal_.LogOptionsParsed.html +++ b/types/index._internal_.LogOptionsParsed.html @@ -1 +1 @@ -LogOptionsParsed | @foxxmd/logging Docs

    Type alias LogOptionsParsed

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias LogOptionsParsed

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/factory.PRETTY_COLORS.html b/variables/factory.PRETTY_COLORS.html index 95d4315..edc2600 100644 --- a/variables/factory.PRETTY_COLORS.html +++ b/variables/factory.PRETTY_COLORS.html @@ -1,3 +1,3 @@ PRETTY_COLORS | @foxxmd/logging Docs

    Variable PRETTY_COLORSConst

    PRETTY_COLORS: Extract<PrettyOptions_["customColors"], object> = ...

    Additional level colors included in @foxxmd/logging as a string

    These are always applied when using prettyOptsFactory but can be overridden

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/factory.PRETTY_COLORS_STR.html b/variables/factory.PRETTY_COLORS_STR.html index b48f011..42adbc4 100644 --- a/variables/factory.PRETTY_COLORS_STR.html +++ b/variables/factory.PRETTY_COLORS_STR.html @@ -1,3 +1,3 @@ PRETTY_COLORS_STR | @foxxmd/logging Docs

    Variable PRETTY_COLORS_STRConst

    PRETTY_COLORS_STR: Extract<PrettyOptions_["customColors"], string> = 'verbose:magenta,log:greenBright'

    Additional level colors included in @foxxmd/logging as an object

    These are always applied when using prettyOptsFactory but can be overridden

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable PRETTY_ISO8601Const

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

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/factory.PRETTY_OPTS_CONSOLE.html b/variables/factory.PRETTY_OPTS_CONSOLE.html index 957317c..05e0037 100644 --- a/variables/factory.PRETTY_OPTS_CONSOLE.html +++ b/variables/factory.PRETTY_OPTS_CONSOLE.html @@ -1,4 +1,4 @@ PRETTY_OPTS_CONSOLE | @foxxmd/logging Docs

    Variable PRETTY_OPTS_CONSOLEConst

    PRETTY_OPTS_CONSOLE: PrettyOptions_ = ...

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

    Source

    const PRETTY_OPTS_CONSOLE: PrettyOptions = prettyOptsConsoleFactory()
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable PRETTY_OPTS_FILEConst

    PRETTY_OPTS_FILE: PrettyOptions_ = ...

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

    Source

    const PRETTY_OPTS_FILE: PrettyOptions = prettyOptsFileFactory()
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable LOG_LEVEL_NAMESConst

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable LOG_LEVEL_NAMESConst

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/index.loggerDebug.html b/variables/index.loggerDebug.html index 8024ff8..a02b4ed 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 6c7f87b..64a6e6f 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