diff --git a/assets/highlight.css b/assets/highlight.css index 34f4edd..ef0fe74 100644 --- a/assets/highlight.css +++ b/assets/highlight.css @@ -19,14 +19,14 @@ --dark-hl-8: #4EC9B0; --light-hl-9: #098658; --dark-hl-9: #B5CEA8; - --light-hl-10: #EE0000; - --dark-hl-10: #D7BA7D; + --light-hl-10: #000000; + --dark-hl-10: #C8C8C8; --light-hl-11: #000000FF; --dark-hl-11: #D4D4D4; - --light-hl-12: #811F3F; - --dark-hl-12: #D16969; - --light-hl-13: #000000; - --dark-hl-13: #C8C8C8; + --light-hl-12: #EE0000; + --dark-hl-12: #D7BA7D; + --light-hl-13: #811F3F; + --dark-hl-13: #D16969; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } diff --git a/assets/navigation.js b/assets/navigation.js index 174f107..0fa65cd 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/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 +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8Vda5PbthX9L8pXO/E6tht7Op1Za7XJ1lpLlTZ2M4lHA1FYLbIUyYKQs0qn/70Dig+8CF5ccNpP8WTvOefidfG6hH7990TQJzF5N7knicj5afJsUhDxMHk3OeS7Y0rL7+o/fPsgDunk2eSRZbvJu5fPJskDS3ecZpN3v7Yk2yNLd1e0FCwjguXZKk9Tlu2vWUo74vtjlsg/dtQemC775tV/nvWKhaoE0q8Fp+QQInBGBEns8qMIk5CIMAnKeaAE5XxIYp7v93SY92zmISs4FeK0KER5bXZIm9IyBhFP86zMUxrEr2M8MsvV7O7ul81iebfeTBcf14v5rFP4SjgjW3VQOcx18u9fuiuHBRZAAQC9v76Buy5tPX5LcaVHdaziVCiMhpkRcV68/cvFa5X1PLwAvJbhEHNdtOlivlitN+u7FaAeOmNPRWi2YNJhwpv14oc3Ly4AjLWlh/KvLBOUZyT9W/9csGlsNqBpYdl0Q9k5Nx1txXJPEjezjjKEXr95NklSUpaytcvdc1Y+p09n5EQpzPs039YMUFkFgtfsxCpAv5IucfHyB5jE8f6e8lmW5DuW7fv6vSqlAZz9HyT8mYmHm0ORsoSJaU554hl2irwLhnfiXBgZkgU/Si1w05pAZANXNL7BZmma4w2lAync8wtcmT7Q02L7O03E3amggBbV7PFN+YGeZk9FzkXgIDVxuEL//Y9HrAMOKNKHMs8+0+0HegJLtwic4mV5Ohyo4Cz5QE9XVBCWgovtwkZ2OFCobK2R8ZJlhJ/m7BHStTvjqH4NH0jRQ+g65wciYGJnW7zcP1+/eDt9oMlj4IAxcbheU7FQLtg9S4igoL5jYHA9KLhBrUAc1qQ/l2QPVKtMo8Qu033OmXg4BITfFoNryCk/FSIPiHotAKd3xw4UOP4bU3yVnkNVs9oKHChOMK7Qi4Jmt/kOUujGFF9ooFCcyFoQUb4nJYXWZgvA1WAFB0WZyhIXW1aU7MzTJY9SZ46T+8yZoAF6in2E4KcVLY+pgLabisE1naymQFEFgtwZsP1NJoxOM7Bs7yD4LhoYYhQITvM6JfvLbGfHF7+uAUNqs5TKhgprWh0VpxxY2wYMO19SImg39AN96IHH+KKEBZQzNh4/zuXu+zPdorzpw+P7yE8k26XwQdEicIozzrN89pTQQj8D9avqqLiaN+cSWH27ZhSosuw74co6Cl9m5wQ6XOjeeRS8hj0VdHfJOTlBVrGtMX61VcHP50qfGP0DoGog8NJXLAHHdmmLPoQI2PLgNG4aWtBiq7XGLbWm+aFIqVBPDXvbqrWN6CDlKUtCNHUAXrilMFcBw6V1rgACpOVQnrOMIqYZBYaceY+8zPkyh0+1DQCplx+KvKTX2ZJwNdh5a7kD4Cu5YQSNmeZfuCFjS3luu5p/mac7r/ql3Fdi5vQB1/ymhdbSF29fff/C44B1ZWr13GDxjiHch2b+j/HC5gj3o5qqYpwwCPA1EVUFKOVmJRRTfJsD70eUAyjlq2OR0qfAGK54oOFxwfVMERThWmFcqLvjJCvvc36YkjTdkuQRENEVaQuOj+8tFb4FTArkmrphCW2HFohriiUpy7sHnh/3D6HKChSnTXa7y23OxZrttXnPzh9yO6DjzXQikAt7Kq7oPTmm4ie2f/hMBOW3hD+G+9JDhHKqHMupHiKUU9csY+UDDT10UrwxGHDj5L4mCa+MBokqvS0LmyAaXPQ6bbMpeH5gJbs/bTb4wj+/+FZjCqiML2rUYAVNWUbX+ZEn9Lp2IiyKuznwoVzni/El3gdHNA9xoyemR3kSUy0GSbxXSg7kjaBcrp7iOpGHcFRvl9XQGc9Zg29UX6Odi/cGt74z0fF+1NWMc6MGx3uBnzoNBtzUWdQk4bNHg0RNnbYsbOpscP/vqVPxY6ypE9kDcM3OyhnnOccsmVooquFZaR8swJUbLK7PnYesMtS8ubFqa9dIVKJskmfl8UA5QreFBgir3SogjyImhQJ1szni5SryTjVK231A5xdWMXElBqfi2IMlJC8GUbkGLO4GFZwBhC/mb5Ms39F3ZdUbv2sH3G8T0My0keDNGbxpwZvIuWlrpNZ742OfC1tHaj8wUFb/iVOXFCht0t3RRrqgMKE82WpfyuDawPqGBqj9e6mu1FHakgK5GtHHRDP5YYZEg40dEYEHPD0+RB32BC6Ue1xALJq/OOJ/E/OWhIE/wXFhsUl9slRy8Yma8xXgGKk9P9KMcpbI/wn/HslDMYZP9QFrlbJJ0iMNz/Qc4hrZy6s8G8vJjmoMH6d5JniepqAEjj5oXD6Fs5Tg1I4BhnjX3p+EVWD7iAXWmD4uXGv+nO0oT08s269Z9ljdzIQ656EYw6dpmpeOM6kQnzSKMXxaCxJbTxrFGD5VGYJxPmkU0T5Vx85TkiU0jXDLwTKOZ8tjGu2XyjGOV7E9yyaJ9auKOcY9BNSdDjtO7WArZIzxhRtSY8yx1XkedspwUIybsO09LNNB5qkw8IRujFTx5y9HXpGBv+H3MIxQGz0eIdeG+CcAfCuUwIpyUUTVlN8n/Mortq606kdXVw/LeH0LX2k9NNh66/tww1tNOggZgcb4ZAQbgXSWujKrlRq0p3gYRqiNHo9CqkajGKd3YEfVAMt49RU+qgZosPX2jyM9ysWK4ETQPfiTFgM2ivaa/Qle4jmgyM8UXC9C+LV7H4SAai4p5QhdA4Y8HfzpcjXbzD5+Ao6I1h7V989ZSJTPWSluBIXkVpmQiFcFaCmft1jmHPZQjGKPvJTL+SPloVdyKgi7oiirfc6cHRj863EdhUyBZgd6DclaOhtGtCV7YhlIqbaMlLqlfE+b6ALXNWB4J6rJEKRbW0bm08u3qO4I39PQ9wDc6IiEesn1npShlxcubKQXa5btg2/Y3ehIT5DZaH34SG9uj6lgWFdUMM6P8zuwgfoaCK07+0oz8BVMY4/8wqf/9WC/7MAjwv+7WsauSOXnDiv6ryPT8t/6465ijg+CVQZywHOQjT3yu+463zlIzUqiCVVDlVHBIRecD4TXrwkEPX5p4VALUI/6wGW4CcR2Z4sI8fiojwOZICc/pq8u1kN6hI4aQ9nOyg/xoCcHP8ST0KGogSKSE/UH5QCZiY5n5aCvvDwJThLIbXhtGfGoQ9dFgS/mGYhRpPUHRwB128Gwo1y+xFPPe0vCS9DMZWGchdfy0LO8Z17uFbEwbpEvWiITy3bq18VNPln1vw28OyOMlfPcfrywS8k6M6lWZsqVmtslKwfCZxh6KCuf+3934EynGHmo0srgjpbCNbGdmTobcxKziK7o9rgfYqqMBqkui6K/cK3JYNEui6L+UQ0AW23pIZ3n+zn9SlOz756Jmr8ODYX54sfNfPZpNt98vLydOd/Drwl1Q0+luXqYEjta//o2EdbiubeEVodylK+uh/r+NhPcerhJrzDFEMB9RQTp5ZN/HOKQsQtUYbrhcKVdFkU1Cw00gmrpI9V+CKAy9/Daxj5q348dnPmUMAwJmrLqaZlwVmhLMrV19L1WZx3xoZssM7tnfd1VnUpa0zHkzFYeFHU2doB0NUyC9Z2o6DPp80vacvk66ICFiFgiybVrc+w7PHTNVa+BjFh0N0z2sbxfGXcsX53CzA5MCP+BhqXtAOIKvfmY72jFdj4lhcmbKKT21eI2XFoHYRPRiWAJuvZ74chdkEIE6HeqeXy3A8wQqnn097Px2t8YFLUjIY9kyVTg3q31kA8tOr61V/SecpolLNv3RJ8AvyDE8S7jI7XH3fGCeC9r4MDyORgy6L6Yvt2SYnBibQzx82mdhAFWNOwjJvLstNI2nD2CtV3Mocp+eIkkjfAS2juqPQr2A6phAi8hCmaCVsjSkpVCnkkOryZrQ7zUNE8Bm4PKKlKEip7UFLeaNEem4BxLkR+qhbZv46wKmgh8URfZVM6ffa+eWNKGPV6Y0x1JvLftlrYGibnWG9xhW3d6PTttkKa8kTcb1qfY2SP1WCZ//mQ4cDWGkXtK2B4yUmTB14I7frDPLdZYR4rK395bs1S79PbJdvajCYeV28bhHVlTzkjK/qTczsOxNyuKcWTZpw8k25/3ffB5pQcY4QosEseGX1iag2MlNUqSg/N01b8n7TtlhcZf2VC3pCi0Lu2NvwoCHfOv3Resrua0+i90Fu9uS4ImNRsXUbOwgRLz+2pB4yJGaLz6xN5phvYbdIZExCjEajY5Lb8wmvp+DsjSdgDjPFhRceQZxgUVGeuD63N5j3Dct/FdDkVf7on7GDguEUnL3MCqR6dD1S8T9qZ/OC5AWgA2O9ydS2cpxWfRLRlgByWN8BIrmuQcUhZphpeZPSXp0f5RQvsQ6WwXsf88sOGBJ41iWiXL5b180DRigHwXocHcQF4lPwbGqwCGeLsr6bXgOXQt5kLCldyJQQMisMygYBGYgMwK+vJfYWQJzOiFAAA=" \ No newline at end of file diff --git a/classes/factory._internal_.Interface.html b/classes/factory._internal_.Interface.html index c529a69..ffc8c4d 100644 --- a/classes/factory._internal_.Interface.html +++ b/classes/factory._internal_.Interface.html @@ -72,7 +72,7 @@ be an empty string.

unintended consequences if rl.cursor is not also controlled.

If not using a TTY stream for input, use the 'line' event.

One possible use case would be as follows:

-
const values = ['lorem ipsum', 'dolor sit amet'];
const rl = readline.createInterface(process.stdin);
const showResults = debounce(() => {
console.log(
'\n',
values.filter((val) => val.startsWith(rl.line)).join(' ')
);
}, 300);
process.stdin.on('keypress', (c, k) => {
showResults();
}); +
const values = ['lorem ipsum', 'dolor sit amet'];
const rl = readline.createInterface(process.stdin);
const showResults = debounce(() => {
console.log(
'\n',
values.filter((val) => val.startsWith(rl.line)).join(' ')
);
}, 300);
process.stdin.on('keypress', (c, k) => {
showResults();
});

Since

v0.1.98

cursor: number

The cursor position relative to rl.line.

diff --git a/classes/factory._internal_.ReadStream.html b/classes/factory._internal_.ReadStream.html index 33ef2d3..c082e17 100644 --- a/classes/factory._internal_.ReadStream.html +++ b/classes/factory._internal_.ReadStream.html @@ -377,7 +377,7 @@ pulled out of the source, so that the data can be passed on to some other party. has been emitted or a runtime error will be thrown.

Developers using stream.unshift() often should consider switching to use of a Transform stream instead. See the API for stream implementers section for more information.

-
// Pull off a header delimited by \n\n.
// Use unshift() if we get too much.
// Call the callback with (error, header, stream).
const { StringDecoder } = require('string_decoder');
function parseHeader(stream, callback) {
stream.on('error', callback);
stream.on('readable', onReadable);
const decoder = new StringDecoder('utf8');
let header = '';
function onReadable() {
let chunk;
while (null !== (chunk = stream.read())) {
const str = decoder.write(chunk);
if (str.includes('\n\n')) {
// Found the header boundary.
const split = str.split(/\n\n/);
header += split.shift();
const remaining = split.join('\n\n');
const buf = Buffer.from(remaining, 'utf8');
stream.removeListener('error', callback);
// Remove the 'readable' listener before unshifting.
stream.removeListener('readable', onReadable);
if (buf.length)
stream.unshift(buf);
// Now the body of the message can be read from the stream.
callback(null, header, stream);
return;
}
// Still reading the header.
header += str;
}
}
} +
// Pull off a header delimited by \n\n.
// Use unshift() if we get too much.
// Call the callback with (error, header, stream).
const { StringDecoder } = require('string_decoder');
function parseHeader(stream, callback) {
stream.on('error', callback);
stream.on('readable', onReadable);
const decoder = new StringDecoder('utf8');
let header = '';
function onReadable() {
let chunk;
while (null !== (chunk = stream.read())) {
const str = decoder.write(chunk);
if (str.includes('\n\n')) {
// Found the header boundary.
const split = str.split(/\n\n/);
header += split.shift();
const remaining = split.join('\n\n');
const buf = Buffer.from(remaining, 'utf8');
stream.removeListener('error', callback);
// Remove the 'readable' listener before unshifting.
stream.removeListener('readable', onReadable);
if (buf.length)
stream.unshift(buf);
// Now the body of the message can be read from the stream.
callback(null, header, stream);
return;
}
// Still reading the header.
header += str;
}
}
}

Unlike push, stream.unshift(chunk) will not end the reading process by resetting the internal reading state of the stream. diff --git a/classes/factory._internal_.Readable.html b/classes/factory._internal_.Readable.html index 7a69559..3916032 100644 --- a/classes/factory._internal_.Readable.html +++ b/classes/factory._internal_.Readable.html @@ -313,7 +313,7 @@ pulled out of the source, so that the data can be passed on to some other party. has been emitted or a runtime error will be thrown.

Developers using stream.unshift() often should consider switching to use of a Transform stream instead. See the API for stream implementers section for more information.

-
// Pull off a header delimited by \n\n.
// Use unshift() if we get too much.
// Call the callback with (error, header, stream).
const { StringDecoder } = require('string_decoder');
function parseHeader(stream, callback) {
stream.on('error', callback);
stream.on('readable', onReadable);
const decoder = new StringDecoder('utf8');
let header = '';
function onReadable() {
let chunk;
while (null !== (chunk = stream.read())) {
const str = decoder.write(chunk);
if (str.includes('\n\n')) {
// Found the header boundary.
const split = str.split(/\n\n/);
header += split.shift();
const remaining = split.join('\n\n');
const buf = Buffer.from(remaining, 'utf8');
stream.removeListener('error', callback);
// Remove the 'readable' listener before unshifting.
stream.removeListener('readable', onReadable);
if (buf.length)
stream.unshift(buf);
// Now the body of the message can be read from the stream.
callback(null, header, stream);
return;
}
// Still reading the header.
header += str;
}
}
} +
// Pull off a header delimited by \n\n.
// Use unshift() if we get too much.
// Call the callback with (error, header, stream).
const { StringDecoder } = require('string_decoder');
function parseHeader(stream, callback) {
stream.on('error', callback);
stream.on('readable', onReadable);
const decoder = new StringDecoder('utf8');
let header = '';
function onReadable() {
let chunk;
while (null !== (chunk = stream.read())) {
const str = decoder.write(chunk);
if (str.includes('\n\n')) {
// Found the header boundary.
const split = str.split(/\n\n/);
header += split.shift();
const remaining = split.join('\n\n');
const buf = Buffer.from(remaining, 'utf8');
stream.removeListener('error', callback);
// Remove the 'readable' listener before unshifting.
stream.removeListener('readable', onReadable);
if (buf.length)
stream.unshift(buf);
// Now the body of the message can be read from the stream.
callback(null, header, stream);
return;
}
// Still reading the header.
header += str;
}
}
}

Unlike push, stream.unshift(chunk) will not end the reading process by resetting the internal reading state of the stream. diff --git a/classes/factory._internal_.internal-1.Duplex.html b/classes/factory._internal_.internal-1.Duplex.html index 48e40c8..ef10d7d 100644 --- a/classes/factory._internal_.internal-1.Duplex.html +++ b/classes/factory._internal_.internal-1.Duplex.html @@ -363,7 +363,7 @@ pulled out of the source, so that the data can be passed on to some other party. has been emitted or a runtime error will be thrown.

Developers using stream.unshift() often should consider switching to use of a Transform stream instead. See the API for stream implementers section for more information.

-
// Pull off a header delimited by \n\n.
// Use unshift() if we get too much.
// Call the callback with (error, header, stream).
const { StringDecoder } = require('string_decoder');
function parseHeader(stream, callback) {
stream.on('error', callback);
stream.on('readable', onReadable);
const decoder = new StringDecoder('utf8');
let header = '';
function onReadable() {
let chunk;
while (null !== (chunk = stream.read())) {
const str = decoder.write(chunk);
if (str.includes('\n\n')) {
// Found the header boundary.
const split = str.split(/\n\n/);
header += split.shift();
const remaining = split.join('\n\n');
const buf = Buffer.from(remaining, 'utf8');
stream.removeListener('error', callback);
// Remove the 'readable' listener before unshifting.
stream.removeListener('readable', onReadable);
if (buf.length)
stream.unshift(buf);
// Now the body of the message can be read from the stream.
callback(null, header, stream);
return;
}
// Still reading the header.
header += str;
}
}
} +
// Pull off a header delimited by \n\n.
// Use unshift() if we get too much.
// Call the callback with (error, header, stream).
const { StringDecoder } = require('string_decoder');
function parseHeader(stream, callback) {
stream.on('error', callback);
stream.on('readable', onReadable);
const decoder = new StringDecoder('utf8');
let header = '';
function onReadable() {
let chunk;
while (null !== (chunk = stream.read())) {
const str = decoder.write(chunk);
if (str.includes('\n\n')) {
// Found the header boundary.
const split = str.split(/\n\n/);
header += split.shift();
const remaining = split.join('\n\n');
const buf = Buffer.from(remaining, 'utf8');
stream.removeListener('error', callback);
// Remove the 'readable' listener before unshifting.
stream.removeListener('readable', onReadable);
if (buf.length)
stream.unshift(buf);
// Now the body of the message can be read from the stream.
callback(null, header, stream);
return;
}
// Still reading the header.
header += str;
}
}
}

Unlike push, stream.unshift(chunk) will not end the reading process by resetting the internal reading state of the stream. diff --git a/classes/factory._internal_.internal-1.PassThrough.html b/classes/factory._internal_.internal-1.PassThrough.html index d1863a1..e8b87f5 100644 --- a/classes/factory._internal_.internal-1.PassThrough.html +++ b/classes/factory._internal_.internal-1.PassThrough.html @@ -359,7 +359,7 @@ pulled out of the source, so that the data can be passed on to some other party. has been emitted or a runtime error will be thrown.

Developers using stream.unshift() often should consider switching to use of a Transform stream instead. See the API for stream implementers section for more information.

-
// Pull off a header delimited by \n\n.
// Use unshift() if we get too much.
// Call the callback with (error, header, stream).
const { StringDecoder } = require('string_decoder');
function parseHeader(stream, callback) {
stream.on('error', callback);
stream.on('readable', onReadable);
const decoder = new StringDecoder('utf8');
let header = '';
function onReadable() {
let chunk;
while (null !== (chunk = stream.read())) {
const str = decoder.write(chunk);
if (str.includes('\n\n')) {
// Found the header boundary.
const split = str.split(/\n\n/);
header += split.shift();
const remaining = split.join('\n\n');
const buf = Buffer.from(remaining, 'utf8');
stream.removeListener('error', callback);
// Remove the 'readable' listener before unshifting.
stream.removeListener('readable', onReadable);
if (buf.length)
stream.unshift(buf);
// Now the body of the message can be read from the stream.
callback(null, header, stream);
return;
}
// Still reading the header.
header += str;
}
}
} +
// Pull off a header delimited by \n\n.
// Use unshift() if we get too much.
// Call the callback with (error, header, stream).
const { StringDecoder } = require('string_decoder');
function parseHeader(stream, callback) {
stream.on('error', callback);
stream.on('readable', onReadable);
const decoder = new StringDecoder('utf8');
let header = '';
function onReadable() {
let chunk;
while (null !== (chunk = stream.read())) {
const str = decoder.write(chunk);
if (str.includes('\n\n')) {
// Found the header boundary.
const split = str.split(/\n\n/);
header += split.shift();
const remaining = split.join('\n\n');
const buf = Buffer.from(remaining, 'utf8');
stream.removeListener('error', callback);
// Remove the 'readable' listener before unshifting.
stream.removeListener('readable', onReadable);
if (buf.length)
stream.unshift(buf);
// Now the body of the message can be read from the stream.
callback(null, header, stream);
return;
}
// Still reading the header.
header += str;
}
}
}

Unlike push, stream.unshift(chunk) will not end the reading process by resetting the internal reading state of the stream. diff --git a/classes/factory._internal_.internal-1.Transform.html b/classes/factory._internal_.internal-1.Transform.html index 2690bad..9779f05 100644 --- a/classes/factory._internal_.internal-1.Transform.html +++ b/classes/factory._internal_.internal-1.Transform.html @@ -366,7 +366,7 @@ pulled out of the source, so that the data can be passed on to some other party. has been emitted or a runtime error will be thrown.

Developers using stream.unshift() often should consider switching to use of a Transform stream instead. See the API for stream implementers section for more information.

-
// Pull off a header delimited by \n\n.
// Use unshift() if we get too much.
// Call the callback with (error, header, stream).
const { StringDecoder } = require('string_decoder');
function parseHeader(stream, callback) {
stream.on('error', callback);
stream.on('readable', onReadable);
const decoder = new StringDecoder('utf8');
let header = '';
function onReadable() {
let chunk;
while (null !== (chunk = stream.read())) {
const str = decoder.write(chunk);
if (str.includes('\n\n')) {
// Found the header boundary.
const split = str.split(/\n\n/);
header += split.shift();
const remaining = split.join('\n\n');
const buf = Buffer.from(remaining, 'utf8');
stream.removeListener('error', callback);
// Remove the 'readable' listener before unshifting.
stream.removeListener('readable', onReadable);
if (buf.length)
stream.unshift(buf);
// Now the body of the message can be read from the stream.
callback(null, header, stream);
return;
}
// Still reading the header.
header += str;
}
}
} +
// Pull off a header delimited by \n\n.
// Use unshift() if we get too much.
// Call the callback with (error, header, stream).
const { StringDecoder } = require('string_decoder');
function parseHeader(stream, callback) {
stream.on('error', callback);
stream.on('readable', onReadable);
const decoder = new StringDecoder('utf8');
let header = '';
function onReadable() {
let chunk;
while (null !== (chunk = stream.read())) {
const str = decoder.write(chunk);
if (str.includes('\n\n')) {
// Found the header boundary.
const split = str.split(/\n\n/);
header += split.shift();
const remaining = split.join('\n\n');
const buf = Buffer.from(remaining, 'utf8');
stream.removeListener('error', callback);
// Remove the 'readable' listener before unshifting.
stream.removeListener('readable', onReadable);
if (buf.length)
stream.unshift(buf);
// Now the body of the message can be read from the stream.
callback(null, header, stream);
return;
}
// Still reading the header.
header += str;
}
}
}

Unlike push, stream.unshift(chunk) will not end the reading process by resetting the internal reading state of the stream. diff --git a/functions/factory.buildDestinationFile.html b/functions/factory.buildDestinationFile.html index c8bc4e0..2b3620a 100644 --- a/functions/factory.buildDestinationFile.html +++ b/functions/factory.buildDestinationFile.html @@ -1,2 +1,2 @@ buildDestinationFile | @foxxmd/logging Docs

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • level: false | "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"
  • options: FileDestination

Returns LogLevelStreamEntry

Generated using TypeDoc

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

Function buildDestinationRollingFile

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • level: false | "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"
  • options: FileDestination

Returns Promise<LogLevelStreamEntry>

Generated using TypeDoc

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

Parameters

  • level: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"
  • options: Omit<StreamDestination, "destination"> = {}

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

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

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

Parameters

  • level: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug"
  • options: Omit<StreamDestination, "destination"> = {}

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

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

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

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.buildLogger.html b/functions/factory.buildLogger.html index 8f16397..daa0c47 100644 --- a/functions/factory.buildLogger.html +++ b/functions/factory.buildLogger.html @@ -1,4 +1,4 @@ buildLogger | @foxxmd/logging Docs
  • 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

    -

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.prettyOptsConsoleFactory.html b/functions/factory.prettyOptsConsoleFactory.html index b8c7819..f179f9a 100644 --- a/functions/factory.prettyOptsConsoleFactory.html +++ b/functions/factory.prettyOptsConsoleFactory.html @@ -1,4 +1,4 @@ prettyOptsConsoleFactory | @foxxmd/logging Docs
  • 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})
     
    -

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

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

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns PrettyOptions_

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/factory.prettyOptsFileFactory.html b/functions/factory.prettyOptsFileFactory.html index e198937..d73cfc5 100644 --- a/functions/factory.prettyOptsFileFactory.html +++ b/functions/factory.prettyOptsFileFactory.html @@ -1,4 +1,4 @@ prettyOptsFileFactory | @foxxmd/logging Docs
  • Generate pino-pretty PrettyOptions for use with file output

    Parameters

    Returns PrettyOptions_

    Source

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

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/index.childLogger.html b/functions/index.childLogger.html index 7f785c7..9f2ac94 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

      Generated using TypeDoc

      \ No newline at end of file +

        Returns Logger

        Generated using TypeDoc

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

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/functions/index.loggerApp.html b/functions/index.loggerApp.html index 7a3e17b..40aebdb 100644 --- a/functions/index.loggerApp.html +++ b/functions/index.loggerApp.html @@ -1,2 +1,2 @@ loggerApp | @foxxmd/logging Docs

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Logger

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Promise<Logger>

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns LogOptionsParsed

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/factory._internal_.Buffer-1.html b/interfaces/factory._internal_.Buffer-1.html index d019037..18e8897 100644 --- a/interfaces/factory._internal_.Buffer-1.html +++ b/interfaces/factory._internal_.Buffer-1.html @@ -115,7 +115,7 @@

        Methods

        • Writes string to buf at offset according to the character encoding inencoding. The length parameter is the number of bytes to write. If buf did not contain enough space to fit the entire string, only part of string will be written. However, partially encoded characters will not be written.

          -
          import { Buffer } from 'node:buffer';

          const buf = Buffer.alloc(256);

          const len = buf.write('\u00bd + \u00bc = \u00be', 0);

          console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
          // Prints: 12 bytes: ½ + ¼ = ¾

          const buffer = Buffer.alloc(10);

          const length = buffer.write('abcd', 8);

          console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
          // Prints: 2 bytes : ab +
          import { Buffer } from 'node:buffer';

          const buf = Buffer.alloc(256);

          const len = buf.write('\u00bd + \u00bc = \u00be', 0);

          console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
          // Prints: 12 bytes: ½ + ¼ = ¾

          const buffer = Buffer.alloc(10);

          const length = buffer.write('abcd', 8);

          console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
          // Prints: 2 bytes : ab

          Parameters

          • string: string

            String to write to buf.

          • Optional encoding: BufferEncoding

            The character encoding of string.

            @@ -595,7 +595,7 @@ integer. If the resulting integer is greater than 255 (decimal), value &#x26; 255
            .

            If the final write of a fill() operation falls on a multi-byte character, then only the bytes of that character that fit into buf are written:

            -
            import { Buffer } from 'node:buffer';

            // Fill a `Buffer` with character that takes up two bytes in UTF-8.

            console.log(Buffer.allocUnsafe(5).fill('\u0222'));
            // Prints: <Buffer c8 a2 c8 a2 c8> +
            import { Buffer } from 'node:buffer';

            // Fill a `Buffer` with character that takes up two bytes in UTF-8.

            console.log(Buffer.allocUnsafe(5).fill('\u0222'));
            // Prints: <Buffer c8 a2 c8 a2 c8>

            If value contains invalid characters, it is truncated; if no valid fill data remains, an exception is thrown:

            @@ -615,7 +615,7 @@ To compare a partial Buffer, use buf.subarray.
          • a number, value will be interpreted as an unsigned 8-bit integer value between 0 and 255.
          -
          import { Buffer } from 'node:buffer';

          const buf = Buffer.from('this is a buffer');

          console.log(buf.indexOf('this'));
          // Prints: 0
          console.log(buf.indexOf('is'));
          // Prints: 2
          console.log(buf.indexOf(Buffer.from('a buffer')));
          // Prints: 8
          console.log(buf.indexOf(97));
          // Prints: 8 (97 is the decimal ASCII value for 'a')
          console.log(buf.indexOf(Buffer.from('a buffer example')));
          // Prints: -1
          console.log(buf.indexOf(Buffer.from('a buffer example').slice(0, 8)));
          // Prints: 8

          const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');

          console.log(utf16Buffer.indexOf('\u03a3', 0, 'utf16le'));
          // Prints: 4
          console.log(utf16Buffer.indexOf('\u03a3', -4, 'utf16le'));
          // Prints: 6 +
          import { Buffer } from 'node:buffer';

          const buf = Buffer.from('this is a buffer');

          console.log(buf.indexOf('this'));
          // Prints: 0
          console.log(buf.indexOf('is'));
          // Prints: 2
          console.log(buf.indexOf(Buffer.from('a buffer')));
          // Prints: 8
          console.log(buf.indexOf(97));
          // Prints: 8 (97 is the decimal ASCII value for 'a')
          console.log(buf.indexOf(Buffer.from('a buffer example')));
          // Prints: -1
          console.log(buf.indexOf(Buffer.from('a buffer example').slice(0, 8)));
          // Prints: 8

          const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');

          console.log(utf16Buffer.indexOf('\u03a3', 0, 'utf16le'));
          // Prints: 4
          console.log(utf16Buffer.indexOf('\u03a3', -4, 'utf16le'));
          // Prints: 6

          If value is not a string, number, or Buffer, this method will throw aTypeError. If value is a number, it will be coerced to a valid byte value, an integer between 0 and 255.

          @@ -633,7 +633,7 @@ than buf.length, byteOffset will be returned. If

          Since

          v1.5.0

        • Identical to buf.indexOf(), except the last occurrence of value is found rather than the first occurrence.

          -
          import { Buffer } from 'node:buffer';

          const buf = Buffer.from('this buffer is a buffer');

          console.log(buf.lastIndexOf('this'));
          // Prints: 0
          console.log(buf.lastIndexOf('buffer'));
          // Prints: 17
          console.log(buf.lastIndexOf(Buffer.from('buffer')));
          // Prints: 17
          console.log(buf.lastIndexOf(97));
          // Prints: 15 (97 is the decimal ASCII value for 'a')
          console.log(buf.lastIndexOf(Buffer.from('yolo')));
          // Prints: -1
          console.log(buf.lastIndexOf('buffer', 5));
          // Prints: 5
          console.log(buf.lastIndexOf('buffer', 4));
          // Prints: -1

          const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');

          console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le'));
          // Prints: 6
          console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le'));
          // Prints: 4 +
          import { Buffer } from 'node:buffer';

          const buf = Buffer.from('this buffer is a buffer');

          console.log(buf.lastIndexOf('this'));
          // Prints: 0
          console.log(buf.lastIndexOf('buffer'));
          // Prints: 17
          console.log(buf.lastIndexOf(Buffer.from('buffer')));
          // Prints: 17
          console.log(buf.lastIndexOf(97));
          // Prints: 15 (97 is the decimal ASCII value for 'a')
          console.log(buf.lastIndexOf(Buffer.from('yolo')));
          // Prints: -1
          console.log(buf.lastIndexOf('buffer', 5));
          // Prints: 5
          console.log(buf.lastIndexOf('buffer', 4));
          // Prints: -1

          const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');

          console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le'));
          // Prints: 6
          console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le'));
          // Prints: 4

          If value is not a string, number, or Buffer, this method will throw aTypeError. If value is a number, it will be coerced to a valid byte value, an integer between 0 and 255.

          diff --git a/interfaces/factory._internal_.BufferConstructor.html b/interfaces/factory._internal_.BufferConstructor.html index 7f2720e..8ada784 100644 --- a/interfaces/factory._internal_.BufferConstructor.html +++ b/interfaces/factory._internal_.BufferConstructor.html @@ -71,7 +71,7 @@ for the encoding that is used to convert the string into bytes.

          For strings that contain non-base64/hex-encoded data (e.g. whitespace), the return value might be greater than the length of a Buffer created from the string.

          -
          import { Buffer } from 'node:buffer';

          const str = '\u00bd + \u00bc = \u00be';

          console.log(`${str}: ${str.length} characters, ` +
          `${Buffer.byteLength(str, 'utf8')} bytes`);
          // Prints: ½ + ¼ = ¾: 9 characters, 12 bytes +
          import { Buffer } from 'node:buffer';

          const str = '\u00bd + \u00bc = \u00be';

          console.log(`${str}: ${str.length} characters, ` +
          `${Buffer.byteLength(str, 'utf8')} bytes`);
          // Prints: ½ + ¼ = ¾: 9 characters, 12 bytes

          When string is a Buffer/DataView/[TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/- diff --git a/interfaces/factory._internal_.PrettyOptions_.html b/interfaces/factory._internal_.PrettyOptions_.html index 5f2e686..ef38e10 100644 --- a/interfaces/factory._internal_.PrettyOptions_.html +++ b/interfaces/factory._internal_.PrettyOptions_.html @@ -1,4 +1,4 @@ -PrettyOptions_ | @foxxmd/logging Docs

          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? +PrettyOptions_ | @foxxmd/logging Docs
          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

          Properties

          hideObject?: boolean

          Hide objects from output (but not error object).

          Default

          false
           
          -
          translateTime?: string | boolean

          Translate the epoch time value into a human readable date and time string. This flag also can set the format +

          translateTime?: string | boolean

          Translate the epoch time value into a human readable date and time string. This flag also can set the format string to apply when translating the date to human readable format. For a list of available pattern letters see the documentation.

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

          Default

          false
           
          -
          levelFirst?: boolean

          If set to true, it will print the name of the log level as the first field in the log line.

          +
          levelFirst?: boolean

          If set to true, it will print the name of the log level as the first field in the log line.

          Default

          false
           
          -
          levelKey?: string

          Define the key that contains the level of the log.

          +
          levelKey?: string

          Define the key that contains the level of the log.

          Default

          "level"
           
          -
          levelLabel?: string

          Output the log level using the specified label.

          +
          levelLabel?: string

          Output the log level using the specified label.

          Default

          "levelLabel"
           
          -
          messageKey?: string

          The key in the JSON object to use as the highlighted message.

          +
          messageKey?: string

          The key in the JSON object to use as the highlighted message.

          Default

          "msg"
           
          -
          singleLine?: boolean

          Print each log message on a single line (errors will still be multi-line).

          +
          singleLine?: boolean

          Print each log message on a single line (errors will still be multi-line).

          Default

          false
           
          -
          timestampKey?: string

          The key in the JSON object to use for timestamp display.

          +
          timestampKey?: string

          The key in the JSON object to use for timestamp display.

          Default

          "time"
           
          -
          minimumLevel?: Level

          The minimum log level to include in the output.

          +
          minimumLevel?: Level

          The minimum log level to include in the output.

          Default

          "trace"
           
          -
          messageFormat?: string | false | MessageFormatFunc

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

          +
          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;
          }
          } +

          Example

          {
          messageFormat: (log, messageKey) => {
          const message = log[messageKey];
          if (log.requestId) return `[${log.requestId}] ${message}`;
          return message;
          }
          }
          -
          colorize?: boolean

          If set to true, will add color information to the formatted output message.

          +
          colorize?: boolean

          If set to true, will add color information to the formatted output message.

          Default

          false
           
          -
          colorizeObjects?: boolean

          If set to false while colorize is true, will output JSON objects without color.

          +
          colorizeObjects?: boolean

          If set to false while colorize is true, will output JSON objects without color.

          Default

          true
           
          -
          crlf?: boolean

          Appends carriage return and line feed, instead of just a line feed, to the formatted log line.

          +
          crlf?: boolean

          Appends carriage return and line feed, instead of just a line feed, to the formatted log line.

          Default

          false
           
          -
          errorLikeObjectKeys?: string[]

          Define the log keys that are associated with error like objects.

          +
          errorLikeObjectKeys?: string[]

          Define the log keys that are associated with error like objects.

          Default

          ["err", "error"]
           
          -
          errorProps?: string

          When formatting an error object, display this list of properties. +

          errorProps?: string

          When formatting an error object, display this list of properties. The list should be a comma separated list of properties.

          Default

          ""
           
          -
          ignore?: string

          Ignore one or several keys. +

          ignore?: string

          Ignore one or several keys. Will be overridden by the option include if include is presented.

          Example

          "time,hostname"
           
          -
          include?: string

          Include one or several keys.

          +
          include?: string

          Include one or several keys.

          Example

          "time,level"
           
          -
          sync?: boolean

          Makes messaging synchronous.

          +
          sync?: boolean

          Makes messaging synchronous.

          Default

          false
           
          -
          destination?: string | number | DestinationStream | WritableStream

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

          +
          destination?: string | number | DestinationStream | WritableStream

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

          Default

          1
           
          -
          append?: boolean

          Opens the file with the 'a' flag.

          +
          append?: boolean

          Opens the file with the 'a' flag.

          Default

          true
           
          -
          mkdir?: boolean

          Ensure directory for destination file exists.

          +
          mkdir?: boolean

          Ensure directory for destination file exists.

          Default

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

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

          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

          {}
           
          -

          Example

          {
          customPrettifiers: {
          query: prettifyQuery
          }
          }
          //...
          const prettifyQuery = value => {
          // do some prettify magic
          } +

          Example

          {
          customPrettifiers: {
          query: prettifyQuery
          }
          }
          //...
          const prettifyQuery = value => {
          // do some prettify magic
          }
          -
          customLevels?: string | object

          Change the level names and values to an user custom preset.

          +
          customLevels?: string | object

          Change the level names and values to an user custom preset.

          Can be a CSV string in 'level_name:level_value' format or an object.

          -

          Example

          ( CSV ) customLevels: 'info:10,some_level:40'
          +

          Example

          ( CSV ) customLevels: 'info:10,some_level:40'
           
          -

          Example

          ( Object ) customLevels: { info: 10, some_level: 40 }
          +

          Example

          ( Object ) customLevels: { info: 10, some_level: 40 }
           
          -
          customColors?: string | object

          Change the level colors to an user custom preset.

          +
          customColors?: string | object

          Change the level colors to an user custom preset.

          Can be a CSV string in 'level_name:color_value' format or an object. Also supports 'default' as level_name for fallback color.

          -

          Example

          ( CSV ) customColors: 'info:white,some_level:red'
          +

          Example

          ( CSV ) customColors: 'info:white,some_level:red'
           
          -

          Example

          ( Object ) customColors: { info: 'white', some_level: 'red' }
          +

          Example

          ( Object ) customColors: { info: 'white', some_level: 'red' }
           
          -

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/interfaces/index.FileLogOptions.html b/interfaces/index.FileLogOptions.html index 1cef35f..ce3b62a 100644 --- a/interfaces/index.FileLogOptions.html +++ b/interfaces/index.FileLogOptions.html @@ -1,4 +1,4 @@ -FileLogOptions | @foxxmd/logging Docs
          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 {
              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'
           
          -
          frequency?: number | "daily" | "hourly"

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

          +
          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'
           
          -
          timestamp?: "unix" | "iso" | "auto"

          For rolling log files

          +
          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'
           
          -
          path?: string | (() => string)

          The path and filename to use for log files.

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

          -

          Generated using TypeDoc

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

          +

          Generated using TypeDoc

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

          Properties

          level? +LogOptions | @foxxmd/logging Docs
          interface LogOptions {
              level?: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug";
              file?: false | "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug" | FileLogOptions;
              console?: "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug";
          }

          Properties

          Properties

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

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

          Defaults to env LOG_LEVEL or info if not specified.

          Default

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

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

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

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

          -

          Generated using TypeDoc

          \ No newline at end of file +
          file?: false | "silent" | "fatal" | "error" | "warn" | "info" | "log" | "verbose" | "debug" | FileLogOptions

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

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

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

          +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/interfaces/index.LoggerAppExtras.html b/interfaces/index.LoggerAppExtras.html index d0e4a63..7fc95a0 100644 --- a/interfaces/index.LoggerAppExtras.html +++ b/interfaces/index.LoggerAppExtras.html @@ -1,7 +1,7 @@ -LoggerAppExtras | @foxxmd/logging Docs
          interface LoggerAppExtras {
              pretty?: PrettyOptionsExtra;
              destinations?: LogLevelStreamEntry[];
              pino?: PinoLoggerOptions;
          }

          Properties

          pretty? +LoggerAppExtras | @foxxmd/logging Docs
          interface LoggerAppExtras {
              pretty?: PrettyOptionsExtra;
              destinations?: LogLevelStreamEntry[];
              pino?: PinoLoggerOptions;
          }

          Properties

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

          -
          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

          -

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

          -

          Generated using TypeDoc

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

          +

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

          +

          Generated using TypeDoc

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

          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

          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

          Properties

          hideObject?: boolean

          Hide objects from output (but not error object).

          Default

          false
           
          -
          translateTime?: string | boolean

          Translate the epoch time value into a human readable date and time string. This flag also can set the format +

          translateTime?: string | boolean

          Translate the epoch time value into a human readable date and time string. This flag also can set the format string to apply when translating the date to human readable format. For a list of available pattern letters see the documentation.

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

          Default

          false
           
          -
          levelFirst?: boolean

          If set to true, it will print the name of the log level as the first field in the log line.

          +
          levelFirst?: boolean

          If set to true, it will print the name of the log level as the first field in the log line.

          Default

          false
           
          -
          levelKey?: string

          Define the key that contains the level of the log.

          +
          levelKey?: string

          Define the key that contains the level of the log.

          Default

          "level"
           
          -
          levelLabel?: string

          Output the log level using the specified label.

          +
          levelLabel?: string

          Output the log level using the specified label.

          Default

          "levelLabel"
           
          -
          messageKey?: string

          The key in the JSON object to use as the highlighted message.

          +
          messageKey?: string

          The key in the JSON object to use as the highlighted message.

          Default

          "msg"
           
          -
          singleLine?: boolean

          Print each log message on a single line (errors will still be multi-line).

          +
          singleLine?: boolean

          Print each log message on a single line (errors will still be multi-line).

          Default

          false
           
          -
          timestampKey?: string

          The key in the JSON object to use for timestamp display.

          +
          timestampKey?: string

          The key in the JSON object to use for timestamp display.

          Default

          "time"
           
          -
          minimumLevel?: Level

          The minimum log level to include in the output.

          +
          minimumLevel?: Level

          The minimum log level to include in the output.

          Default

          "trace"
           
          -
          messageFormat?: string | false | MessageFormatFunc

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

          +
          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;
          }
          } +

          Example

          {
          messageFormat: (log, messageKey) => {
          const message = log[messageKey];
          if (log.requestId) return `[${log.requestId}] ${message}`;
          return message;
          }
          }
          -
          colorize?: boolean

          If set to true, will add color information to the formatted output message.

          +
          colorize?: boolean

          If set to true, will add color information to the formatted output message.

          Default

          false
           
          -
          colorizeObjects?: boolean

          If set to false while colorize is true, will output JSON objects without color.

          +
          colorizeObjects?: boolean

          If set to false while colorize is true, will output JSON objects without color.

          Default

          true
           
          -
          crlf?: boolean

          Appends carriage return and line feed, instead of just a line feed, to the formatted log line.

          +
          crlf?: boolean

          Appends carriage return and line feed, instead of just a line feed, to the formatted log line.

          Default

          false
           
          -
          errorLikeObjectKeys?: string[]

          Define the log keys that are associated with error like objects.

          +
          errorLikeObjectKeys?: string[]

          Define the log keys that are associated with error like objects.

          Default

          ["err", "error"]
           
          -
          errorProps?: string

          When formatting an error object, display this list of properties. +

          errorProps?: string

          When formatting an error object, display this list of properties. The list should be a comma separated list of properties.

          Default

          ""
           
          -
          ignore?: string

          Ignore one or several keys. +

          ignore?: string

          Ignore one or several keys. Will be overridden by the option include if include is presented.

          Example

          "time,hostname"
           
          -
          include?: string

          Include one or several keys.

          +
          include?: string

          Include one or several keys.

          Example

          "time,level"
           
          -
          sync?: boolean

          Makes messaging synchronous.

          +
          sync?: boolean

          Makes messaging synchronous.

          Default

          false
           
          -
          destination?: string | number | DestinationStream | WritableStream

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

          +
          destination?: string | number | DestinationStream | WritableStream

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

          Default

          1
           
          -
          append?: boolean

          Opens the file with the 'a' flag.

          +
          append?: boolean

          Opens the file with the 'a' flag.

          Default

          true
           
          -
          mkdir?: boolean

          Ensure directory for destination file exists.

          +
          mkdir?: boolean

          Ensure directory for destination file exists.

          Default

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

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

          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

          {}
           
          -

          Example

          {
          customPrettifiers: {
          query: prettifyQuery
          }
          }
          //...
          const prettifyQuery = value => {
          // do some prettify magic
          } +

          Example

          {
          customPrettifiers: {
          query: prettifyQuery
          }
          }
          //...
          const prettifyQuery = value => {
          // do some prettify magic
          }
          -
          customColors?: string | object

          Change the level colors to an user custom preset.

          +
          customColors?: string | object

          Change the level colors to an user custom preset.

          Can be a CSV string in 'level_name:color_value' format or an object. Also supports 'default' as level_name for fallback color.

          -

          Example

          ( CSV ) customColors: 'info:white,some_level:red'
          +

          Example

          ( CSV ) customColors: 'info:white,some_level:red'
           
          -

          Example

          ( Object ) customColors: { info: 'white', some_level: 'red' }
          +

          Example

          ( Object ) customColors: { info: 'white', some_level: 'red' }
           
          -
          redactCwd?: boolean

          Control whether the current working directory should be replaced with 'CWD' in log output

          +
          redactCwd?: boolean

          Control whether the current working directory should be replaced with 'CWD' in log output

          Useful for eliminating noisy parent paths that aren't relevant during debugging -- or to protect user privacy.

          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
           
          -
          padLevels?: boolean

          Pads levels in log string so all are the same length

          +
          padLevels?: boolean

          Pads levels in log string so all are the same length

          Default

          true
           
          -

          Generated using TypeDoc

          \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/index._internal_.FileLogOptionsStrong.html b/interfaces/index._internal_.FileLogOptionsStrong.html index b5c7c44..15d18e9 100644 --- a/interfaces/index._internal_.FileLogOptionsStrong.html +++ b/interfaces/index._internal_.FileLogOptionsStrong.html @@ -1,4 +1,4 @@ -FileLogOptionsStrong | @foxxmd/logging Docs
        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 {
            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'
         
        -
        frequency?: number | "daily" | "hourly"

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

        +
        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'
         
        -
        timestamp?: "unix" | "iso" | "auto"

        For rolling log files

        +
        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: "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: string | (() => string)

        The path and filename to use for log files.

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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/index._internal_.FileOptions.html b/interfaces/index._internal_.FileOptions.html index 9382940..a655a51 100644 --- a/interfaces/index._internal_.FileOptions.html +++ b/interfaces/index._internal_.FileOptions.html @@ -1,4 +1,4 @@ -FileOptions | @foxxmd/logging Docs
        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 {
            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'
         
        -
        frequency?: number | "daily" | "hourly"

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

        +
        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'
         
        -
        timestamp?: "unix" | "iso" | "auto"

        For rolling log files

        +
        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'
         
        -
        path?: string | (() => string)

        The path and filename to use for log files.

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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/index._internal_.PinoRollOptions.html b/interfaces/index._internal_.PinoRollOptions.html index fd5eb8c..1baf8b4 100644 --- a/interfaces/index._internal_.PinoRollOptions.html +++ b/interfaces/index._internal_.PinoRollOptions.html @@ -1,13 +1,13 @@ -PinoRollOptions | @foxxmd/logging Docs
        interface PinoRollOptions {
            size?: string | number;
            frequency?: number | "daily" | "hourly";
        }

        Hierarchy (view full)

        Properties

        size? +PinoRollOptions | @foxxmd/logging Docs
        interface PinoRollOptions {
            size?: string | number;
            frequency?: number | "daily" | "hourly";
        }

        Hierarchy (view full)

        Properties

        Properties

        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'
         
        -
        frequency?: number | "daily" | "hourly"

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

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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/index._internal_.RollOptions.html b/interfaces/index._internal_.RollOptions.html index 6270423..f8de0a2 100644 --- a/interfaces/index._internal_.RollOptions.html +++ b/interfaces/index._internal_.RollOptions.html @@ -1,4 +1,4 @@ -RollOptions | @foxxmd/logging Docs
        interface RollOptions {
            timestamp?: "unix" | "iso" | "auto";
        }

        Hierarchy (view full)

        Properties

        timestamp? +RollOptions | @foxxmd/logging Docs
        interface RollOptions {
            timestamp?: "unix" | "iso" | "auto";
        }

        Hierarchy (view full)

        Properties

        Properties

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

        For rolling log files

        When

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

        Default

        'auto'
         
        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/modules/factory._internal_.html b/modules/factory._internal_.html index 6763fcf..60eaf72 100644 --- a/modules/factory._internal_.html +++ b/modules/factory._internal_.html @@ -13,7 +13,8 @@ Readable Writable MessagePort -

        Interfaces

        Interfaces

        PrettyOptions_ +BlobOptions BufferConstructor Buffer KeyExportOptions @@ -78,7 +79,6 @@ PeerCertificate WorkerOptions ResourceLimits -PrettyOptions_ TransportTargetOptions TransportBaseOptions TransportSingleOptions diff --git a/modules/factory.html b/modules/factory.html index 5d493fa..38c360c 100644 --- a/modules/factory.html +++ b/modules/factory.html @@ -1,4 +1,4 @@ -factory | @foxxmd/logging Docs

        Index

        Modules

        <internal> +factory | @foxxmd/logging Docs

        Index

        Modules

        Type Aliases

        Variables

        PRETTY_OPTS_CONSOLE diff --git a/modules/index._internal_.html b/modules/index._internal_.html index 851166a..d928a8b 100644 --- a/modules/index._internal_.html +++ b/modules/index._internal_.html @@ -27,7 +27,12 @@ RollOptions FileOptions FileLogOptionsStrong -

        Type Aliases

        Type Aliases

        LogDescriptor +Prettifier +PrettifierExtras +LevelPrettifierExtras +MessageFormatFunc +EventMap DefaultEventMap AnyRest Args @@ -35,11 +40,6 @@ Key2 Listener Color -LogDescriptor -Prettifier -PrettifierExtras -LevelPrettifierExtras -MessageFormatFunc CustomLevelLogger OnChildCallback Bindings diff --git a/modules/index.html b/modules/index.html index 059c12b..9511073 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,4 +1,4 @@ -index | @foxxmd/logging Docs

        Index

        Modules

        <internal> +index | @foxxmd/logging Docs

        Index

        Modules

        Interfaces

        LogOptions FileLogOptions LoggerAppExtras diff --git a/types/factory.FileDestination.html b/types/factory.FileDestination.html index d7f5fdd..893ab09 100644 --- a/types/factory.FileDestination.html +++ b/types/factory.FileDestination.html @@ -1 +1 @@ -FileDestination | @foxxmd/logging Docs
        FileDestination: Omit<PrettyOptionsExtra, "destination" | "sync"> & FileOptionsParsed

        Generated using TypeDoc

        \ No newline at end of file +FileDestination | @foxxmd/logging Docs
        FileDestination: Omit<PrettyOptionsExtra, "destination" | "sync"> & FileOptionsParsed

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/factory.StreamDestination.html b/types/factory.StreamDestination.html index ef9ffb9..aab041d 100644 --- a/types/factory.StreamDestination.html +++ b/types/factory.StreamDestination.html @@ -1 +1 @@ -StreamDestination | @foxxmd/logging Docs
        StreamDestination: Omit<PrettyOptionsExtra, "destination"> & {
            destination: number | DestinationStream | WritableStream;
        }

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +StreamDestination | @foxxmd/logging Docs
        StreamDestination: Omit<PrettyOptionsExtra, "destination"> & {
            destination: number | DestinationStream | WritableStream;
        }

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/factory._internal_.FileOptionsParsed.html b/types/factory._internal_.FileOptionsParsed.html index 852c2c8..2c568da 100644 --- a/types/factory._internal_.FileOptionsParsed.html +++ b/types/factory._internal_.FileOptionsParsed.html @@ -1 +1 @@ -FileOptionsParsed | @foxxmd/logging Docs
        FileOptionsParsed: MarkRequired<FileOptions, "path">

        Generated using TypeDoc

        \ No newline at end of file +FileOptionsParsed | @foxxmd/logging Docs
        FileOptionsParsed: MarkRequired<FileOptions, "path">

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/factory._internal_.PinoLoggerOptions.html b/types/factory._internal_.PinoLoggerOptions.html index e4da781..78fec74 100644 --- a/types/factory._internal_.PinoLoggerOptions.html +++ b/types/factory._internal_.PinoLoggerOptions.html @@ -1,2 +1,2 @@ PinoLoggerOptions | @foxxmd/logging Docs
        PinoLoggerOptions: Omit<LoggerOptions, "level" | "mixin" | "mixinMergeStrategy" | "customLevels" | "useOnlyCustomLevels" | "transport">

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

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/index.LogData.html b/types/index.LogData.html index 9d5dc24..9e7555d 100644 --- a/types/index.LogData.html +++ b/types/index.LogData.html @@ -1,2 +1,2 @@ LogData | @foxxmd/logging Docs
        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

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/index.LogLevel.html b/types/index.LogLevel.html index da8513a..f6d62d6 100644 --- a/types/index.LogLevel.html +++ b/types/index.LogLevel.html @@ -1 +1 @@ -LogLevel | @foxxmd/logging Docs
        LogLevel: typeof LOG_LEVEL_NAMES[number]

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/index.LogLevelStreamEntry.html b/types/index.LogLevelStreamEntry.html index 7f7d228..a0d8b6e 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

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

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

        Type declaration

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

              • value: any

              Returns void

        Generated using TypeDoc

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

        Type declaration

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

              • value: any

              Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/index._internal_.FileLogOptionsParsed.html b/types/index._internal_.FileLogOptionsParsed.html index 28e6bd0..430d142 100644 --- a/types/index._internal_.FileLogOptionsParsed.html +++ b/types/index._internal_.FileLogOptionsParsed.html @@ -1 +1 @@ -FileLogOptionsParsed | @foxxmd/logging Docs
        FileLogOptionsParsed: Omit<FileLogOptions, "file"> & {
            level: false;
        } | FileLogOptionsStrong

        Generated using TypeDoc

        \ No newline at end of file +FileLogOptionsParsed | @foxxmd/logging Docs
        FileLogOptionsParsed: Omit<FileLogOptions, "file"> & {
            level: false;
        } | FileLogOptionsStrong

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/index._internal_.LevelPrettifierExtras.html b/types/index._internal_.LevelPrettifierExtras.html index d5f56bf..542e6bc 100644 --- a/types/index._internal_.LevelPrettifierExtras.html +++ b/types/index._internal_.LevelPrettifierExtras.html @@ -1 +1 @@ -LevelPrettifierExtras | @foxxmd/logging Docs
        LevelPrettifierExtras: {
            label: string;
            labelColorized: string;
        }

        Type declaration

        • label: string
        • labelColorized: string

        Generated using TypeDoc

        \ No newline at end of file +LevelPrettifierExtras | @foxxmd/logging Docs
        LevelPrettifierExtras: {
            label: string;
            labelColorized: string;
        }

        Type declaration

        • label: string
        • labelColorized: string

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/index._internal_.LogDescriptor.html b/types/index._internal_.LogDescriptor.html index 282e7db..877da06 100644 --- a/types/index._internal_.LogDescriptor.html +++ b/types/index._internal_.LogDescriptor.html @@ -1 +1 @@ -LogDescriptor | @foxxmd/logging Docs
        LogDescriptor: Record<string, unknown>

        Generated using TypeDoc

        \ No newline at end of file +LogDescriptor | @foxxmd/logging Docs
        LogDescriptor: Record<string, unknown>

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/index._internal_.LogOptionsParsed.html b/types/index._internal_.LogOptionsParsed.html index 00c55c5..f383391 100644 --- a/types/index._internal_.LogOptionsParsed.html +++ b/types/index._internal_.LogOptionsParsed.html @@ -1 +1 @@ -LogOptionsParsed | @foxxmd/logging Docs
        LogOptionsParsed: Omit<Required<LogOptions>, "file"> & {
            file: FileLogOptionsParsed;
        }

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +LogOptionsParsed | @foxxmd/logging Docs
        LogOptionsParsed: Omit<Required<LogOptions>, "file"> & {
            file: FileLogOptionsParsed;
        }

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/index._internal_.MessageFormatFunc.html b/types/index._internal_.MessageFormatFunc.html index f46f424..0fbc7d9 100644 --- a/types/index._internal_.MessageFormatFunc.html +++ b/types/index._internal_.MessageFormatFunc.html @@ -1 +1 @@ -MessageFormatFunc | @foxxmd/logging Docs
        MessageFormatFunc: ((log, messageKey, levelLabel, extras) => string)

        Type declaration

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

            Returns string

        Generated using TypeDoc

        \ No newline at end of file +MessageFormatFunc | @foxxmd/logging Docs
        MessageFormatFunc: ((log, messageKey, levelLabel, extras) => string)

        Type declaration

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

            Returns string

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/index._internal_.Prettifier.html b/types/index._internal_.Prettifier.html index a386d78..ad7112e 100644 --- a/types/index._internal_.Prettifier.html +++ b/types/index._internal_.Prettifier.html @@ -1 +1 @@ -Prettifier | @foxxmd/logging Docs
        Prettifier<T>: ((inputData, key, log, extras) => string)

        Type Parameters

        • T = object

        Type declaration

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

            Returns string

        Generated using TypeDoc

        \ No newline at end of file +Prettifier | @foxxmd/logging Docs
        Prettifier<T>: ((inputData, key, log, extras) => string)

        Type Parameters

        • T = object

        Type declaration

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

            Returns string

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/index._internal_.PrettifierExtras.html b/types/index._internal_.PrettifierExtras.html index b08f724..ecbefe4 100644 --- a/types/index._internal_.PrettifierExtras.html +++ b/types/index._internal_.PrettifierExtras.html @@ -1 +1 @@ -PrettifierExtras | @foxxmd/logging Docs
        PrettifierExtras<T>: {
            colors: Colorette;
        } & T

        Type Parameters

        • T = object

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +PrettifierExtras | @foxxmd/logging Docs
        PrettifierExtras<T>: {
            colors: Colorette;
        } & T

        Type Parameters

        • T = object

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/variables/factory.PRETTY_COLORS.html b/variables/factory.PRETTY_COLORS.html index 2ca3b6a..b3d1f49 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

        -

        Generated using TypeDoc

        \ No newline at end of file +

        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 d7947f4..fc115db 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

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/variables/factory.PRETTY_ISO8601.html b/variables/factory.PRETTY_ISO8601.html index 0ce19b8..bab26f2 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

        -

        Generated using TypeDoc

        \ No newline at end of file +

        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 1d49938..730f85d 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()
         
        -

        Generated using TypeDoc

        \ No newline at end of file +

        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 0daae43..f136096 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()
         
        -

        Generated using TypeDoc

        \ No newline at end of file +

        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 9504dd1..b6e4cf3 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"] = ...

        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"] = ...

        Generated using TypeDoc

        \ No newline at end of file diff --git a/variables/index.loggerDebug.html b/variables/index.loggerDebug.html index e7b3d6d..177f02c 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')])
         
        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/variables/index.loggerTest.html b/variables/index.loggerTest.html index 5498951..e041c5e 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')])
         
        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file