diff --git a/docs/generated/assets/navigation.js b/docs/generated/assets/navigation.js index 60e80428..5fb0ec27 100644 --- a/docs/generated/assets/navigation.js +++ b/docs/generated/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE52W0U7qQBCG36XX5iAVqsc7oDUaMZjWxAtjmlpG2Ljsrt2t0WN891NAbbtddhluO998f1Nmwjx8egrelXfuTYlUwGZCEc6kd+SJTC2rx8DKley1in+WakUr4oWwuXd+9nX06xgJ0REQpqB4znKQvbrcVvjDoCG5VErE8FqCVEZLo+7WSFGlgcWzBWyim5IqIrJCXRCgc6Oqjdhkd7ASNFMwr76FUdUEbKJ7eEp4/gLmb/Rb3UsxhmX2RnhhV/1QNmUpU7oZlVTufjkdcgjtJoQizTlbP0sdspqzaSd8JQqQsjPw6kNUNq2smY7/nvaHfsMWQ84XjPyDeaIKwha6Tq+7fGEUXk1Gd1GYTmY3t3GUJLM47ftn1+Pa/JYVJHuilX033c45cUcEmIQAH1D9CIiEDY2NOPERCWsYHYDx4/UDhH6A1wcYf3BAAGZI9x3RMKqb7PImiVbvMf8d/IAQXMYhEc4V0Gl8hHvNOjg+xDmrOo2PGPZ9TMYax4c4d0KnbRFXyWg8jUKj8LtmaU8uR3FrCU2eDuQWulbUgFmkrfvquWT55m+417mqgkHzTZLpjr5txdK6AHVbHYDS1PxTs7TrN1GaU968W2uZmbSrv0nK84ymghdqh7jDdbSP/wElE6VGMQwAAA==" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52WW2+jMBBG/4ufo6WhCdvNGwmsWjVVKqi0D6sVcsk0sUpsLzbVXrT/fZX0AhjHzuSVOXM+hGbEfP9LNPzSZEaWTGngK6mZ4IqMiKR6S2YEeLNTQa/4aat3FRmRZ8bXZHb1b/ThiKUcCBjXUD/RElTQlvuKcBp1JNdaywx+NqC01dKp+zVKCq7A4XkFXKK7ptJM0lp/ZVCtrao+4pI9wE5WVMM6ltKq6gIu0Td4zEX5DPZv9FE9STGHLX1honar3imXslFFdRiVQh1/ORPyCN0mhKIoBd8/KzyylnNpF2Ina1BqMPD6twQVGGXDdPHl83gadmwZlGLD2R9Y57pmfGPqzLrPl6TJzSJ+SJNisbq7z9I8X2XFOLy6nbfmF1oz+liBCo7T/ZxLf0SESYjwAeEUk3CgsRGXISJhD6MDMH68foLQT/D6COOPzgjADOmpI5qkbZNb3iXR6hPmf4CfEYLLOCfCuwImjY/wr9kAx4d4Z9Wk8RHTcYjJ2OP4EO9OmLQr4iaP58s0sQrfao72/DrOekto8wwgv9C3ohbMIe3dV08NLw+/4WBwVUWT7pvkyyN9rxVH6wb0Pa21sjW/1xzt5k1UlJXo3q2tzE661W9kJUpaFVLU+oh4wA20P/4DJROlRjEMAAA=" \ No newline at end of file diff --git a/docs/generated/assets/search.js b/docs/generated/assets/search.js index 73e4dbaa..73ce4268 100644 --- a/docs/generated/assets/search.js +++ b/docs/generated/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE8VdbXPbOA7+L87XXFbUu/otbbOznctee027ezeZjkexlURT2/JKctNcp//9SOrFAAXIeul0P6WuADwgHxAkIYn6tsizp2Lx4vbb4nO6Wy9e+O75Yhdvk8WLxeV+vzhfHPKN/Pf9Ybcq02xX/CL/9+Kx3G7kpdUmLopEai8W388JAzc317SN6sJQM4diuUmLMtkti2z1OSmXq01WJIRZWnAETK22yVbxZrnP8pIG6YgNhXhIyndxXhaE2eZSrynb89leaW2muzLJ7+NV0u2QMcZ7rU41t1xl0s7Xctlv+CjWD2FFgfDsFuZ9ssoedun/kvVNmae7hxajfN5L8+blwe7/mdzdsL3RXjzhqhu29opE/tdJU2e1GLB3vtjHebIrkU8MiAyol4f7+yRP1pfb7LAb4PwZpTMRflgTZ7UQpwEepJGbCLOHkcSj1GITQYrDXbHK07sh7YGyE+EOuzGAWHoiZFrcNEaGRIYhPn0QfMj26aoYFvyt7NRQOdzJfPs4JFpayanBn+Wfh8R+JTa9+94n26xMLtfrPCkG9qKp8oPAL4sPckqY4EKrON2Rj0WSv47LeBg6kB4BCSac38py/z4p9nJhQI5PeH34tLOPDwPNnTWitPvIPQZMdvxhOxCtlZ0O95SnZXJTxuWBDNIuJlaYCfxbEq+TfARwqzATeATkLDBmNu9C9U3oA4H+TMvH7FC+zNbPgzGxznT4Mn++GtrUVnY6HLuC6aL1L2KGgMnE9KcKhLf39wW9lO2idnSmw2c7ZSm+2wxsMJKfA3t5J3do9JqDQj2KzwHlJgsKsXeqGMjsyWma5HbYTD3FBX6yPu3Iifl6oDvv8uxrmqyndQyj/MMdGtlNvSZmpCFmLUlkob7l5BCow/4hl1PfMLSj8DjAzkrqr0NS9PSyvjx8HSWJODXhHy2eQem+ZlQ+9oRPnMt/l8NRocIc4I/5ZihkJToH7PdETuQ9uRrjtdJzIF/FRXKT7Iq0TL8k4/Bp1TnO/PuQ5D3LHgzfCE8GvM/yq3hF7lc7eEfZyXByCfHfNNkM614gPAqQqtu9TB7jL2lGDp2OUG8iEJZ9LOdu46/v4udNFq+vk91D2b/vR+bPCNUTW8W2DYwzeoH4dvcyXn3eq3nhkCfX6Tbt3zBjp3pMzHRONvc6vU/KlN4S8p0EtGa6kK43yQdpSW4TRriAteZSlG11v6bZbgwrSGs+EZDecWQYmjNdUeXtd+nuobg8lNk2LtNVvNmQuY/xiDUw07GeNQrjyamFSh+073nOMWUtl+pexXjoi0rxH8If7sRF4zbTD9k+GROntfhP7wGF2zQ/HNF67S83TGSQxw+jhker8dM7oIZu+mBMBDReM92wzrP9/kS5Hvty1Pjp3VBDN93gjuiGxmu2G+J0zEho5P+GLpDATQfYozpAedy3shi7jPg7ml/d7m/Vhja+8pdp/Mm7f9iFYXcBf3zTFW47B1gjGq8d5tqejWt79je1PQNtHxP12mFudVLdfdyX4xZrhtpP7wuI3/bJmFSIGkBvqy73+7f6OllPO14dvpH6nDwv79NNstS/Txs9MxXo1gFHudSW5OU45I7GZOh4JHD8Q2D3Um3/mMd0RjdBkfRUyPXjcq9qUcW4BtNqU50ois1yle4fk3xI1J5h8TmgcsN0n+TLTfa03CbbLH9eHrilJeUErz7CqWMJ5lo/DmYO32R32Ba/oGv9g/eYDK7fvPx4s7x+c/Ph6l/L11e/Xn68/nDS7hmjRTcJ+3zai6v/vLr+ePPmj6vlu7fvxzrTUR7nE8yTH5LtfhOXyRo+BAnohteHV5+rB/oG2TtrZelGIAd74ZaHXfp1DGajMB34gb5H2QV86LkxOQRon9H3BrpIteR0qIyfNrtoR+HpgOuErN13wSrBGZ0Yl3QdmejFWnQGGF3CI6B6qnZDgB6TmNz8dpFqyelQq2y3S1YD23UUng5Y5tL4MLhGdDpYvCMLe12oSnA60NPAwfU0b1z1POhHRWH/s35DAOXc1T4PSa9gurgdnRn8rdc3Sf4lyf/FLN4IJg2VGUks2zL1FyKPNbLT4XK5zPqSjG0uoTXdhW1aFHJfPtYHSm26E3LVzdxt7iK3sjMSIFdlItJfb4GJAwMrs98PmzKVCuWv3O1ILDF8J7tmnvsh7J2t+577MVxk4Li9FAXXu4EaBscVIyi43iLcMDi17xvTQiA/EtZ8k+RVfc/N3ChVL5IYV3ujwzkaff3m5vLl9dXr1tqXOE/VA27FL82loaZufrt8f/V6+ert7+/eX93cvH1P2OzIjDT++mqIeSg1uCOuXr95dfkBObd0/vmS6hhGdBaUOxzKnQkVDocKZ0IJfziWkp3Hlj2CLnsmmD+CMH8uY8IewZkWngUnp6XhcFp4PBwco6eZ60jPBDwZlx3pmYCn+DOFZ8KdCk5TeCbcKPp+AHujyJsN5wl7BJ6Sngc4GIuC+XQuVyTr5OvixbeFXHHrJ3ReLOwL5yKSkvdqjSEFb5tV2irbbtU65FN97Q+5hc9yJVGJ/GItzm+tc9e7sEX46dP5baOhL+j/0GJC/hKUmEBitvxlU2I2EnPkL4cSc5CYK3+5lJiLxDz5y6PEPCTmy18+JeYjsUD+CiixAImF8ldIiYVITJJyG1FiEe5e1duC5EEYRGgmaCowF+q25K2QbFgXQmBBzIZQvS6cc8e9sB0bS2JC1F29W+FSJjElQnW9IEkRmBX18NCtIHkRmBihCBAkNQJzIxQHgmRHYHqEokFEVIMwQbZiwbYIQRvzYysSbEEJGkNFjxWKHhvTYysObHK42JgeW5FgkyPGxvzYigSb5MfG/NiKBJvkx8b82IoEm+THxvzYigSb5MfG/NiKBZscQDYmyLG4aHcwQY6iwSGHmoMZchQPDjnUHCOf8SPIwRQ5igeHTJEOpshRPDh0lsQUOYoHh6TdwRQ5igeHpN3BFDkhF8YOZsiJuDB2MEGuosEhA8nFDLmaITKQXMyQa3Oj0sUEuXrGCSlBY8rR/JAB52J+XEWCS8aRi/lxFQkuGUcu5sdVJLhkdLiYH1ex4JLR4WKCXEWDS0+jmCFP0eDSMylmyFM0uCSXHmbIUzy4JJcepshTRLhkUvAwR55eF5AcecbKQC8NSI48zJGniPBIjjzMkaeI8EiOPMyRp4jwSI48zJGniPBIjjzMka+I8EiOfMyRL7iQ9zFFvuLB889t/yLwsSBmyFc0eCSXPmbId1mTmCBfE0SS7hurN581ifnxNT9kdPiYHz9kTWJ6fMWBT4aRj+kJLM5kgNkJBDtjBJiegKUnwPQEDrc4CzA7ActOgNkJFAU+OSgCzE7AshMYq2tFgU+OngCzE7DsBJidQLNDDrMAsxMqDnxymIWYnlBx4JPDLMT0hIoEn0yFIeYnVCz45PAJMUGhosGndxeYoVAzRAZ7iBkKFQ8BGcMhpijUOyCS9dDYAykiApLMEHMUKiICkqMQcxQpIgKSowhzFCkiApKjCHMUKSICkqMIcxQpIgKSowhzFCkiApKjCHMUKSICehOIOYoUESHJUYQ5ihQRIclRhDmK9EaV5CgytqqKiJDkKDJ3q4qJkCSpugZlFRchvRW0jB2rpdgI6c2gZWxaLcVHSG8HLWPbaul9K7nNs4yNq6UoCem9o2VsXS3NF8lsdQ3KKloiZodvbF8tRUxE7/EtYwNr6QoDyW91DcjqUkJEMiw6ZQZ+ghJmoUHXEyI6HMxag64oRHQ4mNUGXVSI6HAwCw66rBDR4WCWHHRhIaI5NosOurQQ0RybZYeq7mDRJJuVh6r0YDGVHIM5u6oP0TQbFQihCw1yDNDCZpFIV4ksmjyjEiF0vUEOA1rYYE+XHOQ4oIUN+nTVQQ4EWtjgTxce5EighQ0Cde1BDgVa2GBQlx8EU4gzahNCVyAEU4szyhOiqk8ImkGjRCGcqshHM2hUKYSuRQhBM+iYpT7NIFOZM2oVQlckBFOcM8oVQhclBFOfMyoWQtclBFOiq4sWutL9JVEHo7ypKt63t+3LCd8Wy7oMfnzE4ttCblhefPt+vpC7jOqvX/8Nq79yEV79reWCWi6o5QIt9/1YNle/lG/xel3oJ1w0EkCX2b9FVzmfUVdPmAElHyrZnJJ6gveoZB11LF6jfYDzqCiXxq2mXBDTqvhJf6AMXA05T833E4C6B9QFp149WnPUEsBjOSdoapz6byCqv2oS6jGX7e7Ai8Ob6o1yEDSgNz2PMwRfgga6wDuPC5hGl+AjgiEjpxDOQP24JQgbF4YNFwTVcSlHLRs01a7j3+WYrB4PAr560FeH00rW6Uo9/bRsm52r29Sf7xCrFmy4zTWcNuabtuAQst0xtmzPNCYsaIyjlDTm2KZjAbTFhRZtyzQFh4HNhTtpyjVNwdCxWfYpU37HVghtcSmPtNWJCBhe9unwWidHY5hB6JNz2idoqBtcwobWuIHGWTONwUh1TkcqMmZGl4Ad5ozrsG6syqUL6H5uamCsmWEhYIg5p0MMGfOEbViDw8g5PYyQNTPM8HzCD6QNyrYgKURsRFHvi4HpD4RlyFKfFuohgDUeGTAlCTYl1U8eg4QN9Sw2x+aGmg/UfDYQmvfswVwIUrrPoenzGUHb4OiqF2LsIJO6T9U5i3f6nMWjGQe4zHJ6fDoTdBHMFYJjtnm6GOjBKBKcw/dZnugji46KLsgAHuepfqPoqBOA+I+4cS517uqjs+P66GwY9dBd3sIqLpKiOU9qW58nBZwHw9rlIkOaeazPGwOagCCXG8FSk8AEPe1ysS8198fTxoAyaLfLsVspl2hdBhvao1Ydh5fr4/Di5pQ+EJaAbJcLEsZOXJT6WD1gDYSB20PiX9WpXKAxYKLwetxg22GDbrTrNbfTw8WJhthg0NvNoO8Jp7I+FRvEMxy2PY6oR6tgRwBgl8tQSk3u78zVrw3ikF2dSF191m1WH1cKyAPQ7MRfvcQFph2AGXEd9FjK+GlOGASAIBu7LKDWbc55Bo0F8c8uqNXRVGVzNBWYBkBLPa6T06IAp6sDYuFUzykbL9+DmQu4HXKBvknvjp+lWCf38WGDsy3wP+RiCxlJvq42h0JmzPqTHcAWIDDkCGxekgVqYMBG3EhH77kCXZBzIm7lVekS+9EAjPSQ6/9t/PUOncQFyAcMeFyDpf6mPVYN6AJsj0vWUndfnVu3qc+tA8MbhLzHRW17ThIABtnE5yan+t0muvITwWWMxba7efvjvnrrB+jD9bLgWOugwt2E4Bqs3jqHb+GB9AKzqMU1PNvFzYnEILsAh9ktVrYzk6gDAtvhwivbPbUHLwNVMJTYPUB1BBhgFqQTn0va1DAAkRRxYPBsCpCDAGTIQdavIAMqQOxHXMfUh+KDNA26ky0vVCcCgRQLY62pebKOZljZB34GLGKGp6IAxFnEhWn7kirwFNaIospTdY+OM4ALZGBIRlwaz9sv8hT1B3uAAcAjq67euWRSAlxyW7yF6ssDgFMwqNmCSmFuo9BOr0dJBUMR4+MKwXAB8eTzZspnM3+5IOg9Ln0Vj3GOSkC4BWiLwqXQ2gZb+7HQfpJtAjxcBQQ3iLeQC+7eM1FAzANGQpbGYmMU9mEncErHT+EAPVgLYl1HZ0OBdoNOC7jkUzZvtRoeByCdRFyH1y/wg8EF/bW4ppb5sxHoDuggtq5k3hWK4KKS7R30kSHQs3CS5Yhsz98EnoL84db3K3yuod1vqYFBCYbWQPVl5y4K3HHxRrrg8H7aKT34bTUQHyC2TlqAH74DXQk4Z0w8JXdd5+Ekfkrvrj2hGWQ1QKHHIlffNgFdDWDZOqrW6pZJbIDI3nvQukX95RigC3qavaHyhBeAcGBYZAs/ncsFxD7ZpDspdfvp+/f/A+hkXXGxcQAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8WdbXObSBKA/wv+qnOY4d3fnMRbmzrvJRcnu3elSqmwNJapSMACsp1L5b9fDSCpe+hGIFK7n1wJ/Tbz9AwzDYy+W0X2XFpX8+/W1yRdWVe+O7PSeKusK+s6z62ZtSs21pX1sEuXVZKl5avrPL98rLYba2YtN3FZqtK6sqwfM8LA3d0tbaO5MNTMrlxskrJS6aLMll9VtVhuslIRZmnBEW5atU22jDeLPCsq2klHbKiLtao+xEVVEmb3l3pNSc9ne+VgM0krVTzES9XtkDHGe62ea26xzNJKvVSLfsNHsX4XdhQITx7cfFTLbJ0m/1Oru6pI0vXBR/UtV+Ur8/Lg8P9Q93dsbxwungjVDQ/2SpWuTpu6aMWAvZmVx4VKKxQT42Stqte7hwdVqNX1NtulA4K/oHTOdD+siZNaiKcB3sle7kw3Ocwk3ksrdqaTcndfLovkfkh7oOyZ7nbpGIdY+kyXSXm3NzIkMwzx8wfBpyxPluWw5D/Inpsqu/tNUj4OyZaD5LnJnxVfh+R+I3Z+931U26xS16tVocqBvWiq/CTn1+Un9TJwFqMVzw/kc6mKt3EVD/MOpEe4BDecX6sq/6jKPEvpCQ5eH37byePdQHMXe1E6fBQe46xQ5W470NtB9nx3z0VSqbsqrnZkknZ9YoWJjn9V8UoVIxwfFCY6HuFykjPmbt511XdDH+joj6R6zHbV62z1bbBPrHO++6r4djO0qQfZ892xK5iut/5FzBBna1X9oRPh/cNDSS9lu147Oue7z1JtKb7fDGwwkp/i9vo+Kyp6zUF5PYpPccrdLCiPvbeKgWRP3qZJtsPu1OeEwN+sTwdy4n49MJwPRfaSqNV5HcMo//SARnZTr4kJ0xCzliRmob7l5BBXu3xdxKuBU8BReJzDzkrqz50qe3q5vjx8HbVW1akb/tHiBZTua0YTY0/6xEW8VdVwr1BhiuPPxWaoy0Z0irPfVPWY9czV2N9BeorLN3Gp7lRaJlXypMb5p1WnBPPvnSp6lj3Y/V74bIcPWXETL8n9asffUfZsd6Wq/puozbDuBcKjHFJ1u9fqMX5KMnLodIR6JwJhy2M5dxu/fIi/bbJ4davSddW/70fmLwjVE1vFQxuYYOoF4vv0dbz8muv7wq5Qt8k26d8w46B6TEwMbhu/3CYPqkroLSHfSUBrYgjJaqM+JVuV7cZ0Cdaaiijb1v2aZOkYKkhrOgiIdxwMQ3NiKLq8/SFJ1+X1rsq2cZUs482GnPuYiFgDEwPrWaMwkZxaqPS59j3POU5Zi4V+VjHe9WWj+A/hDw/ich820w9ZrsbkaSv+l/eA9rtvfjii9XW83DBRZRmvRw2Pg8Zf3gGt630fjMmAfdRMN6yKLM9PlOtxLEeNv7wbWtf7bnBHdMM+arYb4mTMSNjL/w1dECeHsSBHdYCOuG9lMXYZ8Xc0v3ncf1Ab2vgmXqbxJ5/+4RCGPQX8+U3Xfg/3AHtE4+uAubZn49qe/U1tz0Dbx2R9HTC3OmmePubVuMWaofaX9wX0f+iTMVMhagC9rbrO8/f1dbKedrw6fCP1VX1bPCQbtaj/fdrohalAtw4Eyk1tqqjGee5onO06Huk4/ilu87gs88cipmd00ymSPtfl6nGR61pUOa7BtNq5QZTlZrFM8kdVDMnaCyw+xWleqAdVLDbZ82KrtlnxbbHjlpZUELz6iKCOJZjb+nUwc/iqdLctX6Fr/YP3OBncvnv9+W5x++7u082/Fm9vfrn+fPvppN0LRotuEo75dBQ3/3lz+/nu3e83iw/vP44NpqM8LiY4T35S23wTV2oFX4IEuOH14dXn5oW+QfYuDrJ0I1CAve4WuzR5GeNzr3C+4zX9jLLrcN3zYHKIozyjnw10PbWS57vK+Ntm19tR+HyHK0XW7rvOGsEJnRhXdB2Z6MVWdIIzuoRHuOqp2g1x9KhicvPb9dRKnu9qmaWpWg5s11H4fIdVES/Ju1DX3V70fGdxShb2uq4awfMdPQ8cXM/TxlXPi35UFva/6zfEYbrbHt6HpFcwXb8dnQn8Vqs7VTyp4l/M4o0gaahMmMSyLVN/Ieaxvez57gq1zZ7U2OYSWueHsE3KMknXY2Og1M4P4iHZME+bu54PshMmQK7KREx/vQUmzhlYmf2221RJHhfVL9zjSCwxfCe7Yt77IexdrPre+zFCZNxxeynKXe8Gapg7rhhBuestwg1zp/d9Y1oI5Ee6Nb8kedM+czM3Ss2HJMbV3uxwjkbfvru7fn178/Zg7SkuEv2CW/lqf2moqbtfrz/evF28ef/bh483d3fvPxI2OzIjjb+9GWIeSg3uiJu3795cf0LBLZx/vqY6hhGd5Mod7sqd6Coc7iqc6Er4w31p2Wm05AhccqIzfwQwfyoxIUcwq4UnuZPeCGy18Hh3cIyeJteRnujwZF52pCc6PMXPFJ7o7lRymsIT3Y3C9xPojYI32Z0n5Ah/Wnqaw8G+KDdfZlaSrtSLdfXdelJF/YbOlSUvncvImlkPeo2hP63er9KW2Xar1yFf2mu/q2WVFVqiEXllW7O5PXO9SynCL19m871GfaH+j1pMWLO5oMQEEpPWbC4pMYnEHGs2dygxB4m51mzuUmIuEvOs2dyjxDwk5luzuU+J+UgssGbzgBILkFhozeYhJRYisciazSNKLMLdq3tbkByEAaImQaPALPRjybmQM9e+FAILYhpC97pwZo57KR2JJTEQ/VRvLlzKJEYidNcLEorAVPTLQ3NBchEYjNAABIlGYDZCMxAkHYHxCI1BRFSDMCCpKUibEJSYj9QQpKAEjaFSjxUKj8R4pGYgyeEiMR6pIUhyxEjMR2oIkuQjMR+pIUiSj8R8pIYgST4S85EagiT5SMxHagqSHEASA3JsLtsdDMjRGBxyqDmYkKM5OORQc4z5jB9BDkbkaA4OOUU6GJGjOTj0LIkROZqDQ2J3MCJHc3BI7A5G5IRcGjuYkBNxaexgQK7G4JCJ5GJCbk2ITCQXE3IlNypdDMit7zghJWjccmo+ZMK5mI+rIbhkHrmYj6shuGQeuZiPqyG4ZHa4mI+rKbhkdrgYkKsxuPRtFBPyNAaXvpNiQp7G4JIsPUzI0xxckqWHEXkahEtOCh5m5NXrApKRZ6wM6qUBycjDjDwNwiMZeZiRp0F4JCMPM/I0CI9k5GFGngbhkYw8zMjXIDySkY8Z+YJLeR8j8jUHz59J/zLwsSAm5GsMHsnSx4R8lzWJAfk1IBK6b6zefNYk5uPXfMjs8DEfP2RNYjy+ZuCTaeRjPIHNmQwwnUCwd4wA4wlYPAHGEzjc4izAdAKWToDpBBqBTw6KANMJWDqBsbrWCHxy9ASYTsDSCTCdoKZDDrMA0wk1A58cZiHGE2oGPjnMQown1BB8cioMMZ9QU/DJ4RNiQKHG4NO7C0worAmRyR5iQqHmEJA5HGJEYb0DIqmHxh5IgwhImCFmFGoQAckoxIwiDSIgGUWYUaRBBCSjCDOKNIiAZBRhRpEGEZCMIswo0iACklGEGUUaREBvAjGjSIMISUYRZhRpECHJKMKMonqjSjKKjK2qBhGSjCJzt6pJhCSk5hqU1SxCeitoGztWW9MI6c2gbWxabc0jpLeDtrFttV12m2cbG1dbIwnpvaNtbF3tmhdJtrkGZTWWiNnhG9tXW4OJ6D2+bWxg7brCQPJtrgHZupQQkYRFp8zA36CEWWio6wkRnQ5mraGuKER0OpjVhrqoENHpYBYc6rJCRKeDWXKoCwsRzdgsOtSlhYhmbJYdmrqDTUM2Kw9N6cFmKjkGOdnUh2jMRgVC1IUGYdOcpVkkqqtENg3PqESIut4gbJqeUYwQdclB2DQ+ox4h6qqDsGl+RklC1IUHYdMAjaqEqGsPwqYJGoUJUZcfBFOIM2oToq5ACKYWZ5QnRFOfEDRBo0QhnKbIRxM0qhSirkUIQRN0zFJfTZCpzBm1ClFXJARTnDPKFaIuSgimPmdULERdlxBMia4tWtSV7ielD0Z511S85/PDxwnfrUVbBj++YvHd8qV19f3HzPLd9q/f/g2bv4Hd/m3lglYuaOWCWu7HsWyu/6Vji1ersn7DpfYEvIfR0bue8xl1/YYZUPKhkuSU9Bu8RyX7qGPzGocXOI+KvnPUDCJGFb/pD5RBqCEXqfl9AlD3gLrg1JtXa45aAkQsnAaN0/4NRPNX34R6zGXpPfhweNN8UQ6SBvSm53GG4EfQQBdE53EJs9cleEQwZUTAGmhftwRp48K04ZKgOS7lqCVBU2Wb/y5Hsnk9CMTqwVgdTkutkqV++2lxaHahH1N/vUdUbdhwyTWcNuabtuAQku4YW9IzjQkbGuOQksYcaQYWQFtcatG2TFNwGEgu3UlTrmkKpo5k6VOm/I6tENripjzSVicjYHrJ0+m1UkdjmCCMyTkdEzTUTS4hoTVuoHHWTGMwU53TmYqMmdklYIc54zqsm6tCwO7nbg2MNTMtBEwx53SKIWOekIY1OIyc08MIWTPTDN9P+IG0QbMtmBQiNqOo78XA7Q+kZciiT0r9EsAKjww4JQl2SmrfPAYTNtSz2Tm2MNR8oOazibD/zh7cC8GU7nPe6vMZQdvg6GoXYuwgU+nquTln8b4+Z/FoxgEhs0yPb2eCLoJzheDI7t8uBnowiwQX8ENWqPrIoqOiC2YAj4u0/qLoqBOA/I+4cb5W1X17dHbcHp0Nsx6Gy1tYxqUq9+dJbdvzpEDwYFi7XGasVfXYnjcGNAEglxvBa1URPkFPu1zur1WVH08bA8qg3S5Ht1Gu0LoMNrRHrTkOr6iPw4v3p/SBtASwXS5JGDtxWdXH6gFrIA3cHoh/NqdygcaAG4XXEwbbDgm6UbZrbqeHxYmGSDDo5X7Q96RT1Z6KDfIZDtueQPSrVbAjgGOXm6G0WqkKc/UrQR6yq5O1quqzbrP2uFIAD7hmb/zNR1zgtgN8RlwHPVZVXuxPGAQOwWzssg5r3f05z6CxIP/ZBbU+mqraH00FbgOgpR7XyUlZgtPVAVh4q+eUjY/vwZ0LhB1yib5J7o8/S7FSD/Fug2dbEH/I5RYyol6Wm12ZPKn2JzuALQAw5ADuP5IFamDARtxIR9+5Al0w50TcyqvRJfajARjpIdf/2/jlHp3EBeADAh7X4G38sjkcqwZ0gW+Pm6y38UvenFu3ac+tA8MbpLzHZe3hnCTgGMwmPndzar9tois/EVzG2Gy7919/PDRf/QB9uF4WHLWOV7ibEFyD9Vfn8Cs8ML3AWdTmGp6l8f5EYjC7gIDZLVaWmpOoAxLb4dIrS58PBy8DVTCU2D1AcwQYIAumE5+btKlhADIp4pzBsynAHARchpzL9hNkgALkfsR1THsoPpimQXey5YXmRCAwxcJc29c82UAzrOyDOAPWY4ZvRQHIs4hL08NHqiBSWCOKmkj1MzrOAC6QgSEZcdN4cfhFnrL9wR5gAHBk1fU3l8yUAJfcNm+h+eUBwBQMaragUprbKLTT61HSyVDG+LhCMFxAPvm8meqbOX+5IOk9bvoqH+MClYBwC9AWhZtCWxts7cdG+0m2CfBwFZDcIN9CLrl7z0QBOQ+IhCzGcmMU9mEncErHn8IBerAWxIaOzoYC7QadFnCTT7X/qtWIOADTScR1ePsBPxhcMF6ba2pVfDMS3QEdxNaVzKdCEVxUsr2DfmQI9Cy8yXIgD+dvgkjB/OG2zyt8rqHd31IDgxIMrYHqi85TFLjj4o10ncPnaaf04G+rgfwAuXXSAvzhO9CVgDlj4lndd4OHN/FTeveHE5rBrAYQeqzn5rdNQFcDt2wdtdbqlkkk8Mg+e6h1y/aXY4Au6Gn2gcozXgDCgWGTLfwys/IkV5skVdbV/MuPH/8H6GRdcbFxAAA="; \ No newline at end of file diff --git a/docs/generated/enums/ListenOptions.html b/docs/generated/enums/ListenOptions.html index ea832d11..b666ec53 100644 --- a/docs/generated/enums/ListenOptions.html +++ b/docs/generated/enums/ListenOptions.html @@ -1,3 +1,3 @@ -ListenOptions | uWebSockets.js v20.40.0 documentation

Enumeration ListenOptions

Enumeration Members

LIBUS_LISTEN_DEFAULT +ListenOptions | uWebSockets.js v20.46.0 documentation

Enumeration ListenOptions

Enumeration Members

LIBUS_LISTEN_DEFAULT LIBUS_LISTEN_EXCLUSIVE_PORT -

Enumeration Members

LIBUS_LISTEN_DEFAULT

LIBUS_LISTEN_DEFAULT: 0

LIBUS_LISTEN_EXCLUSIVE_PORT

LIBUS_LISTEN_EXCLUSIVE_PORT: 1

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

LIBUS_LISTEN_DEFAULT

LIBUS_LISTEN_DEFAULT: 0

LIBUS_LISTEN_EXCLUSIVE_PORT

LIBUS_LISTEN_EXCLUSIVE_PORT: 1

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/functions/App.html b/docs/generated/functions/App.html index 9bbaed79..b171434e 100644 --- a/docs/generated/functions/App.html +++ b/docs/generated/functions/App.html @@ -1,3 +1,3 @@ -App | uWebSockets.js v20.40.0 documentation

Function App

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/functions/SSLApp.html b/docs/generated/functions/SSLApp.html index 46e0f872..beda7261 100644 --- a/docs/generated/functions/SSLApp.html +++ b/docs/generated/functions/SSLApp.html @@ -1,2 +1,2 @@ -SSLApp | uWebSockets.js v20.40.0 documentation

Function SSLApp

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +SSLApp | uWebSockets.js v20.46.0 documentation

Function SSLApp

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/functions/getParts.html b/docs/generated/functions/getParts.html index 7eff6e55..681140f4 100644 --- a/docs/generated/functions/getParts.html +++ b/docs/generated/functions/getParts.html @@ -1,2 +1,2 @@ -getParts | uWebSockets.js v20.40.0 documentation

Function getParts

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +getParts | uWebSockets.js v20.46.0 documentation

Function getParts

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/functions/us_listen_socket_close.html b/docs/generated/functions/us_listen_socket_close.html index 8b0ad64f..a00f3076 100644 --- a/docs/generated/functions/us_listen_socket_close.html +++ b/docs/generated/functions/us_listen_socket_close.html @@ -1,2 +1,2 @@ -us_listen_socket_close | uWebSockets.js v20.40.0 documentation

Function us_listen_socket_close

  • us_listen_socket_close(listenSocket): void

  • Closes a uSockets listen socket.

    -

    Parameters

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +us_listen_socket_close | uWebSockets.js v20.46.0 documentation

Function us_listen_socket_close

  • us_listen_socket_close(listenSocket): void

  • Closes a uSockets listen socket.

    +

    Parameters

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/functions/us_socket_local_port.html b/docs/generated/functions/us_socket_local_port.html index c44ff0fe..59941b12 100644 --- a/docs/generated/functions/us_socket_local_port.html +++ b/docs/generated/functions/us_socket_local_port.html @@ -1,2 +1,2 @@ -us_socket_local_port | uWebSockets.js v20.40.0 documentation

Function us_socket_local_port

  • us_socket_local_port(socket): number

  • Gets local port of socket (or listenSocket) or -1.

    -

    Parameters

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +us_socket_local_port | uWebSockets.js v20.46.0 documentation

Function us_socket_local_port

  • us_socket_local_port(socket): number

  • Gets local port of socket (or listenSocket) or -1.

    +

    Parameters

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/index.html b/docs/generated/index.html index 850b7d8c..baa32342 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -1,4 +1,4 @@ -uWebSockets.js v20.40.0 documentation

uWebSockets.js v20.40.0 documentation

Index

Enumerations

ListenOptions +uWebSockets.js v20.46.0 documentation

uWebSockets.js v20.46.0 documentation

Index

Enumerations

ListenOptions

Interfaces

AppOptions HttpRequest HttpResponse @@ -35,4 +35,4 @@ getParts us_listen_socket_close us_socket_local_port -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/interfaces/AppOptions.html b/docs/generated/interfaces/AppOptions.html index bb9c6ef7..343bb386 100644 --- a/docs/generated/interfaces/AppOptions.html +++ b/docs/generated/interfaces/AppOptions.html @@ -1,4 +1,4 @@ -AppOptions | uWebSockets.js v20.40.0 documentation

Interface AppOptions

Options used when constructing an app. Especially for SSLApp. +AppOptions | uWebSockets.js v20.46.0 documentation

Interface AppOptions

Options used when constructing an app. Especially for SSLApp. These are options passed directly to uSockets, C layer.

interface AppOptions {
    ca_file_name?: RecognizedString;
    cert_file_name?: RecognizedString;
    dh_params_file_name?: RecognizedString;
    key_file_name?: RecognizedString;
    passphrase?: RecognizedString;
    ssl_ciphers?: RecognizedString;
    ssl_prefer_low_memory_usage?: boolean;
}

Properties

ca_file_name? cert_file_name? @@ -8,4 +8,4 @@ These are options passed directly to uSockets, C layer.

ssl_ciphers? ssl_prefer_low_memory_usage?

Properties

Optional ca_file_name

ca_file_name?: RecognizedString

Optional cert_file_name

cert_file_name?: RecognizedString

Optional dh_params_file_name

dh_params_file_name?: RecognizedString

Optional key_file_name

key_file_name?: RecognizedString

Optional passphrase

passphrase?: RecognizedString

Optional ssl_ciphers

ssl_ciphers?: RecognizedString

Optional ssl_prefer_low_memory_usage

ssl_prefer_low_memory_usage?: boolean

This translates to SSL_MODE_RELEASE_BUFFERS

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/interfaces/HttpRequest.html b/docs/generated/interfaces/HttpRequest.html index 684a8466..b1f01f17 100644 --- a/docs/generated/interfaces/HttpRequest.html +++ b/docs/generated/interfaces/HttpRequest.html @@ -1,4 +1,4 @@ -HttpRequest | uWebSockets.js v20.40.0 documentation

Interface HttpRequest

An HttpRequest is stack allocated and only accessible during the callback invocation.

+HttpRequest | uWebSockets.js v20.46.0 documentation

Interface HttpRequest

An HttpRequest is stack allocated and only accessible during the callback invocation.

interface HttpRequest {
    forEach(cb): void;
    getCaseSensitiveMethod(): string;
    getHeader(lowerCaseKey): string;
    getMethod(): string;
    getParameter(index): string;
    getQuery(): string;
    getQuery(key): string;
    getUrl(): string;
    setYield(_yield): HttpRequest;
}

Methods

forEach getCaseSensitiveMethod getHeader @@ -11,9 +11,9 @@

Parameters

  • cb: ((key, value) => void)
      • (key, value): void

      • Parameters

        • key: string
        • value: string

        Returns void

Returns void

getCaseSensitiveMethod

  • getCaseSensitiveMethod(): string

  • Returns the HTTP method as-is.

    Returns string

getHeader

  • getHeader(lowerCaseKey): string

  • Returns the lowercased header value or empty string.

    Parameters

    Returns string

getMethod

  • getMethod(): string

  • Returns the lowercased HTTP method, useful for "any" routes.

    -

    Returns string

getParameter

  • getParameter(index): string

  • Returns the parsed parameter at index. Corresponds to route.

    -

    Parameters

    • index: number

    Returns string

getQuery

  • getQuery(): string

  • Returns the raw querystring (the part of URL after ? sign) or empty string.

    +

    Returns string

getParameter

  • getParameter(index): string

  • Returns the parsed parameter at index. Corresponds to route. Can also take the name of the parameter.

    +

    Parameters

    Returns string

getQuery

  • getQuery(): string

  • Returns the raw querystring (the part of URL after ? sign) or empty string.

    Returns string

  • getQuery(key): string

  • Returns a decoded query parameter value or undefined.

    Parameters

    • key: string

    Returns string

getUrl

  • getUrl(): string

  • Returns the URL including initial /slash

    Returns string

setYield

  • setYield(_yield): HttpRequest

  • Setting yield to true is to say that this route handler did not handle the route, causing the router to continue looking for a matching route handler, or fail.

    -

    Parameters

    • _yield: boolean

    Returns HttpRequest

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • _yield: boolean

Returns HttpRequest

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/interfaces/HttpResponse.html b/docs/generated/interfaces/HttpResponse.html index 231f32c7..93e21973 100644 --- a/docs/generated/interfaces/HttpResponse.html +++ b/docs/generated/interfaces/HttpResponse.html @@ -1,4 +1,4 @@ -HttpResponse | uWebSockets.js v20.40.0 documentation

Interface HttpResponse

An HttpResponse is valid until either onAborted callback or any of the .end/.tryEnd calls succeed. You may attach user data to this object.

+HttpResponse | uWebSockets.js v20.46.0 documentation

Interface HttpResponse

An HttpResponse is valid until either onAborted callback or any of the .end/.tryEnd calls succeed. You may attach user data to this object.

interface HttpResponse {
    close(): HttpResponse;
    cork(cb): HttpResponse;
    end(body?, closeConnection?): HttpResponse;
    endWithoutBody(reportedContentLength?, closeConnection?): HttpResponse;
    getProxiedRemoteAddress(): ArrayBuffer;
    getProxiedRemoteAddressAsText(): ArrayBuffer;
    getRemoteAddress(): ArrayBuffer;
    getRemoteAddressAsText(): ArrayBuffer;
    getWriteOffset(): number;
    onAborted(handler): HttpResponse;
    onData(handler): HttpResponse;
    onWritable(handler): HttpResponse;
    pause(): void;
    resume(): void;
    tryEnd(fullBodyOrChunk, totalSize): [boolean, boolean];
    upgrade<UserData>(userData, secWebSocketKey, secWebSocketProtocol, secWebSocketExtensions, context): void;
    write(chunk): boolean;
    writeHeader(key, value): HttpResponse;
    writeStatus(status): HttpResponse;
    [key: string]: any;
}

Indexable

[key: string]: any

Arbitrary user data may be attached to this object

Methods

close cork @@ -51,4 +51,4 @@ Writing nothing is always success, so by default you must return true.

Type Parameters

  • UserData

Parameters

Returns void

write

  • write(chunk): boolean

  • Enters or continues chunked encoding mode. Writes part of the response. End with zero length write. Returns true if no backpressure was added.

    Parameters

    Returns boolean

writeHeader

writeStatus

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns HttpResponse

writeStatus

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/interfaces/MultipartField.html b/docs/generated/interfaces/MultipartField.html index 724b243f..9a7ff536 100644 --- a/docs/generated/interfaces/MultipartField.html +++ b/docs/generated/interfaces/MultipartField.html @@ -1,5 +1,5 @@ -MultipartField | uWebSockets.js v20.40.0 documentation

Interface MultipartField

interface MultipartField {
    data: ArrayBuffer;
    filename?: string;
    name: string;
    type?: string;
}

Properties

data +MultipartField | uWebSockets.js v20.46.0 documentation

Interface MultipartField

interface MultipartField {
    data: ArrayBuffer;
    filename?: string;
    name: string;
    type?: string;
}

Properties

data filename? name type? -

Properties

data

data: ArrayBuffer

Optional filename

filename?: string

name

name: string

Optional type

type?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

data

data: ArrayBuffer

Optional filename

filename?: string

name

name: string

Optional type

type?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/interfaces/TemplatedApp.html b/docs/generated/interfaces/TemplatedApp.html index 7777fbb3..794f7571 100644 --- a/docs/generated/interfaces/TemplatedApp.html +++ b/docs/generated/interfaces/TemplatedApp.html @@ -1,4 +1,4 @@ -TemplatedApp | uWebSockets.js v20.40.0 documentation

Interface TemplatedApp

TemplatedApp is either an SSL or non-SSL app. See App for more info, read user manual.

+TemplatedApp | uWebSockets.js v20.46.0 documentation

Interface TemplatedApp

TemplatedApp is either an SSL or non-SSL app. See App for more info, read user manual.

interface TemplatedApp {
    addServerName(hostname, options): TemplatedApp;
    any(pattern, handler): TemplatedApp;
    close(): TemplatedApp;
    connect(pattern, handler): TemplatedApp;
    del(pattern, handler): TemplatedApp;
    domain(domain): TemplatedApp;
    filter(cb): TemplatedApp;
    get(pattern, handler): TemplatedApp;
    head(pattern, handler): TemplatedApp;
    listen(host, port, cb): TemplatedApp;
    listen(port, cb): TemplatedApp;
    listen(port, options, cb): TemplatedApp;
    listen_unix(cb, path): TemplatedApp;
    missingServerName(cb): TemplatedApp;
    numSubscribers(topic): number;
    options(pattern, handler): TemplatedApp;
    patch(pattern, handler): TemplatedApp;
    post(pattern, handler): TemplatedApp;
    publish(topic, message, isBinary?, compress?): boolean;
    put(pattern, handler): TemplatedApp;
    removeServerName(hostname): TemplatedApp;
    trace(pattern, handler): TemplatedApp;
    ws<UserData>(pattern, behavior): TemplatedApp;
}

Methods

addServerName any close @@ -43,4 +43,4 @@

Parameters

Returns TemplatedApp

removeServerName

trace

ws

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

  • UserData

Parameters

Returns TemplatedApp

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/interfaces/WebSocket.html b/docs/generated/interfaces/WebSocket.html index ed343924..c17ebec3 100644 --- a/docs/generated/interfaces/WebSocket.html +++ b/docs/generated/interfaces/WebSocket.html @@ -1,4 +1,4 @@ -WebSocket | uWebSockets.js v20.40.0 documentation

Interface WebSocket<UserData>

A WebSocket connection that is valid from open to close event. +WebSocket | uWebSockets.js v20.46.0 documentation

Interface WebSocket<UserData>

A WebSocket connection that is valid from open to close event. Read more about this in the user manual.

interface WebSocket<UserData> {
    close(): void;
    cork(cb): WebSocket<UserData>;
    end(code?, shortMessage?): void;
    getBufferedAmount(): number;
    getRemoteAddress(): ArrayBuffer;
    getRemoteAddressAsText(): ArrayBuffer;
    getTopics(): string[];
    getUserData(): UserData;
    isSubscribed(topic): boolean;
    ping(message?): number;
    publish(topic, message, isBinary?, compress?): boolean;
    send(message, isBinary?, compress?): number;
    subscribe(topic): boolean;
    unsubscribe(topic): boolean;
}

Type Parameters

  • UserData

Methods

close cork @@ -36,4 +36,4 @@ Order is guaranteed since v20.

Make sure you properly understand the concept of backpressure. Check the backpressure example file.

Parameters

Returns number

subscribe

unsubscribe

  • unsubscribe(topic): boolean

  • Unsubscribe from a topic. Returns true on success, if the WebSocket was subscribed.

    -

    Parameters

    Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/interfaces/WebSocketBehavior.html b/docs/generated/interfaces/WebSocketBehavior.html index c3683858..16ef724d 100644 --- a/docs/generated/interfaces/WebSocketBehavior.html +++ b/docs/generated/interfaces/WebSocketBehavior.html @@ -1,5 +1,5 @@ -WebSocketBehavior | uWebSockets.js v20.40.0 documentation

Interface WebSocketBehavior<UserData>

A structure holding settings and handlers for a WebSocket URL route handler.

-
interface WebSocketBehavior<UserData> {
    close?: ((ws, code, message) => void);
    closeOnBackpressureLimit?: number;
    compression?: number;
    drain?: ((ws) => void);
    dropped?: ((ws, message, isBinary) => void | Promise<void>);
    idleTimeout?: number;
    maxBackpressure?: number;
    maxLifetime?: number;
    maxPayloadLength?: number;
    message?: ((ws, message, isBinary) => void | Promise<void>);
    open?: ((ws) => void | Promise<void>);
    ping?: ((ws, message) => void);
    pong?: ((ws, message) => void);
    sendPingsAutomatically?: boolean;
    subscription?: ((ws, topic, newCount, oldCount) => void);
    upgrade?: ((res, req, context) => void | Promise<void>);
}

Type Parameters

  • UserData

Properties

close? +WebSocketBehavior | uWebSockets.js v20.46.0 documentation

Interface WebSocketBehavior<UserData>

A structure holding settings and handlers for a WebSocket URL route handler.

+
interface WebSocketBehavior<UserData> {
    close?: ((ws, code, message) => void);
    closeOnBackpressureLimit?: boolean;
    compression?: number;
    drain?: ((ws) => void);
    dropped?: ((ws, message, isBinary) => void | Promise<void>);
    idleTimeout?: number;
    maxBackpressure?: number;
    maxLifetime?: number;
    maxPayloadLength?: number;
    message?: ((ws, message, isBinary) => void | Promise<void>);
    open?: ((ws) => void | Promise<void>);
    ping?: ((ws, message) => void);
    pong?: ((ws, message) => void);
    sendPingsAutomatically?: boolean;
    subscription?: ((ws, topic, newCount, oldCount) => void);
    upgrade?: ((res, req, context) => void | Promise<void>);
}

Type Parameters

  • UserData

Properties

close? closeOnBackpressureLimit? compression? drain? @@ -17,7 +17,7 @@ upgrade?

Properties

Optional close

close?: ((ws, code, message) => void)

Handler for close event, no matter if error, timeout or graceful close. You may not use WebSocket after this event. Do not send on this WebSocket from within here, it is closed.

Type declaration

    • (ws, code, message): void

    • Handler for close event, no matter if error, timeout or graceful close. You may not use WebSocket after this event. Do not send on this WebSocket from within here, it is closed.

      -

      Parameters

      Returns void

Optional closeOnBackpressureLimit

closeOnBackpressureLimit?: number

Whether or not we should automatically close the socket when a message is dropped due to backpressure. Defaults to false.

+

Parameters

Returns void

Optional closeOnBackpressureLimit

closeOnBackpressureLimit?: boolean

Whether or not we should automatically close the socket when a message is dropped due to backpressure. Defaults to false.

Optional compression

compression?: number

What permessage-deflate compression to use. uWS.DISABLED, uWS.SHARED_COMPRESSOR or any of the uWS.DEDICATED_COMPRESSOR_xxxKB. Defaults to uWS.DISABLED.

Optional drain

drain?: ((ws) => void)

Handler for when WebSocket backpressure drains. Check ws.getBufferedAmount(). Use this to guide / drive your backpressure throttling.

Type declaration

    • (ws): void

    • Handler for when WebSocket backpressure drains. Check ws.getBufferedAmount(). Use this to guide / drive your backpressure throttling.

      @@ -43,4 +43,4 @@ Disable by using 0. Defaults to 120.

      See UpgradeAsync and UpgradeSync example files.

      Type declaration

        • (res, req, context): void | Promise<void>

        • Upgrade handler used to intercept HTTP upgrade requests and potentially upgrade to WebSocket. See UpgradeAsync and UpgradeSync example files.

          -

          Parameters

          Returns void | Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void | Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/interfaces/us_listen_socket.html b/docs/generated/interfaces/us_listen_socket.html index 3b388ed0..0183f57e 100644 --- a/docs/generated/interfaces/us_listen_socket.html +++ b/docs/generated/interfaces/us_listen_socket.html @@ -1,3 +1,3 @@ -us_listen_socket | uWebSockets.js v20.40.0 documentation

Interface us_listen_socket

Native type representing a raw uSockets struct us_listen_socket_t. +us_listen_socket | uWebSockets.js v20.46.0 documentation

Interface us_listen_socket

Native type representing a raw uSockets struct us_listen_socket_t. Careful with this one, it is entirely unchecked and native so invalid usage will blow up.

-
interface us_listen_socket {}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +
interface us_listen_socket {}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/interfaces/us_socket.html b/docs/generated/interfaces/us_socket.html index b19732d7..6f5faee7 100644 --- a/docs/generated/interfaces/us_socket.html +++ b/docs/generated/interfaces/us_socket.html @@ -1,3 +1,3 @@ -us_socket | uWebSockets.js v20.40.0 documentation

Interface us_socket

Native type representing a raw uSockets struct us_socket_t. +us_socket | uWebSockets.js v20.46.0 documentation

Interface us_socket

Native type representing a raw uSockets struct us_socket_t. Careful with this one, it is entirely unchecked and native so invalid usage will blow up.

-
interface us_socket {}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +
interface us_socket {}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/interfaces/us_socket_context_t.html b/docs/generated/interfaces/us_socket_context_t.html index ff932060..085ab39f 100644 --- a/docs/generated/interfaces/us_socket_context_t.html +++ b/docs/generated/interfaces/us_socket_context_t.html @@ -1,3 +1,3 @@ -us_socket_context_t | uWebSockets.js v20.40.0 documentation

Interface us_socket_context_t

Native type representing a raw uSockets struct us_socket_context_t. +us_socket_context_t | uWebSockets.js v20.46.0 documentation

Interface us_socket_context_t

Native type representing a raw uSockets struct us_socket_context_t. Used while upgrading a WebSocket manually.

-
interface us_socket_context_t {}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +
interface us_socket_context_t {}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/types/CompressOptions.html b/docs/generated/types/CompressOptions.html index 37f3162e..ffccb6ff 100644 --- a/docs/generated/types/CompressOptions.html +++ b/docs/generated/types/CompressOptions.html @@ -1,2 +1,2 @@ -CompressOptions | uWebSockets.js v20.40.0 documentation

Type alias CompressOptions

CompressOptions: number

WebSocket compression options. Combine any compressor with any decompressor using bitwise OR.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +CompressOptions | uWebSockets.js v20.46.0 documentation

Type alias CompressOptions

CompressOptions: number

WebSocket compression options. Combine any compressor with any decompressor using bitwise OR.

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/types/RecognizedString.html b/docs/generated/types/RecognizedString.html index c751e407..f2ba392d 100644 --- a/docs/generated/types/RecognizedString.html +++ b/docs/generated/types/RecognizedString.html @@ -1,7 +1,7 @@ -RecognizedString | uWebSockets.js v20.40.0 documentation

Type alias RecognizedString

RecognizedString: string | ArrayBuffer | Uint8Array | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array | Float32Array | Float64Array

Recognized string types, things C++ can read and understand as strings. +RecognizedString | uWebSockets.js v20.46.0 documentation

Type alias RecognizedString

RecognizedString: string | ArrayBuffer | Uint8Array | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array | Float32Array | Float64Array

Recognized string types, things C++ can read and understand as strings. "String" does not have to mean "text", it can also be "binary".

Ironically, JavaScript strings are the least performant of all options, to pass or receive to/from C++. This because we expect UTF-8, which is packed in 8-byte chars. JavaScript strings are UTF-16 internally meaning extra copies and reinterpretation are required.

That's why all events pass data by ArrayBuffer and not JavaScript strings, as they allow zero-copy data passing.

You can always do Buffer.from(arrayBuffer).toString(), but keeping things binary and as ArrayBuffer is preferred.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DEDICATED_COMPRESSOR_128KB.html b/docs/generated/variables/DEDICATED_COMPRESSOR_128KB.html index e0dc16e4..6e1f8fd9 100644 --- a/docs/generated/variables/DEDICATED_COMPRESSOR_128KB.html +++ b/docs/generated/variables/DEDICATED_COMPRESSOR_128KB.html @@ -1,2 +1,2 @@ -DEDICATED_COMPRESSOR_128KB | uWebSockets.js v20.40.0 documentation

Variable DEDICATED_COMPRESSOR_128KB

DEDICATED_COMPRESSOR_128KB: CompressOptions

Sliding dedicated compress window, requires 128KB of memory per socket

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEDICATED_COMPRESSOR_128KB | uWebSockets.js v20.46.0 documentation

Variable DEDICATED_COMPRESSOR_128KB

DEDICATED_COMPRESSOR_128KB: CompressOptions

Sliding dedicated compress window, requires 128KB of memory per socket

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DEDICATED_COMPRESSOR_16KB.html b/docs/generated/variables/DEDICATED_COMPRESSOR_16KB.html index 02488769..16c377fe 100644 --- a/docs/generated/variables/DEDICATED_COMPRESSOR_16KB.html +++ b/docs/generated/variables/DEDICATED_COMPRESSOR_16KB.html @@ -1,2 +1,2 @@ -DEDICATED_COMPRESSOR_16KB | uWebSockets.js v20.40.0 documentation

Variable DEDICATED_COMPRESSOR_16KB

DEDICATED_COMPRESSOR_16KB: CompressOptions

Sliding dedicated compress window, requires 16KB of memory per socket

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEDICATED_COMPRESSOR_16KB | uWebSockets.js v20.46.0 documentation

Variable DEDICATED_COMPRESSOR_16KB

DEDICATED_COMPRESSOR_16KB: CompressOptions

Sliding dedicated compress window, requires 16KB of memory per socket

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DEDICATED_COMPRESSOR_256KB.html b/docs/generated/variables/DEDICATED_COMPRESSOR_256KB.html index 8051e6b3..85600379 100644 --- a/docs/generated/variables/DEDICATED_COMPRESSOR_256KB.html +++ b/docs/generated/variables/DEDICATED_COMPRESSOR_256KB.html @@ -1,2 +1,2 @@ -DEDICATED_COMPRESSOR_256KB | uWebSockets.js v20.40.0 documentation

Variable DEDICATED_COMPRESSOR_256KB

DEDICATED_COMPRESSOR_256KB: CompressOptions

Sliding dedicated compress window, requires 256KB of memory per socket

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEDICATED_COMPRESSOR_256KB | uWebSockets.js v20.46.0 documentation

Variable DEDICATED_COMPRESSOR_256KB

DEDICATED_COMPRESSOR_256KB: CompressOptions

Sliding dedicated compress window, requires 256KB of memory per socket

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DEDICATED_COMPRESSOR_32KB.html b/docs/generated/variables/DEDICATED_COMPRESSOR_32KB.html index a8ef7dd4..6b476242 100644 --- a/docs/generated/variables/DEDICATED_COMPRESSOR_32KB.html +++ b/docs/generated/variables/DEDICATED_COMPRESSOR_32KB.html @@ -1,2 +1,2 @@ -DEDICATED_COMPRESSOR_32KB | uWebSockets.js v20.40.0 documentation

Variable DEDICATED_COMPRESSOR_32KB

DEDICATED_COMPRESSOR_32KB: CompressOptions

Sliding dedicated compress window, requires 32KB of memory per socket

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEDICATED_COMPRESSOR_32KB | uWebSockets.js v20.46.0 documentation

Variable DEDICATED_COMPRESSOR_32KB

DEDICATED_COMPRESSOR_32KB: CompressOptions

Sliding dedicated compress window, requires 32KB of memory per socket

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DEDICATED_COMPRESSOR_3KB.html b/docs/generated/variables/DEDICATED_COMPRESSOR_3KB.html index 5ffd3133..45937f4e 100644 --- a/docs/generated/variables/DEDICATED_COMPRESSOR_3KB.html +++ b/docs/generated/variables/DEDICATED_COMPRESSOR_3KB.html @@ -1,2 +1,2 @@ -DEDICATED_COMPRESSOR_3KB | uWebSockets.js v20.40.0 documentation

Variable DEDICATED_COMPRESSOR_3KB

DEDICATED_COMPRESSOR_3KB: CompressOptions

Sliding dedicated compress window, requires 3KB of memory per socket

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEDICATED_COMPRESSOR_3KB | uWebSockets.js v20.46.0 documentation

Variable DEDICATED_COMPRESSOR_3KB

DEDICATED_COMPRESSOR_3KB: CompressOptions

Sliding dedicated compress window, requires 3KB of memory per socket

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DEDICATED_COMPRESSOR_4KB.html b/docs/generated/variables/DEDICATED_COMPRESSOR_4KB.html index ecfe4afb..447899e8 100644 --- a/docs/generated/variables/DEDICATED_COMPRESSOR_4KB.html +++ b/docs/generated/variables/DEDICATED_COMPRESSOR_4KB.html @@ -1,2 +1,2 @@ -DEDICATED_COMPRESSOR_4KB | uWebSockets.js v20.40.0 documentation

Variable DEDICATED_COMPRESSOR_4KB

DEDICATED_COMPRESSOR_4KB: CompressOptions

Sliding dedicated compress window, requires 4KB of memory per socket

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEDICATED_COMPRESSOR_4KB | uWebSockets.js v20.46.0 documentation

Variable DEDICATED_COMPRESSOR_4KB

DEDICATED_COMPRESSOR_4KB: CompressOptions

Sliding dedicated compress window, requires 4KB of memory per socket

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DEDICATED_COMPRESSOR_64KB.html b/docs/generated/variables/DEDICATED_COMPRESSOR_64KB.html index d1e66e19..013f1aa4 100644 --- a/docs/generated/variables/DEDICATED_COMPRESSOR_64KB.html +++ b/docs/generated/variables/DEDICATED_COMPRESSOR_64KB.html @@ -1,2 +1,2 @@ -DEDICATED_COMPRESSOR_64KB | uWebSockets.js v20.40.0 documentation

Variable DEDICATED_COMPRESSOR_64KB

DEDICATED_COMPRESSOR_64KB: CompressOptions

Sliding dedicated compress window, requires 64KB of memory per socket

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEDICATED_COMPRESSOR_64KB | uWebSockets.js v20.46.0 documentation

Variable DEDICATED_COMPRESSOR_64KB

DEDICATED_COMPRESSOR_64KB: CompressOptions

Sliding dedicated compress window, requires 64KB of memory per socket

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DEDICATED_COMPRESSOR_8KB.html b/docs/generated/variables/DEDICATED_COMPRESSOR_8KB.html index c5af4df8..dd482051 100644 --- a/docs/generated/variables/DEDICATED_COMPRESSOR_8KB.html +++ b/docs/generated/variables/DEDICATED_COMPRESSOR_8KB.html @@ -1,2 +1,2 @@ -DEDICATED_COMPRESSOR_8KB | uWebSockets.js v20.40.0 documentation

Variable DEDICATED_COMPRESSOR_8KB

DEDICATED_COMPRESSOR_8KB: CompressOptions

Sliding dedicated compress window, requires 8KB of memory per socket

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEDICATED_COMPRESSOR_8KB | uWebSockets.js v20.46.0 documentation

Variable DEDICATED_COMPRESSOR_8KB

DEDICATED_COMPRESSOR_8KB: CompressOptions

Sliding dedicated compress window, requires 8KB of memory per socket

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DEDICATED_DECOMPRESSOR.html b/docs/generated/variables/DEDICATED_DECOMPRESSOR.html index b4409e49..01e08cbd 100644 --- a/docs/generated/variables/DEDICATED_DECOMPRESSOR.html +++ b/docs/generated/variables/DEDICATED_DECOMPRESSOR.html @@ -1,2 +1,2 @@ -DEDICATED_DECOMPRESSOR | uWebSockets.js v20.40.0 documentation

Variable DEDICATED_DECOMPRESSOR

DEDICATED_DECOMPRESSOR: CompressOptions

Sliding dedicated decompress window, requires 32KB of memory per socket (plus about 23KB)

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEDICATED_DECOMPRESSOR | uWebSockets.js v20.46.0 documentation

Variable DEDICATED_DECOMPRESSOR

DEDICATED_DECOMPRESSOR: CompressOptions

Sliding dedicated decompress window, requires 32KB of memory per socket (plus about 23KB)

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DEDICATED_DECOMPRESSOR_16KB.html b/docs/generated/variables/DEDICATED_DECOMPRESSOR_16KB.html index 648ad025..0947ccfe 100644 --- a/docs/generated/variables/DEDICATED_DECOMPRESSOR_16KB.html +++ b/docs/generated/variables/DEDICATED_DECOMPRESSOR_16KB.html @@ -1,2 +1,2 @@ -DEDICATED_DECOMPRESSOR_16KB | uWebSockets.js v20.40.0 documentation

Variable DEDICATED_DECOMPRESSOR_16KB

DEDICATED_DECOMPRESSOR_16KB: CompressOptions

Sliding dedicated decompress window, requires 16KB of memory per socket (plus about 23KB)

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEDICATED_DECOMPRESSOR_16KB | uWebSockets.js v20.46.0 documentation

Variable DEDICATED_DECOMPRESSOR_16KB

DEDICATED_DECOMPRESSOR_16KB: CompressOptions

Sliding dedicated decompress window, requires 16KB of memory per socket (plus about 23KB)

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DEDICATED_DECOMPRESSOR_1KB.html b/docs/generated/variables/DEDICATED_DECOMPRESSOR_1KB.html index 09967599..c5cec4d0 100644 --- a/docs/generated/variables/DEDICATED_DECOMPRESSOR_1KB.html +++ b/docs/generated/variables/DEDICATED_DECOMPRESSOR_1KB.html @@ -1,2 +1,2 @@ -DEDICATED_DECOMPRESSOR_1KB | uWebSockets.js v20.40.0 documentation

Variable DEDICATED_DECOMPRESSOR_1KB

DEDICATED_DECOMPRESSOR_1KB: CompressOptions

Sliding dedicated decompress window, requires 1KB of memory per socket (plus about 23KB)

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEDICATED_DECOMPRESSOR_1KB | uWebSockets.js v20.46.0 documentation

Variable DEDICATED_DECOMPRESSOR_1KB

DEDICATED_DECOMPRESSOR_1KB: CompressOptions

Sliding dedicated decompress window, requires 1KB of memory per socket (plus about 23KB)

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DEDICATED_DECOMPRESSOR_2KB.html b/docs/generated/variables/DEDICATED_DECOMPRESSOR_2KB.html index 4e5ba15c..eb575ae4 100644 --- a/docs/generated/variables/DEDICATED_DECOMPRESSOR_2KB.html +++ b/docs/generated/variables/DEDICATED_DECOMPRESSOR_2KB.html @@ -1,2 +1,2 @@ -DEDICATED_DECOMPRESSOR_2KB | uWebSockets.js v20.40.0 documentation

Variable DEDICATED_DECOMPRESSOR_2KB

DEDICATED_DECOMPRESSOR_2KB: CompressOptions

Sliding dedicated decompress window, requires 2KB of memory per socket (plus about 23KB)

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEDICATED_DECOMPRESSOR_2KB | uWebSockets.js v20.46.0 documentation

Variable DEDICATED_DECOMPRESSOR_2KB

DEDICATED_DECOMPRESSOR_2KB: CompressOptions

Sliding dedicated decompress window, requires 2KB of memory per socket (plus about 23KB)

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DEDICATED_DECOMPRESSOR_32KB.html b/docs/generated/variables/DEDICATED_DECOMPRESSOR_32KB.html index a76a0445..def62fc9 100644 --- a/docs/generated/variables/DEDICATED_DECOMPRESSOR_32KB.html +++ b/docs/generated/variables/DEDICATED_DECOMPRESSOR_32KB.html @@ -1,2 +1,2 @@ -DEDICATED_DECOMPRESSOR_32KB | uWebSockets.js v20.40.0 documentation

Variable DEDICATED_DECOMPRESSOR_32KB

DEDICATED_DECOMPRESSOR_32KB: CompressOptions

Sliding dedicated decompress window, requires 32KB of memory per socket (plus about 23KB)

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEDICATED_DECOMPRESSOR_32KB | uWebSockets.js v20.46.0 documentation

Variable DEDICATED_DECOMPRESSOR_32KB

DEDICATED_DECOMPRESSOR_32KB: CompressOptions

Sliding dedicated decompress window, requires 32KB of memory per socket (plus about 23KB)

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DEDICATED_DECOMPRESSOR_4KB.html b/docs/generated/variables/DEDICATED_DECOMPRESSOR_4KB.html index 53120f57..a0bb35b8 100644 --- a/docs/generated/variables/DEDICATED_DECOMPRESSOR_4KB.html +++ b/docs/generated/variables/DEDICATED_DECOMPRESSOR_4KB.html @@ -1,2 +1,2 @@ -DEDICATED_DECOMPRESSOR_4KB | uWebSockets.js v20.40.0 documentation

Variable DEDICATED_DECOMPRESSOR_4KB

DEDICATED_DECOMPRESSOR_4KB: CompressOptions

Sliding dedicated decompress window, requires 4KB of memory per socket (plus about 23KB)

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEDICATED_DECOMPRESSOR_4KB | uWebSockets.js v20.46.0 documentation

Variable DEDICATED_DECOMPRESSOR_4KB

DEDICATED_DECOMPRESSOR_4KB: CompressOptions

Sliding dedicated decompress window, requires 4KB of memory per socket (plus about 23KB)

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DEDICATED_DECOMPRESSOR_512B.html b/docs/generated/variables/DEDICATED_DECOMPRESSOR_512B.html index 2db85ba4..69bd38f0 100644 --- a/docs/generated/variables/DEDICATED_DECOMPRESSOR_512B.html +++ b/docs/generated/variables/DEDICATED_DECOMPRESSOR_512B.html @@ -1,2 +1,2 @@ -DEDICATED_DECOMPRESSOR_512B | uWebSockets.js v20.40.0 documentation

Variable DEDICATED_DECOMPRESSOR_512B

DEDICATED_DECOMPRESSOR_512B: CompressOptions

Sliding dedicated decompress window, requires 512B of memory per socket (plus about 23KB)

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEDICATED_DECOMPRESSOR_512B | uWebSockets.js v20.46.0 documentation

Variable DEDICATED_DECOMPRESSOR_512B

DEDICATED_DECOMPRESSOR_512B: CompressOptions

Sliding dedicated decompress window, requires 512B of memory per socket (plus about 23KB)

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DEDICATED_DECOMPRESSOR_8KB.html b/docs/generated/variables/DEDICATED_DECOMPRESSOR_8KB.html index 3a04cbeb..dfc7a88b 100644 --- a/docs/generated/variables/DEDICATED_DECOMPRESSOR_8KB.html +++ b/docs/generated/variables/DEDICATED_DECOMPRESSOR_8KB.html @@ -1,2 +1,2 @@ -DEDICATED_DECOMPRESSOR_8KB | uWebSockets.js v20.40.0 documentation

Variable DEDICATED_DECOMPRESSOR_8KB

DEDICATED_DECOMPRESSOR_8KB: CompressOptions

Sliding dedicated decompress window, requires 8KB of memory per socket (plus about 23KB)

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEDICATED_DECOMPRESSOR_8KB | uWebSockets.js v20.46.0 documentation

Variable DEDICATED_DECOMPRESSOR_8KB

DEDICATED_DECOMPRESSOR_8KB: CompressOptions

Sliding dedicated decompress window, requires 8KB of memory per socket (plus about 23KB)

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/DISABLED.html b/docs/generated/variables/DISABLED.html index a0a8a9a3..f6de228a 100644 --- a/docs/generated/variables/DISABLED.html +++ b/docs/generated/variables/DISABLED.html @@ -1,2 +1,2 @@ -DISABLED | uWebSockets.js v20.40.0 documentation

Variable DISABLED

DISABLED: CompressOptions

No compression (always a good idea if you operate using an efficient binary protocol)

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DISABLED | uWebSockets.js v20.46.0 documentation

Variable DISABLED

DISABLED: CompressOptions

No compression (always a good idea if you operate using an efficient binary protocol)

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/SHARED_COMPRESSOR.html b/docs/generated/variables/SHARED_COMPRESSOR.html index a8111489..3872d6a6 100644 --- a/docs/generated/variables/SHARED_COMPRESSOR.html +++ b/docs/generated/variables/SHARED_COMPRESSOR.html @@ -1,2 +1,2 @@ -SHARED_COMPRESSOR | uWebSockets.js v20.40.0 documentation

Variable SHARED_COMPRESSOR

SHARED_COMPRESSOR: CompressOptions

Zero memory overhead compression.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +SHARED_COMPRESSOR | uWebSockets.js v20.46.0 documentation

Variable SHARED_COMPRESSOR

SHARED_COMPRESSOR: CompressOptions

Zero memory overhead compression.

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/generated/variables/SHARED_DECOMPRESSOR.html b/docs/generated/variables/SHARED_DECOMPRESSOR.html index f4abc55b..195e6472 100644 --- a/docs/generated/variables/SHARED_DECOMPRESSOR.html +++ b/docs/generated/variables/SHARED_DECOMPRESSOR.html @@ -1,2 +1,2 @@ -SHARED_DECOMPRESSOR | uWebSockets.js v20.40.0 documentation

Variable SHARED_DECOMPRESSOR

SHARED_DECOMPRESSOR: CompressOptions

Zero memory overhead decompression.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +SHARED_DECOMPRESSOR | uWebSockets.js v20.46.0 documentation

Variable SHARED_DECOMPRESSOR

SHARED_DECOMPRESSOR: CompressOptions

Zero memory overhead decompression.

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/tsconfig.json b/docs/tsconfig.json index 84419550..5cbb0da7 100644 --- a/docs/tsconfig.json +++ b/docs/tsconfig.json @@ -1,7 +1,7 @@ { "files": [ "index.d.ts" ], "typedocOptions": { - "name":"uWebSockets.js v20.40.0 documentation", + "name":"uWebSockets.js v20.46.0 documentation", "entryPoints": [ "index.d.ts" ], "out":"generated", "excludeExternals":true,