diff --git a/docs/Next/assets/navigation.js b/docs/Next/assets/navigation.js index 716fb3ab6c..10904e6bfb 100644 --- a/docs/Next/assets/navigation.js +++ b/docs/Next/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA62d2XLjOpKGX2XCc3tqpqvOMt1157LlOmov8lh21UVHRwVEwhLGFKkBIR+rO+bdJ8AVSyIzSfedQvnj+0GQBEAs5N/+eWbkmzn7fPZFlUKfzn46OwizO/t8tq/yYyHr/9iZffHvQ/BFlfnZ518+/uWXn//0y//9NKZer+4e5HbxdkgRXAFGWZ/2m6pAKIMAozyeDhJhdOEU4aLKU6m7UCrl5ZcH+ZxI2seSaWWm9qL4+OnPKYArSFFyWUutRKH+kToEX5HMTZUd97I0qbyM4TThuClSmRiCqdTL0vz8KZG4j6XS3lTlNpG0C6VS3oq3a5m6C4ZgMrUqkdR9MJV6tfkfmZllnkjvhFME6sxzzvuj2svaiH3qRnbjKcbT0/IykbwLYfdulPI/7b9N8jHlT2dZIer67POZqfMPqv4g34zUpbCSbKeKXMvy7PPfktVbk7pHt0Hf4eOnP6c9ghwvtK50it3H5+NXz8+1NJSJo5pvFdbhkUsreIfBsTRqL6mDcWXzzcK2JLJpBfMNvoniKBF+E38HXupaVSVVWK5snpnf4HkGNjQPGrSFHrWJzcQCzaTPHgQzDYJ2y4c3wXngoEnzuE1sHtZv7TyqDc2Dhg2hh22DM8FBG+mDm+A8cNx8eug+PA8OtIoefYjPw/sNpke2oZk1SNOqLd6MLHPpFIsqjdTPIvNbv17ne3369bcZXjdyK7IT17FVz/QdmiTGcUbaf5UnebyJFPP924aLd8y+dp6nbQVoN1c1z6dpF27Ui0ybDJKZDkPrQB9PrJ3rOfS8VwejqrLGPEPtTM/o+S1y6hRz+bYhZJShp5vn1TSOtJUnm+dkG0zayFXN82lbUNrJ1830ahpVhpenm+fVt7K0W6h8nx9eZbiqeT5r9v0bKuf5Df0JuiAj6Xta8LX836MsM6cszengN9u9JLD501/+6+Ovn9gNmD9A55p0wffjH8UWdXgU23eYnIx8MqqoYYs+Ot/gQhTZsRBGthfvGrr2HMe0fH4WFn+1wwqIqSv419h8ETV8WYSid9rdC12j5Rmp3mmYrkBCU6ICmWBsm6nvyuyqo1m9Sq1VLmFfSDjf9u6430idvjmc+HyTVXkp96LMQYc+OB8/VKp4wcUywjKXBy0zYWT+b8TjYFzxO76uYP5Bbuqq9OvhV6GV2AxDrr3gw0ff5Oe59XzA7wUfPs3jx3VwaNArZh5Bc0Mm6U10Fhe64S6aZCmvZIpZ/uAtGjg6mpmlV0X3aGDRC2bys7jNG62ej2XW1J+tFaD1PX9DphSo6bXAy9G812NttBR7jlOrnOVHH9H7jmdIbS/gL8fnZ6nPy3xZ5vKNdozTzMyDWZbt3y0NvVpA9QTfvzvO55vaaJGZi6OuoWF8Px4N9bmkfK9KAGD/RtNtt1puhT2+ZCZCCcb7Iky2A4Yr7d9oumPxsjpI3dj4Pb2BEUoo3netjHyQ9bEwMM0RYKyLnSi30e3Wg9woSimULM2izPSp6bwBpEBB09ayrhFUF0Y5VVHILJGfIYYT9raevhKqkPni1RtWGkmhhkFcG6ENhXRFHOYxy6TMSaonw7ll2ZbRxU5mLzJflkk0rJxEXx0NF99LJ/BXR0OcRkQ+zYc6uZie6VRUNcdglDG5WgpWzh0dj3xfVcVFIYVm0EPtFAdWuQTSCXxm+YRavsNtVSpTaVVuWSaBnO/zIEV+YlmMSh6dR+ZRLzcx43KDpVi8HQqhStvZTrX5kQTjXakyT4HGGEVom/ZK1zBkCGOcr1rlV+svx+xFAiXrRrkUew5SLT+s45KbzgcH7Qgx9u9Vbc7zXMsaKEEniDFuVG3GVr9OnVRQRnGb/rlEmZ6E4q2l0NmOQQWEGPu2KrfV+f0ysbLGC9Oc72uU04Vpzj+OOrUwKhCQrKYv/iAXbzI7mvQSorSWduj71ijaE5FMt5uNYSMdTW76yilcE2QyhkNqrzI0m8kEU70muMzjc64TNA3TsettkC6OjiZX+4MwaqMKZU4oOhLSbC1zWRolCqDCDRUM2ulgmrv4+nb9YOfR6tSyTlzPc2p7XpfCCDuvS/nE6iku3ROtzMc2g+mYSslzJ00msJblqyhUfq63zboIEg3peU7j6byT5o9Kv9iJhOpIW6IJae+2BnrbiWNtiNsQkDL5y/KpxmusQEZyL7+M18ad2Mv6IDJg8CitZTjQ3Ak0mVX7g25HZrCSiIU0W6tXiTY7joKkYRwm4e2gtMzX9MECSpL+9eIeQ/ZhmtP0tS92x/IF5QUyJpfusUQ6kjyhMppVD11LvZG6qjGwpyGJt6quVbl1GkSMnVBzXS7lwc5+lhnasMFi0qOrWzGyK+HyGJX8nFr9rjLdeAJepUc6krxaXl5gxCFOk/oxfUYZgFrSoVmrgWFHAcnCN6lEEpK3lvpVarrvG+mYZJo5hbaWjA4cJKX5RhTyXqu9Xf2NwUMdTT7VRqI1sKMgaY9CFeOwGEYFlDS9OlRFtT3R1wOgpOlalLUgz18oI7lPpXw7NHVHe+ofZH2oSvyWQ9OQju1Dc1VmUqOHEukw8krnUsvcm2eMuZAKo9qRwS4HMcwJUox7LZ+l9hdgupgxjpKOZTfHlRoyCxUYzauU4OHsSELzLmWdaZWYJI0kk3jt6BCe14Sc9vldCm02UuCTaGntBAd8+gwRT/Eg5kpROe2zOsgyPYUTa2hicjbcC6OcphOOX3+hBOMFlTR8qICIw0RzCYgmMvE7hUjA8cLPP6RCqadD573YK2MkULFFEoz3VFas1gDWYWS3SYp5bpRLSTSAk9o+bCiZN3bsr1XC9kKAymCp6q+/AYuU0B0WoYgDHJY0ccChGDU4mh0MO5odlfBWZjtRqnp/r6uD1EbJRMZgLYGvxgVG6FFDShT9fQ2OiLtMT0LARvNreUJzCmsJ/PXt+l5XryqX+qIqn9X2GN7ivkVKj9o0k3Ls40ipMYsv6P6BYD8Quf8IWkA3VGpB7eCyYS0Tj+Q5EGFAd97PjvLeVjm6zRHRs23aWRG2iyefZtLMXk908tJw7S5lISccky9nm3T6cTTe3+SeMgOTTTfd7xO3eVo+1cR7jQHhEL3VgMYP9xnYCST8oMRTM/BdFIUdgmOb9gnYRro62PnGjagnXI1AokmGk4xmGEy7jaMUXKtlWUtt2D6+nG/SzCxMqQHjJFwzO7+29mfgEh6DkovGGiBAx8U+yGdVyrGqWu+Ezq/liV1YFICfkVLs+efIl/NNDoXIprh4er5NbUthLJQJhomUXOv1TONEOrbtoVDhku+U0yDlwp8Ok25fX46aoEuUXDy5QAkFo/cuKJ0AD3eOpNnQFhII3faWbkV5uq1yWSDoQMlFr0rJI/dCLpgsC1dGQ8enHG9lUf+ARZ9WHmBKRrpfU6z9JFPMprjMwD/IP7Q42KvnHQVLQd6VIfJ6ItPS9m23hnFL+MIJYPIoAiWN7tpFRqYDJY3uhr/pS8AX0uC2WeDUaoGSi2aUhi/kgsnz58poaNMWUDkdRTjQLq3T7sJH/MSl5AyT9HPcGEcxVVEIMoeBiAK2B7Esn6skbpTwYFT2+OXWTo8Oz9E4GNTi+H4DEA4OVDyk3a3EwzpKBprBZMGO5fAgWuNMQEmiSSIH1HQ4mJcVrKXx3W4Vmu0LmWAmlgfthvP73kGSGuowbNfSg6guhibfYEc4RHHE2gj8EvQlKIzR75/Q42f09fm9/E6JHaeroFFIo8p9SGh1tnRl8sE00KC4ZtFzsi0ZwzikOvBuelCJoRdlzuicRSoUaR+kqcHhUIQCa6P2dq/uOC5O1KdoCtSq3Xs6tJyIBaRkoBlMBuxKFaZZohJuW3VogQbHlfmqlOdlTt+SCS0P3z85sPi+mGfQdcZZfE9L4ikkjbG7ArgTsgktinf27aLoWMfFjjuNuQZRitlW9oU7D/JV1akqhZ2amwVn8zP3cOMktFmzrQMhN3Eac6UK+FFqDGOQ32W+Re8bV4CBlvl9srnrYkRyf1FuCuSrUGQzj0U0SKGIBNoD0XvyISyhJfEkkwWyQ0C2X4d0jEIRDUR7f/wBrUGJH6ovYgHJo2WNil3fLvn1dUpMGUxaCoQlwI3W+COSK8BAwcsXsAKBpRS8n0En0aGQDUauDUCHYqtMFJPOH5oCt9omgOGrgsNkdm95VTYjq69SK7tGrx0LRAuYTofZ3la5esaqHFeAg4aN91h2YxkNHZcC0uRIS+Ivv9xUW9sXEJtEoxzLSKi7tY/MNCAmDUgoD2RfeESgHAkGs/v4LkRRbET2ci+02MPAWEZB0b6FK0BBnDHYKYOv9y9XIjOVhseehiiK0NUb2k65Agz0YKfeMZArQEHe9qArXaF96aSab2Ffps+3cNR8Cz6ehbaLXnCko8BR9AzehLk7xsM6/xH9oaoMZ9QC0KHYdr/reS4OJtW7CTQYznlfE/XAAEtxuO0N9buL0oUK6HCsFZ4fVALWRVFEuLEIzV5CTBiocvvfR6nR2imWYVA7OWiXlcuaNziK6FGbeL8R6pKUc0y6b+ah5E6D4sZttGheIxkG7dZgEfdFpKKR+OzEhJl7xpw9f7aeHkpkDyCSU/7cyf5Wh89OBBoM961bEsu7f5JqzCLaCWafsEA8qJyERgo4oeXisWIBdFzsWhqjyi3N7YUY+HxT6eCBo/00wxAIUrefZPAI7ua4Zjln9H0JSENys0zaN2ldKVnkMdGLkqw8f6zW0gC9iA4XCkhi0bwe3ahXCX39JwiTtPIUb0mKmJCIQQ7Wfga13MCGZAx6sFR2wEErY+P0WovTogiqpY7hxFic/tyBoD5IktwtihHJDTJIzn7ExZvRIqoQBmxCOc3jptpupb6Rr8D5TQlJB3cHZD8EFdEhEUnuXgVIjIR1DpiYcmreCQp+o6sPkARl/lC1bB8xIoobJEndV2LOCyXAz/AMQYrUD16EkP5/Mj2w6SliAZopXLg1iBUkk1GFzam/wqW7wcJh2CIpn+q2rsBZV9jLE091egRGLGGbx9R4ZcKjfwEefKJjCUltdi8mcE6MwWleRRg3B2OEz7B7tNIcG6VZZa6gmm0IMAjdQsdU6fhxPs8unKSYo4bkrq9uFte3a+SaixQks+k3XhXxRxDHCI/RvYbt1vtGvItyBCAR+vyZ9ylZVRtVAutLW5MgTGXa3SCaIsYSDjW1YHOEois1I+ai3Ikyk/lqr6JmxI2RHOd9J3b9RfNIGgEhEYtcgyMRDrVOD0LExHbp1TepN1WtzCkCBvGpPP9DsDAT+AxsxIX7LbwOizusCl0pYZzmNSupEtedHyVZhTBGRuex+5tK/fWCMZHeEhEp6SJLqVVmp4ntr4jsh0mas2wIrrJjBclcr8/vlxeirEqV2bdtNMf1TRTH6OJDpJTL7yruXtr/qHThWHnz3vMsQiVkU+n+IiQYDSxGSnCVDr9U5RL7KIu1PshMPasMvDxjBc18lnqZQw9FToimGLmVGqYMIZJSn5dR1dn8SaX8a6WisrD/Uemu5alePZ9D+XZCPMrK7OASCMIk7Xbd9bZSD3axgmI6nyhJ1LexgsP0PlCCkCEdxb+1z+S27M7LvKlYInKsIJnjWg+40owELGIzxHUjNvGzaBBm0eygTPP21X4RDQiNVAy2XTiRPO4xSJHupH15/r0wu4jjhCZQVs/QfRMJSGJVtt9BXea2M5Qay0jIaLrBR6IjAUk87m2TDx77GKIo7vqVq+6DnyEO0pDcUq70baWjvA0BmlCc2pKAT3AYJ3nuK7QjmBukSVYpimX0IeoxwmU8lYWsa/v9CvsdgDQx1JH8ultyEAH7AEW419WzKlS5BUeC/eg0VqKqB0UMsn393wm6QtwYyTkWxXlRpAb/gzCHhqH4nHqX5owxiuO8bhk8m2F8Cg94uAzCHJq/KgoC+oppTGicJlbQzO3i7bDS7UqRmOdGada+epVPNbAap8cFAppYH/fysXqJn2SdEE0xRw285acHuVGSdUxuZutwoYBDbIbXaC4go+jrbCf34lbab7yHSDdGcvplT9GCmo4VxHk8uOvlxnic8bOg0F0BaXjcbnw+bsKCMI8G1edjhGYYuJc1BBgEVqOV0tH8Zmn7CayOvSBJqnR0n9r/OOmSQwtecBLpqtIX+/gaiCUcahrGZASfGe3SA98UBdOqzMBjnm6Mx6GfR1M6Hr9deIXl1lWQzOPhUNl3599VuUTey9HxUTXbC53HhFVs9uPNmn8YkHiKE+9AQiHl8Ci2axnd6e2/ZFr5ZuAFsB0liM+asuqXiMINlR8lM9ypoWbAjVEc7LaYckN8DxN/J1Mos4vbwvZfTtrqaODkTYBD6Frc1DggIOFQnWW7GBmQzVwz9Sq0skNVwbqpDx993s8BilrQ5GFhMWoBrAYakUMQRUCLC0bGGMUhTw/r1cOPq5vzr2sQ48QxTHpa22GFojhnVCWRnuscbUINevysaaeRjchRm5vF1/ObH48X9z/Wq4vrxeOP1f3jcnUHFnlKS+Nv1nx8pEXwt6u7r6sfFzfLxd3jj8W3xd0jSAZkGDQ1eO0AfQlawtTodUCNlCg8NZg1Qn0FCkuPpoy4UEMCU4MVPtJXEVD4Sd4FugoUln6kHXGhhgFMPYuGUF/HAKcq5jFKQMCnM5fjCFAU3JMZSW4cAP39/wHbG+77jqoAAA==" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA62d2XLjOpKGX2XCc3tqpqvOMt1157LlOmov8lh21UVHRwVEwhLGFKgBIR+rO+bdJ7hjSWQm6b5TKH98PwiSAIiF/Ns/z6x8s2efz74oLczp7Kezg7C7s89n+zI/FrL6j53dF/8+BF+Uzs8+//LxL7/8/Kdf/u+nMfV6dfcgt4u3Q4rgCjDK+rTflAVCGQQY5fF0kAijC6cIF2WeSt2FUikvvzzI50TSPpZMKzO1F8XHT39OAVxBipLLSholCvWP1CH4imRuyuy4l9qm8jKG04TjpkhlYgimUi+1/flTInEfS6W9KfU2kbQLpVLeirdrmboLhmAytdJI6j6YSr3a/I/M7DJPpHfCKQJ15jnn/VHtZWXFPnUju/EU4+lpeZlI3oWwezdK+Z/1v03yMeVPZ1khqurs85mt8g+q+iDfrDRa1JJsp4rcSH32+W/J6q1J3aPboO/w8dOf0x5BjhfGlCbF7uPz8avn50paysRRzbcK6/DIpRW8w+CordpL6mBc2XyzsC2JbFrBfINvojhKhN/E34GXplKlpgrLlc0z8xs8z6AOzYMGbaFHbWIzsUAz6bMHwUyDoN3y4U1wHjho0jxuE5uH9Vs7j1qH5kHDhtDDtsGZ4KCN9MFNcB44bj49dB+eBwdaRY8+xOfh/QbTI9ehmTVI06ot3qzUuXSKRWkrzbPI/Nav1/len379bYbXjdyK7MR1bNUzfYcmiXGckfZf5UkebyLFfP+24eIds6+d51m3ArSbq5rn07QLN+pFpk0GyUyHoXWgjyfWzvUcet6rg1WlrjDPUDvTM3p+i5w6xVx+3RAyytDTzfNqGkfaypPNc6obTNrIVc3zaVtQ2snXzfRqGlWGl6eb59W3srRbqHyfH15luKp5Pmv2/Rsq5/kN/Qm6ICPpe1rwtfzfo9SZU5b2dPCb7V4S2PzpL//18ddP7AbMH6BzTbrg+/GPYos6PIrtO0xOVj5ZVVSwRR+db3AhiuxYCCvbi3cNXXuOY1o+PwuLv9bDCoipK/jX2HwRFXxZhKJ32t0LU6HlGaneaZiuQEJTogKZYFw3U9+V3ZVHu3qVxqhcwr6QcL7t3XG/kSZ9czjx+SYrfSn3QuegQx+cjx8qVbzgYhlhmcuDkZmwMv834nEwrvgdX1cw/yA3Van9evhVGCU2w5BrL/jw0Tf5eW49H/B7wYdP8/hxHRwa9IqZR9DckEl6E53FhW64iyZZyiuZYpY/eIsGjo5mZumV0T0aWPSCmfwsbvNGq+ejzpr6s7UCtL7nb8iUAjW9Fng5mvd6rK2RYs9xapWz/Ogjet/xDKnrC/jL8flZmnOdL3Uu32jHOM3MPNilbv9uaejVAqon+P7dcT7fVNaIzF4cTQUN4/vxaKjPJeV7pQFA/Teabrs1civq40tmIpRgvC/CZjtguLL+G013LF5WB2kaG7+nNzBCCcX7bpSVD7I6FhamOQKMdbETehvdbj3IjaKUQkltFzozp6bzBpACBU1by6pCUF0Y5ZRFIbNEfoYYTtjX9fSVUIXMF6/esNJICjUM4toKYymkK+Iwj1kmZU5SPRnO1boto4udzF5kvtRJNKycRF8dLRffSyfwV0dLnEZEPs2HOrmYnulUlBXHYJQxuUYKVs4dHY98X5bFRSGFYdBD7RQHVrkE0gl8ZvmEWr7DbamVLY3SW5ZJIOf7PEiRn1gWo5JH55F51MtNzLjcYCkWb4dCKF13tlNtfiTBeFdK5ynQGKMIbdNemgqGDGGM89Wo/Gr95Zi9SKBk3SiXUp+DVMsP67jkpvPBQTtCjP17WdnzPDeyAkrQCWKMG1XZsdWvUicVlFHcpn8uUaYnoXhrKUy2Y1ABIca+LfW2PL9fJlbWeGGa832NcrowzfnH0aQWRgUCktX0xR/k4k1mR5teQpTW0g593xpFeyKS6XazMWyko8lNXzmFa4JMxnBI7VWGZjOZYKrXBJd5fM51gqZhOna9DdLF0dHkcn8QVm1UoewJRUdCmm1kLrVVogAq3FDBoJ0OtrmLr2/XD/U8WpVa1onreU5tz+tSWFHP61I+sXqKS/dEK/OxzWA6plLy3EmTCaylfhWFys/NtlkXQaIhPc9pPJ130v5Rmpd6IqE80pZoQtq7rYHeduJYWeI2BKRM/lI/VXiNFchI7uWX8dq4E3tZHUQGDB6ltQwHmjuBJrNyfzDtyAxWErGQZhv1KtFmx1GQNIzDJLwdlJH5mj5YQEnSv17cY8g+THOavvbF7qhfUF4gY3LpHkukI8kTKqNZ9dC1NBtpygoDexqSeKuqSumt0yBi7ISa63IpD/Xsp87Qhg0Wkx5d3YqRXQmXx6jk59Tqd6XtxhPwKj3SkeTV8vICIw5xmtSP6TPKANSSDs1aDQw7CkgWvkklkpC8tTSv0tB930jHJNPMKbS1ZHTgICnNt6KQ90bt69XfGDzU0eRTZSVaAzsKkvYoVDEOi2FUQEnTy0NZlNsTfT0ASppuhK4Eef5CGcl90vLt0NQd7al/kNWh1Pgth6YhHduH5lJn0qCHEukw8srk0sjcm2eMuZAKo9Yjg10OYpgTpBj3Rj5L4y/AdDFjHCUddTfHlRoyCxUYzauU4OHsSELzLmWVGZWYJI0kk3jt6BCe14Sc9vldCmM3UuCTaGntBAd8+gwRT/Eg5kpROe2zOkidnsKJNTQxORvuhVFO0wnHr79QgvGCSho+VEDEYaK5BEQTmfidQiTgeOHnH1Kh1NOh817slbUSqNgiCcZ70iWrNYB1GNltkmKeG+VSEg3gpLYPG0rmjR37a5WwvRCgMliq+utvwCIldIdFKOIAhyVNHHAoRg2OdgfDjnZHJbyV2U5oVe3vTXmQxiqZyBisJfDluMAIPWpIiaK/r8ERcZfpSQjYaH4tT2hOYS2Bv75d35vyVeXSXJT6WW2P4S3uW6T0qE0zKcc+jpQas/iC7h8I9gOR+4+gBXRDpRbUDi4b1jLxSJ4DEQZ05/3qUd7bMke3OSJ6tk07K8J28eTTTJrZ64lOXhqu3aUs5IRj8uVsk04/jsb7m9xTZmCy6ab7feI2T8unmnivMSAcorca0PjhPgM7gYQflHhqBr6LoqiH4NimfQK2kSkP9XzjRlQTrkYg0STDSUYzDKbdxlEKrtVSV9JYto8v55s0MwtTasA4Cdesnl9b+zNwCY9ByUVjDRCg42If5LPScqyq1jth8mt5YhcWBeBnRIs9/xz5cr7JoRDZFBdPz7ep6lIYC2WCYSIl13o90ziRjm17KFS45DvlNEi58KfDpNvXl6Mm6BIlF08uUELB6L0LSifAw50jaTa0hQRCt72lW6FPt2UuCwQdKLnolZY8ci/kgsmycGU0dHzK8VYW9Q9Y9GnlAaZkpPs1xdpPMsVsissM/IP8w4hDffW8o2ApyLsyRF5PZFravu3WMG4JXzgBTB5FoKTRXbvIyHSgpNHd8Dd9CfhCGtw2C5xaLVBy0YzS8IVcMHn+XBkNbdoCKqejCAfWS+uMu/ARP3EpOcMk/Rw3xlFMWRSCzGEgooDtQSz1c5nEjRIejMoev9za6dHhORoHg1oc328AwsGBioesdyvxsI6SgWYwWbCjHh5EK5wJKEk0SeSAmg4H87KCtTS+261Cs30hE8zE8qDdcH7fO0hSQx2G7Vp6ENXF0OQb7AiHKI5YW4Ffgr4EhTH6/RN6/Iy+Pr+X3ymx43QVNAppVLkPCa2uLl2ZfDANNCiuWfScbEvGMA4pD7ybHlRi6IXOGZ2zSIUi6wdpanA4FKHAyqp9vVd3HBcn6lM0BWrV7j0dWk7EAlIy0AwmA3alCtssUQm3rTq0QIPjdL7S8lzn9C2Z0PLw/ZMDi++LeQZdZ5zF97QknkLSmHpXAHdCNqFF8c6+XRQd67jYcacx1yBKMduqfuHOg3xVVapKYafmZsHZ/Mw93DgJbdZs60DITZzGXKkCfpQawxjkd5lv0fvGFWCgZX6fbO66GJHcX5SbAvkqFNnMYxENUigigfWBmD35EJbQkniSyQLVQ0B1vw7pGIUiGoj2/vgDWoMSP1RfxAKSR8saFbu+XfLr65SYMpi0FAhLgBut8UckV4CBgpcvYAUCSyl4P4NOokMhG4xcG4AOxZaZKCadPzQFbrVNAMNXBYfJ6r3lpW5GVl+lUfUavXYsEC1gOh1me1vm6hmrclwBDho23mPZjWU0dFwKSJMjLYm//HJTbuu+gNgkGuVYRkLdrX1kpgExaUBCeaD6hUcEypFgsHof34Uoio3IXu6FEXsYGMsoKNq3cAUoiDMGO2Xw9f7lSmS2NPDY0xBFEaZ8Q9spV4CBHuqpdwzkClCQtz3oypRoXzqp5lvUL9PnWzhqvgUfz0LXi15wpKPAUfQM3oS5O8bDOv8R/aEsLWfUAtCh2Ha/63kuDjbVuwk0GM55XxP1wABLcXjdG+p3F6ULFdBFWOjV3cGHIV6lOT+ohEMXRbMb7jZC85wQEwZKb//7KA1aZcUyDFrPGNZrzWXFGzFF9KhNvAkJdUnKOSbdh/RQcqdBcePeWjSvkQyDdguziJslUtFIfMpiwnQ+YyKfP4VPjy+yRxXJdQDcFQCtDp+yCDQY7lu3TpZ3/yTVmEW0Pax+7ALxoHISGinghJaLx4oF0HGxa2mt0lua2wsx8PmmNMFTSPu9hiEQpG6/0+AR3B1zzRrP6KMTkIbkZpmsX691pWSRx0QvSrLy/LFcSwt0LTpcKCCJRfPOdKteJfRJoCBM0vQp3qcUMSERgxwsCA1quYENyRj0YP3sgIOWy8bpjRGnRRFUSx3DibE4/bkDQX2QJLn7FiOSG2SQnE2KizdrRFQhDNiEcprHTbndSnMjX4HzmxKSDu62yH5cKqJDIpLcvR+QGB7rHDAx5dS8KBT8cFcfIAnK/qEq2T53RBQ3SJK6T8ecF0qA3+YZghSpH9EIIf3/ZHpgJ1TEAjRTuHBrECtIJqMKm1N/het5g9XEsEVSPtVtXYJTsbCXJ57q9AgMY8I2j6lBzIRH/1Y8+ETHEpLabGlM4JwYg9O8nzBuDsYIn1Fv3Epz6ijN0rmCarYhwCB0qx9TpePH+bx6NSXFHDUkd311s7i+XSPXXKQgmU2/8aqIv4w4RniM7t1st96H412UIwCJ1MDKpaqs0sCi09YkCFOZdneNpoixhENNreIcoejyzYi50DuhM5mv9ipqRtwYyXFeglIvymgeSSMgJGKRK3AkwqFW6UGImNiux/omzaaslD1FwCA+led/HRZmAt+Gjbhwv4XXYXHHWqErJYzTvGZ5VeK686MkqxDWyug8dn9Tqb9eMGbXWyIiJV2klkZl9dxx/Ssi+2GS5qwlgqvsWEEy1+vz++WF0KVWWf0Kjua4voniGF18iJRy+V3F3cv6PypdOIDevAw9i1AJ2VS6vzIJRgMrlBJcZcLPV7nEPspirQ8yU88qAy/PWEEzn6VZ5tBDkROiKVZupYEpQ4ikVOc6qjqbP6mUfy1VVBb1f1S6a3mqVs/nUL6dEI+ysju4BIIwSbtdd72t1INdrKCYzndLEvVtrOAwva+WIGRIR/Fv62fyuuzOdd5ULBE5VpDMcQEIXGlGAhaxGeK6EZv4WTQIs2j1oEzzStZ+ZQ0IjVQMdr2aInncY5Ai3cn6jfr3wu4ijhOaQFk9Q/dNJCCJpW4/jrrM685QaiwjIaPpFh+JjgQk8bivm3zw2McQRXEXtVx1XwENcZCG5Gq5MrelifI2BGhCcWpLAj7BYZzkue/VjmBukCbVSlEso69TjxEu40kXsqrqj1rUHwdIE0Mdya+6dQgRsA9QhHtTPqtC6S04EuxHp7ESVT0oYpDrdwKeoCvEjZGcY1GcF0Vq8D8Ic2gYis+pdmnOGKM4zjuYwbMZxqfwgIfLIMyh+UulIKCvmMaExmliBc3cLt4OK9OuFIl5bpRm7ctX+VQBS3R6XCCgidVxLx/Ll/hJ1gnRFHs0wKt/epAbJVnH5A63DhcKOMRmeI3mAjKKvs52ci9uZf3h9xDpxkhOv+wpWlDTsYI4jwd3vdwYjzN+KxS6KyANj9uNz8dNWBDm0aD6fIzQDAv3soYAg8BqtFI6mt+sdz+B1bEXJEmlie7T+j9OuuTQghecRLoqzcU+vgZiCYeahjEZwbdHu/TAh0bBtCqz8JinG+Nx6OfRlI7HbxdeYbl1FSTzeDiU9Qv178pcIi/r6Piomu2FzmPCKjb78WbNPwxIPMWJdyChkHJ4FNu1jO709l8yrXyz8ALYjhLEZ01Z9UtE4YbKj5IZ7tRQM+DGKA52W0y5Ib6Hib+TKZTdxW1h+y8nbXm0cPImwCF0LW5qHBCQcKjOsl2MDMhmrpl6FUbVQ1XBuqkPH33ezwGKWtDkYWExagGsBhqRQxBFQIsLRsYYxSFPD+vVw4+rm/OvaxDjxDFMelrbYYWiOGdUJZGe6xxtQg16/Kxpp5GNyFGbm8XX85sfjxf3P9ari+vF44/V/eNydQcWeUpL42/WfHykRfC3q7uvqx8XN8vF3eOPxbfF3SNIBmQYNDV47QB9CVrC1Oh1QI2UKDw1mDVCfQUKS4+mjLhQQwJTgxU+0lcRUPhJ3gW6ChSWfqQdcaGGAUw9i4ZQX8cApyrmMUpAwKczl+MIUBTckxlJbhwA/f3/AcDV++ajqgAA" \ No newline at end of file diff --git a/docs/Next/classes/AbstractCursor.html b/docs/Next/classes/AbstractCursor.html index bbbd1282c3..4ee48716a0 100644 --- a/docs/Next/classes/AbstractCursor.html +++ b/docs/Next/classes/AbstractCursor.html @@ -1,4 +1,9 @@ -
AbstractAbstractProtectedsignalStaticcaptureValue: boolean
+ProtectedsignalStaticcaptureValue: boolean
Change the default captureRejections option on all new EventEmitter objects.
Static ReadonlycaptureValue: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
+
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
event. This limit can be changed for individual EventEmitter instances
using the emitter.setMaxListeners(n) method. To change the default
for allEventEmitter instances, the events.defaultMaxListeners property
@@ -90,16 +95,16 @@
regular 'error' listener is installed.
The cursor is closed and all remaining locally buffered documents have been iterated.
-The cursor has no id until it receives a response from the initial cursor creating command.
+A killCursors command was attempted on this cursor.
+
A killCursors command was attempted on this cursor.
This is performed if the cursor id is non zero.
Optional[captureRest...args: AnyRestOptional[captureRest...args: AnyRestAdd a cursor flag to the cursor
The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
The flag boolean value.
-Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
Set the batch size for the cursor.
The number of documents to return per batch. See command documentation.
-AbstractcloneReturns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
-AbstractcloneReturns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
+Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
+
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
to each.
Returns true if the event had listeners, false otherwise.
import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
@@ -131,10 +136,13 @@
Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
Returns the number of listeners listening for the event named eventName.
+
Returns the number of listeners listening for the event named eventName.
If listener is provided, it will return how many times the listener is found
in the list of the listeners of the event.
Alias for emitter.removeListener().
Get the next available document from the cursor, returns null if no more documents are available.
+Do not call this method while a previous hasNext(), next() or tryNext() call on the same
+cursor is still pending. Overlapping calls are not supported.
Alias for emitter.removeListener().
Alias for emitter.removeListener().
v10.0.0
@@ -318,7 +328,7 @@Removes all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
component or module (e.g. sockets or file streams).
By default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The emitter.setMaxListeners() method allows the limit to be
modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
Returns an array of documents. The caller is responsible for making sure that there +
Returns an array of documents. The caller is responsible for making sure that there is enough memory to store the results. Note that the array only contains partial results when this cursor had been previously accessed. In that case, cursor.rewind() can be used to reset the cursor.
-Set the ReadPreference for the cursor.
-Set the ReadPreference for the cursor.
+Try to get the next available document from the cursor or null if an empty batch is returned
Do not call this method while a previous hasNext(), next() or tryNext() call on the same
+cursor is still pending. Overlapping calls are not supported.
Set the ReadPreference for the cursor.
+Set the ReadPreference for the cursor.
The new read preference for the cursor.
-StaticaddStaticaddListens once to the abort event on the provided signal.
Listening to the abort event on abort signals is unsafe and may
lead to resource leaks since another third party with the signal can
call e.stopImmediatePropagation(). Unfortunately Node.js cannot change
diff --git a/docs/Next/classes/AggregationCursor.html b/docs/Next/classes/AggregationCursor.html
index b8ce671e1e..f225cb855e 100644
--- a/docs/Next/classes/AggregationCursor.html
+++ b/docs/Next/classes/AggregationCursor.html
@@ -73,13 +73,13 @@
on
once
set
ReadonlypipelineProtectedsignalStaticcaptureValue: boolean
+ReadonlypipelineProtectedsignalStaticcaptureValue: boolean
Change the default captureRejections option on all new EventEmitter objects.
Static ReadonlycaptureValue: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
+
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
event. This limit can be changed for individual EventEmitter instances
using the emitter.setMaxListeners(n) method. To change the default
for allEventEmitter instances, the events.defaultMaxListeners property
@@ -109,16 +109,16 @@
regular 'error' listener is installed.
The cursor is closed and all remaining locally buffered documents have been iterated.
-The cursor has no id until it receives a response from the initial cursor creating command.
+A killCursors command was attempted on this cursor.
+
A killCursors command was attempted on this cursor.
This is performed if the cursor id is non zero.
Optional[captureRest...args: AnyRestOptional[captureRest...args: AnyRestAdd a cursor flag to the cursor
The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
The flag boolean value.
-Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
v0.1.26
@@ -133,12 +133,12 @@Set the batch size for the cursor.
The number of documents to return per batch. See command documentation.
-Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
+Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
+
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
to each.
Returns true if the event had listeners, false otherwise.
import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
@@ -161,12 +161,15 @@ Example- (doc): boolean | void
Parameters
- doc: TSchema
Returns boolean | void
Add a geoNear stage to the aggregation pipeline
Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
Add a group stage to the aggregation pipeline
-Add a limit stage to the aggregation pipeline
+Returns the number of listeners listening for the event named eventName.
If listener is provided, it will return how many times the listener is found
in the list of the listeners of the event.
Add a match stage to the aggregation pipeline
Alias for emitter.removeListener().
Get the next available document from the cursor, returns null if no more documents are available.
+Do not call this method while a previous hasNext(), next() or tryNext() call on the same
+cursor is still pending. Overlapping calls are not supported.
Alias for emitter.removeListener().
Alias for emitter.removeListener().
v10.0.0
@@ -365,7 +370,7 @@Add a redact stage to the aggregation pipeline
+Optionalnumber: numberAdd a redact stage to the aggregation pipeline
Removes all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
@@ -456,7 +461,7 @@
ProtectedresolveOptionalverbosity: ExplainVerbosityLike | ExplainCommandOptions | { Optionaloptions: { OptionaltimeoutMS?: numberOptionalexplain?: ExplainVerbosityLike | ExplainCommandOptionsOptionaltimeout?: { OptionaltimeoutMS?: numberBy default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The emitter.setMaxListeners() method allows the limit to be
modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.
Add a sort stage to the aggregation pipeline
-Returns an array of documents. The caller is responsible for making sure that there is enough memory to store the results. Note that the array only contains partial results when this cursor had been previously accessed. In that case, cursor.rewind() can be used to reset the cursor.
-Add a unwind stage to the aggregation pipeline
+Try to get the next available document from the cursor or null if an empty batch is returned
Do not call this method while a previous hasNext(), next() or tryNext() call on the same
+cursor is still pending. Overlapping calls are not supported.
Add a unwind stage to the aggregation pipeline
Set the ReadPreference for the cursor.
-Set the ReadPreference for the cursor.
+Set the ReadPreference for the cursor.
The new read preference for the cursor.
-StaticaddStaticaddListens once to the abort event on the provided signal.
Listening to the abort event on abort signals is unsafe and may
lead to resource leaks since another third party with the signal can
call e.stopImmediatePropagation(). Unfortunately Node.js cannot change
diff --git a/docs/Next/classes/Collection.html b/docs/Next/classes/Collection.html
index 14e192787a..8429ee3eff 100644
--- a/docs/Next/classes/Collection.html
+++ b/docs/Next/classes/Collection.html
@@ -4,7 +4,7 @@
import { MongoClient } from 'mongodb';
interface Pet {
name: string;
kind: 'dog' | 'cat' | 'fish';
}
const client = new MongoClient('mongodb://localhost:27017');
const pets = client.db().collection<Pet>('pets');
const petCursor = pets.find();
for await (const pet of petCursor) {
console.log(`${pet.name} is a ${pet.kind}!`);
}
-The name of this collection
-The name of the database this collection belongs to
-The namespace of this collection, in the format ${this.dbName}.${this.collectionName}
The current readConcern of the collection. If not explicitly defined for +
The name of this collection
+The name of the database this collection belongs to
+The namespace of this collection, in the format ${this.dbName}.${this.collectionName}
The current readConcern of the collection. If not explicitly defined for this collection, will be inherited from the parent DB
-The current readPreference of the collection. If not explicitly defined for +
The current readPreference of the collection. If not explicitly defined for this collection, will be inherited from the parent DB
-The current writeConcern of the collection. If not explicitly defined for +
The current writeConcern of the collection. If not explicitly defined for this collection, will be inherited from the parent DB
-Execute an aggregation framework pipeline against the collection, needs MongoDB >= 2.2
+Execute an aggregation framework pipeline against the collection, needs MongoDB >= 2.2
An array of aggregation pipelines to execute
Optionaloptions: AggregateOptions & AbortableOptional settings for the command
-Perform a bulkWrite operation without a fluent API
+Perform a bulkWrite operation without a fluent API
Legal operation types are
insertOneBulk operations to perform
Optionaloptions: BulkWriteOptionsOptional settings for the command
An estimated count of matching documents in the db to a filter.
NOTE: This method has been deprecated, since it does not provide an accurate count of the documents in a collection. To obtain an accurate count of documents in the collection, use Collection#countDocuments| countDocuments. To obtain an estimated count of all documents in the collection, use Collection#estimatedDocumentCount| estimatedDocumentCount.
The filter for the count.
Optional settings for the command
Gets the number of documents matching the filter. For a fast count of the total documents in a collection see Collection#estimatedDocumentCount| estimatedDocumentCount.
Due to countDocuments using the $match aggregation pipeline stage, certain query operators cannot be used in countDocuments. This includes the $where and $near query operators, among others. Details can be found in the documentation for the $match aggregation pipeline stage.
Note: When migrating from Collection#count| count to Collection#countDocuments| countDocuments @@ -125,24 +125,24 @@
Creates an index on the db and collection collection.
The field name or index specification to create an index for
const collection = client.db('foo').collection('bar');
await collection.createIndex({ a: 1, b: -1 });
// Alternate syntax for { c: 1, d: -1 } that ensures order of indexes
await collection.createIndex([ [c, 1], [d, -1] ]);
// Equivalent to { e: 1 }
await collection.createIndex('e');
// Equivalent to { f: 1, g: 1 }
await collection.createIndex(['f', 'g'])
// Equivalent to { h: 1, i: -1 }
await collection.createIndex([ { h: 1 }, { i: -1 } ]);
// Equivalent to { j: 1, k: -1, l: 2d }
await collection.createIndex(['j', ['k', -1], { l: '2d' }])
-Creates an index on the db and collection collection.
+Creates an index on the db and collection collection.
The field name or index specification to create an index for
Settings for the index and the createIndexes command combined
Creates an index on the db and collection collection.
+Creates an index on the db and collection collection.
Options for the index itself are given in indexOptions, and options for the
createIndexes command are given separately in commandOptions. Unknown fields in
indexOptions are passed through to the server for validation rather than being dropped.
The field name or index specification to create an index for
Settings for the index, or undefined if there are none
Settings for the createIndexes command, or undefined if there are none
Creates multiple indexes in the collection, this method is only supported for MongoDB 2.6 or higher. Earlier version of MongoDB will throw a command not supported error.
Note: Unlike Collection#createIndex| createIndex, this function takes in raw index specifications. @@ -152,7 +152,7 @@
Creates multiple indexes in the collection, opting into "pass through" behavior for index +
Creates multiple indexes in the collection, opting into "pass through" behavior for index options the driver does not recognise.
An array of index specifications to be created
Optional settings for the createIndexes command
Creates a single search index for the collection.
The index description for the new search index.
A promise that resolves to the name of the new search index.
Creates multiple search indexes for the current collection.
An array of SearchIndexDescriptions for the new search indexes.
A promise that resolves to an array of the newly created search index names.
Delete multiple documents from a collection
+Delete multiple documents from a collection
The filter used to select the documents to remove
Optional settings for the command
-Delete a document from a collection
+Delete a document from a collection
The filter used to select the document to remove
Optional settings for the command
-The distinct command returns a list of distinct values for the given key across a collection.
+The distinct command returns a list of distinct values for the given key across a collection.
Field of the document to find distinct values for
-Drop the collection from the database, removing it permanently. New accesses will create a new collection.
+Drop the collection from the database, removing it permanently. New accesses will create a new collection.
Optionaloptions: DropCollectionOptionsOptional settings for the command
-Drops an index from this collection.
+Drops an index from this collection.
Name of the index to drop.
Optionaloptions: CommandOperationOptionsOptional settings for the command
-Drops all indexes from this collection.
Optionaloptions: CommandOperationOptionsOptional settings for the command
-Gets an estimate of the count of documents in a collection using collection metadata. This will always run a count command on all server versions.
due to an oversight in versions 5.0.0-5.0.8 of MongoDB, the count command, which estimatedDocumentCount uses in its implementation, was not included in v1 of @@ -196,16 +196,16 @@ encountering errors.
Optionaloptions: EstimatedDocumentCountOptionsOptional settings for the command
Creates a cursor for a filter that can be used to iterate over results from MongoDB
-Optionaloptions: FindOptions & AbortableOptionaloptions: FindOptions & AbortableFetches the first document that matches the filter
-Optionaloptions: Omit<FindOneOptions, "timeoutMode"> & AbortableFind a document and delete it in one atomic operation. Requires a write lock for the duration of the operation.
+Creates a cursor for a filter that can be used to iterate over results from MongoDB
+Optionaloptions: FindOptions & AbortableOptionaloptions: FindOptions & AbortableFetches the first document that matches the filter
+Optionaloptions: Omit<FindOneOptions, "timeoutMode"> & AbortableFind a document and delete it in one atomic operation. Requires a write lock for the duration of the operation.
The filter used to select the document to remove
Optional settings for the command
-Find a document and replace it in one atomic operation. Requires a write lock for the duration of the operation.
+Find a document and replace it in one atomic operation. Requires a write lock for the duration of the operation.
The filter used to select the document to replace
The Document that replaces the matching document
Optional settings for the command
-Find a document and update it in one atomic operation. Requires a write lock for the duration of the operation.
+Find a document and update it in one atomic operation. Requires a write lock for the duration of the operation.
The value of update can be either:
The filter used to select the document to update
The modifications to apply
Optional settings for the command
-Retrieve all the indexes on the collection.
+Retrieve all the indexes on the collection.
Optional settings for the command
-Optionaloptions: ListIndexesOptionsChecks if one or more indexes exist on the collection, fails on first non-existing index
+Optionaloptions: ListIndexesOptionsChecks if one or more indexes exist on the collection, fails on first non-existing index
One or more index names to check.
Optionaloptions: ListIndexesOptionsOptional settings for the command
-Retrieves this collections index info.
+Retrieves this collections index info.
Optional settings for the command
-Initiate an In order bulk write operation. Operations will be serially executed in the order they are added, creating a new operation for each switch in types.
+Initiate an In order bulk write operation. Operations will be serially executed in the order they are added, creating a new operation for each switch in types.
Optionaloptions: BulkWriteOptionsInitiate an Out of order batch write operation. All operations will be buffered into insert/update/remove commands executed out of order.
+Initiate an Out of order batch write operation. All operations will be buffered into insert/update/remove commands executed out of order.
Optionaloptions: BulkWriteOptionsInserts an array of documents into MongoDB. If documents passed in do not contain the _id field, +
Inserts an array of documents into MongoDB. If documents passed in do not contain the _id field, one will be added to each of the documents missing it by the driver, mutating the document. This behavior can be overridden by setting the forceServerObjectId flag.
The documents to insert
Optionaloptions: BulkWriteOptionsOptional settings for the command
-Inserts a single document into MongoDB. If documents passed in do not contain the _id field, +
Inserts a single document into MongoDB. If documents passed in do not contain the _id field, one will be added to each of the documents missing it by the driver, mutating the document. This behavior can be overridden by setting the forceServerObjectId flag.
The document to insert
Optionaloptions: InsertOneOptionsOptional settings for the command
-Returns if the collection is a capped collection
Optionaloptions: OperationOptionsOptional settings for the command
-Get the list of all indexes information for the collection.
+Get the list of all indexes information for the collection.
Optionaloptions: ListIndexesOptionsOptional settings for the command
-Returns all search indexes for the current collection.
+Returns all search indexes for the current collection.
Optionaloptions: ListSearchIndexesOptionsThe options for the list indexes operation.
Returns all search indexes for the current collection.
+Returns all search indexes for the current collection.
The name of the index to search for. Only indexes with matching index names will be returned.
Optionaloptions: ListSearchIndexesOptionsThe options for the list indexes operation.
Returns the options of the collection.
+Returns the options of the collection.
Optionaloptions: OperationOptionsOptional settings for the command
-Rename the collection.
+Rename the collection.
New name of of the collection.
Optionaloptions: RenameOptionsOptional settings for the command
Replace a document in a collection with another document
+Replace a document in a collection with another document
The filter used to select the document to replace
The Document that replaces the matching document
Optionaloptions: ReplaceOptionsOptional settings for the command
-Update multiple documents in a collection
+Update multiple documents in a collection
The value of update can be either:
The filter used to select the document to update
The modifications to apply
Optionaloptions: UpdateOptionsOptional settings for the command
-Update a single document in a collection
+Update a single document in a collection
The value of update can be either:
The filter used to select the document to update
The modifications to apply
Optionaloptions: UpdateOptions & { Optional settings for the command
-Updates a search index by replacing the existing index definition with the provided definition.
The name of the search index to update.
The new search index definition.
Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this collection.
+Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this collection.
Type of the data being detected by the change stream
Type of the whole change stream document emitted
An array of pipeline stages through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.
@@ -310,4 +310,4 @@collection
.watch<Schema, ChangeStreamInsertDocument<Schema> & { comment: string }>([
{ $addFields: { comment: 'big changes' } },
{ $match: { operationType: 'insert' } }
])
.on('change', change => {
change.comment.startsWith('big');
change.operationType === 'insert';
// No need to narrow in code because the generics did that for us!
expectType<Schema>(change.fullDocument);
});
-ProtectedsignalStaticcaptureValue: boolean
+ProtectedsignalStaticcaptureValue: boolean
Change the default captureRejections option on all new EventEmitter objects.
Static ReadonlycaptureValue: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
+
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
event. This limit can be changed for individual EventEmitter instances
using the emitter.setMaxListeners(n) method. To change the default
for allEventEmitter instances, the events.defaultMaxListeners property
@@ -93,16 +93,16 @@
regular 'error' listener is installed.
The cursor is closed and all remaining locally buffered documents have been iterated.
-The cursor has no id until it receives a response from the initial cursor creating command.
+A killCursors command was attempted on this cursor.
+
A killCursors command was attempted on this cursor.
This is performed if the cursor id is non zero.
Optional[captureRest...args: AnyRestOptional[captureRest...args: AnyRestAdd a cursor flag to the cursor
The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
The flag boolean value.
-Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
Set the batch size for the cursor.
The number of documents to return per batch. See command documentation.
-AbstractcloneReturns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
-AbstractcloneReturns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
+Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
+
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
to each.
Returns true if the event had listeners, false otherwise.
import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
@@ -135,10 +135,13 @@
Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
Returns the number of listeners listening for the event named eventName.
+
Returns the number of listeners listening for the event named eventName.
If listener is provided, it will return how many times the listener is found
in the list of the listeners of the event.
Alias for emitter.removeListener().
Get the next available document from the cursor, returns null if no more documents are available.
+Do not call this method while a previous hasNext(), next() or tryNext() call on the same
+cursor is still pending. Overlapping calls are not supported.
Alias for emitter.removeListener().
Alias for emitter.removeListener().
v10.0.0
@@ -322,7 +327,7 @@Removes all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
component or module (e.g. sockets or file streams).
ProtectedresolveOptionalverbosity: ExplainVerbosityLike | ExplainCommandOptions | { Optionaloptions: { OptionaltimeoutMS?: numberOptionalexplain?: ExplainVerbosityLike | ExplainCommandOptionsOptionaltimeout?: { OptionaltimeoutMS?: numberBy default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The emitter.setMaxListeners() method allows the limit to be
modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
Returns an array of documents. The caller is responsible for making sure that there +
Returns an array of documents. The caller is responsible for making sure that there is enough memory to store the results. Note that the array only contains partial results when this cursor had been previously accessed. In that case, cursor.rewind() can be used to reset the cursor.
-Set the ReadPreference for the cursor.
-Set the ReadPreference for the cursor.
+Try to get the next available document from the cursor or null if an empty batch is returned
Do not call this method while a previous hasNext(), next() or tryNext() call on the same
+cursor is still pending. Overlapping calls are not supported.
Set the ReadPreference for the cursor.
+Set the ReadPreference for the cursor.
The new read preference for the cursor.
-StaticaddStaticaddListens once to the abort event on the provided signal.
Listening to the abort event on abort signals is unsafe and may
lead to resource leaks since another third party with the signal can
call e.stopImmediatePropagation(). Unfortunately Node.js cannot change
diff --git a/docs/Next/classes/FindCursor.html b/docs/Next/classes/FindCursor.html
index 28aaa3b575..b3882340cd 100644
--- a/docs/Next/classes/FindCursor.html
+++ b/docs/Next/classes/FindCursor.html
@@ -72,13 +72,13 @@
on
once
set
ProtectedsignalStaticcaptureValue: boolean
+ProtectedsignalStaticcaptureValue: boolean
Change the default captureRejections option on all new EventEmitter objects.
Static ReadonlycaptureValue: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
+
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
event. This limit can be changed for individual EventEmitter instances
using the emitter.setMaxListeners(n) method. To change the default
for allEventEmitter instances, the events.defaultMaxListeners property
@@ -108,16 +108,16 @@
regular 'error' listener is installed.
The cursor is closed and all remaining locally buffered documents have been iterated.
-The cursor has no id until it receives a response from the initial cursor creating command.
+A killCursors command was attempted on this cursor.
+
A killCursors command was attempted on this cursor.
This is performed if the cursor id is non zero.
Optional[captureRest...args: AnyRestOptional[captureRest...args: AnyRestAdd a cursor flag to the cursor
The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
The flag boolean value.
-Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
Set the batch size for the cursor.
The number of documents to return per batch. See command documentation.
-Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
+Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
Set the collation options for the cursor.
The cursor collation options (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).
Add a comment to the cursor query allowing for tracking the comment in the log.
The comment attached to this query.
@@ -165,10 +165,13 @@Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
Set the cursor hint
If specified, then the query system will only consider plans using the hinted index.
Set the limit for the cursor.
Set the cursor min
Specify a $min value to specify the inclusive lower bound for a specific index in order to constrain the results of find(). The $min specifies the lower bound for all keys of a specific index in order.
Alias for emitter.removeListener().
Alias for emitter.removeListener().
v10.0.0
@@ -374,7 +379,7 @@Removes all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
component or module (e.g. sockets or file streams).
By default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The emitter.setMaxListeners() method allows the limit to be
modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.
Sets the sort order of the cursor query.
The key or keys set for the sort.
Optionaldirection: SortDirectionThe direction of the sorting (1 or -1).
-Returns an array of documents. The caller is responsible for making sure that there +
Returns an array of documents. The caller is responsible for making sure that there is enough memory to store the results. Note that the array only contains partial results when this cursor had been previously accessed. In that case, cursor.rewind() can be used to reset the cursor.
-Set the ReadPreference for the cursor.
-Set the ReadPreference for the cursor.
+Try to get the next available document from the cursor or null if an empty batch is returned
Do not call this method while a previous hasNext(), next() or tryNext() call on the same
+cursor is still pending. Overlapping calls are not supported.
Set the ReadPreference for the cursor.
+Set the ReadPreference for the cursor.
The new read preference for the cursor.
-StaticaddStaticaddListens once to the abort event on the provided signal.
Listening to the abort event on abort signals is unsafe and may
lead to resource leaks since another third party with the signal can
call e.stopImmediatePropagation(). Unfortunately Node.js cannot change
diff --git a/docs/Next/classes/ListCollectionsCursor.html b/docs/Next/classes/ListCollectionsCursor.html
index e0d3090f7e..d88564ac1b 100644
--- a/docs/Next/classes/ListCollectionsCursor.html
+++ b/docs/Next/classes/ListCollectionsCursor.html
@@ -58,13 +58,13 @@
on
once
set
Optionaloptions: ListCollectionsOptions & AbortableOptionaloptionsProtectedsignalStaticcaptureValue: boolean
+Optionaloptions: ListCollectionsOptions & AbortableOptionaloptionsProtectedsignalStaticcaptureValue: boolean
Change the default captureRejections option on all new EventEmitter objects.
Static ReadonlycaptureValue: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
+
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
event. This limit can be changed for individual EventEmitter instances
using the emitter.setMaxListeners(n) method. To change the default
for allEventEmitter instances, the events.defaultMaxListeners property
@@ -94,16 +94,16 @@
regular 'error' listener is installed.
The cursor is closed and all remaining locally buffered documents have been iterated.
-The cursor has no id until it receives a response from the initial cursor creating command.
+A killCursors command was attempted on this cursor.
+
A killCursors command was attempted on this cursor.
This is performed if the cursor id is non zero.
Optional[captureRest...args: AnyRestOptional[captureRest...args: AnyRestAdd a cursor flag to the cursor
The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
The flag boolean value.
-Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
Set the batch size for the cursor.
The number of documents to return per batch. See command documentation.
-Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
+Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
+
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
to each.
Returns true if the event had listeners, false otherwise.
import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
@@ -135,10 +135,13 @@
Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
Returns the number of listeners listening for the event named eventName.
+
Returns the number of listeners listening for the event named eventName.
If listener is provided, it will return how many times the listener is found
in the list of the listeners of the event.
Alias for emitter.removeListener().
Get the next available document from the cursor, returns null if no more documents are available.
+Do not call this method while a previous hasNext(), next() or tryNext() call on the same
+cursor is still pending. Overlapping calls are not supported.
Alias for emitter.removeListener().
Alias for emitter.removeListener().
v10.0.0
@@ -322,7 +327,7 @@Removes all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
component or module (e.g. sockets or file streams).
By default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The emitter.setMaxListeners() method allows the limit to be
modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
Returns an array of documents. The caller is responsible for making sure that there +
Returns an array of documents. The caller is responsible for making sure that there is enough memory to store the results. Note that the array only contains partial results when this cursor had been previously accessed. In that case, cursor.rewind() can be used to reset the cursor.
-Set the ReadPreference for the cursor.
-Set the ReadPreference for the cursor.
+Try to get the next available document from the cursor or null if an empty batch is returned
Do not call this method while a previous hasNext(), next() or tryNext() call on the same
+cursor is still pending. Overlapping calls are not supported.
Set the ReadPreference for the cursor.
+Set the ReadPreference for the cursor.
The new read preference for the cursor.
-StaticaddStaticaddListens once to the abort event on the provided signal.
Listening to the abort event on abort signals is unsafe and may
lead to resource leaks since another third party with the signal can
call e.stopImmediatePropagation(). Unfortunately Node.js cannot change
diff --git a/docs/Next/classes/ListIndexesCursor.html b/docs/Next/classes/ListIndexesCursor.html
index 29c05903e6..a4e40d5c6d 100644
--- a/docs/Next/classes/ListIndexesCursor.html
+++ b/docs/Next/classes/ListIndexesCursor.html
@@ -57,13 +57,13 @@
on
once
set
Optionaloptions: ListIndexesOptionsOptionaloptionsProtectedsignalStaticcaptureValue: boolean
+Optionaloptions: ListIndexesOptionsOptionaloptionsProtectedsignalStaticcaptureValue: boolean
Change the default captureRejections option on all new EventEmitter objects.
Static ReadonlycaptureValue: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
+
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
event. This limit can be changed for individual EventEmitter instances
using the emitter.setMaxListeners(n) method. To change the default
for allEventEmitter instances, the events.defaultMaxListeners property
@@ -93,16 +93,16 @@
regular 'error' listener is installed.
The cursor is closed and all remaining locally buffered documents have been iterated.
-The cursor has no id until it receives a response from the initial cursor creating command.
+A killCursors command was attempted on this cursor.
+
A killCursors command was attempted on this cursor.
This is performed if the cursor id is non zero.
Optional[captureRest...args: AnyRestOptional[captureRest...args: AnyRestAdd a cursor flag to the cursor
The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
The flag boolean value.
-Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
Set the batch size for the cursor.
The number of documents to return per batch. See command documentation.
-Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
+Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
+
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
to each.
Returns true if the event had listeners, false otherwise.
import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
@@ -134,10 +134,13 @@
Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
Returns the number of listeners listening for the event named eventName.
+
Returns the number of listeners listening for the event named eventName.
If listener is provided, it will return how many times the listener is found
in the list of the listeners of the event.
Alias for emitter.removeListener().
Alias for emitter.removeListener().
Alias for emitter.removeListener().
v10.0.0
@@ -321,7 +326,7 @@Removes all listeners, or those of the specified eventName.
Optionalnumber: numberRemoves all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
component or module (e.g. sockets or file streams).
By default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The emitter.setMaxListeners() method allows the limit to be
modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
Returns an array of documents. The caller is responsible for making sure that there is enough memory to store the results. Note that the array only contains partial results when this cursor had been previously accessed. In that case, cursor.rewind() can be used to reset the cursor.
-Set the ReadPreference for the cursor.
-Set the ReadPreference for the cursor.
+Set the ReadPreference for the cursor.
The new read preference for the cursor.
-StaticaddStaticaddListens once to the abort event on the provided signal.
Listening to the abort event on abort signals is unsafe and may
lead to resource leaks since another third party with the signal can
call e.stopImmediatePropagation(). Unfortunately Node.js cannot change
diff --git a/docs/Next/classes/ListSearchIndexesCursor.html b/docs/Next/classes/ListSearchIndexesCursor.html
index 78b8cd77fa..ff0b8d23b9 100644
--- a/docs/Next/classes/ListSearchIndexesCursor.html
+++ b/docs/Next/classes/ListSearchIndexesCursor.html
@@ -69,13 +69,13 @@
on
once
set
ReadonlypipelineProtectedsignalStaticcaptureValue: boolean
+ReadonlypipelineProtectedsignalStaticcaptureValue: boolean
Change the default captureRejections option on all new EventEmitter objects.
Static ReadonlycaptureValue: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
+
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
event. This limit can be changed for individual EventEmitter instances
using the emitter.setMaxListeners(n) method. To change the default
for allEventEmitter instances, the events.defaultMaxListeners property
@@ -105,16 +105,16 @@
regular 'error' listener is installed.
The cursor is closed and all remaining locally buffered documents have been iterated.
-The cursor has no id until it receives a response from the initial cursor creating command.
+A killCursors command was attempted on this cursor.
+
A killCursors command was attempted on this cursor.
This is performed if the cursor id is non zero.
Optional[captureRest...args: AnyRestOptional[captureRest...args: AnyRestAdd a cursor flag to the cursor
The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
The flag boolean value.
-Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
v0.1.26
@@ -129,12 +129,12 @@Set the batch size for the cursor.
The number of documents to return per batch. See command documentation.
-Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
+Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
+
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
to each.
Returns true if the event had listeners, false otherwise.
import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
@@ -157,12 +157,15 @@ Example- (doc): boolean | void
Parameters
- doc: {
name: string;
}name: string
Returns boolean | void
Add a geoNear stage to the aggregation pipeline
Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
Add a group stage to the aggregation pipeline
-Add a limit stage to the aggregation pipeline
+Returns the number of listeners listening for the event named eventName.
If listener is provided, it will return how many times the listener is found
in the list of the listeners of the event.
Add a match stage to the aggregation pipeline
Alias for emitter.removeListener().
Get the next available document from the cursor, returns null if no more documents are available.
+Do not call this method while a previous hasNext(), next() or tryNext() call on the same
+cursor is still pending. Overlapping calls are not supported.
Alias for emitter.removeListener().
Alias for emitter.removeListener().
v10.0.0
@@ -361,7 +366,7 @@Add a redact stage to the aggregation pipeline
Removes all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
@@ -452,7 +457,7 @@
ProtectedresolveOptionalverbosity: ExplainVerbosityLike | ExplainCommandOptions | { Optionaloptions: { OptionaltimeoutMS?: numberOptionalexplain?: ExplainVerbosityLike | ExplainCommandOptionsOptionaltimeout?: { OptionaltimeoutMS?: numberBy default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The emitter.setMaxListeners() method allows the limit to be
modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.
Add a sort stage to the aggregation pipeline
-Returns an array of documents. The caller is responsible for making sure that there +
Returns an array of documents. The caller is responsible for making sure that there is enough memory to store the results. Note that the array only contains partial results when this cursor had been previously accessed. In that case, cursor.rewind() can be used to reset the cursor.
-Try to get the next available document from the cursor or null if an empty batch is returned
Do not call this method while a previous hasNext(), next() or tryNext() call on the same
+cursor is still pending. Overlapping calls are not supported.
Add a unwind stage to the aggregation pipeline
Set the ReadPreference for the cursor.
-Set the ReadPreference for the cursor.
+Set the ReadPreference for the cursor.
The new read preference for the cursor.
-StaticaddStaticaddListens once to the abort event on the provided signal.
Listening to the abort event on abort signals is unsafe and may
lead to resource leaks since another third party with the signal can
call e.stopImmediatePropagation(). Unfortunately Node.js cannot change
diff --git a/docs/Next/classes/MongoAPIError.html b/docs/Next/classes/MongoAPIError.html
index 93f1e23edc..302efcd75c 100644
--- a/docs/Next/classes/MongoAPIError.html
+++ b/docs/Next/classes/MongoAPIError.html
@@ -1,5 +1,5 @@
An error generated when the driver API is used incorrectly
-Optionaloptions: { Optionalcause?: ErrorOptionalcauseOptionalcodeThis is a number in MongoServerError and a string in MongoDriverError
-OptionalconnectionOptionalstackOptionaltopologyStaticstackThe Error.stackTraceLimit property specifies the number of stack frames
+
OptionalcauseOptionalcodeThis is a number in MongoServerError and a string in MongoDriverError
+OptionalconnectionOptionalstackOptionaltopologyStaticstackThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -27,10 +27,10 @@
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Legacy name for server error responses
-StaticcaptureCreates a .stack property on targetObject, which when accessed returns
+
StaticcaptureCreates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoAWSError.html b/docs/Next/classes/MongoAWSError.html
index 8dbcaaf947..1abcd5e5a1 100644
--- a/docs/Next/classes/MongoAWSError.html
+++ b/docs/Next/classes/MongoAWSError.html
@@ -1,6 +1,6 @@
MongoAWSError | mongodb Class MongoAWSError
A error generated when the user attempts to authenticate
via AWS, but fails
-Hierarchy (view full)
- MongoRuntimeError
- MongoAWSError
Index
Constructors
Hierarchy (view full)
- MongoRuntimeError
- MongoAWSError
Index
Constructors
Properties
Parameters
- message: string
Optionaloptions: {
cause?: Error;
}Optionalcause?: Error
Returns MongoAWSError
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
-Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
+
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
+Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -28,10 +28,10 @@
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
Accessors
errmsg
- get errmsg(): string
Legacy name for server error responses
-Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
+
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoAzureError.html b/docs/Next/classes/MongoAzureError.html
index fe9af0d73c..e962f43e9a 100644
--- a/docs/Next/classes/MongoAzureError.html
+++ b/docs/Next/classes/MongoAzureError.html
@@ -1,6 +1,6 @@
MongoAzureError | mongodb Class MongoAzureError
A error generated when the user attempts to authenticate
via Azure, but fails.
-Hierarchy (view full)
- MongoOIDCError
- MongoAzureError
Index
Constructors
Hierarchy (view full)
- MongoOIDCError
- MongoAzureError
Index
Constructors
Properties
Parameters
- message: string
Returns MongoAzureError
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
-Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
+
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
+Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -28,10 +28,10 @@
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
Accessors
errmsg
- get errmsg(): string
Legacy name for server error responses
-Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
+
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoBatchReExecutionError.html b/docs/Next/classes/MongoBatchReExecutionError.html
index 68128177d8..c5d2eb196a 100644
--- a/docs/Next/classes/MongoBatchReExecutionError.html
+++ b/docs/Next/classes/MongoBatchReExecutionError.html
@@ -1,6 +1,6 @@
MongoBatchReExecutionError | mongodb Class MongoBatchReExecutionError
An error generated when a batch command is re-executed after one of the commands in the batch
has failed
-Hierarchy (view full)
- MongoAPIError
- MongoBatchReExecutionError
Index
Constructors
Hierarchy (view full)
- MongoAPIError
- MongoBatchReExecutionError
Index
Constructors
Properties
Parameters
- message: string = 'This batch has already been executed, create new batch to execute'
Returns MongoBatchReExecutionError
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
-Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
+
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
+Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -28,10 +28,10 @@
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
Accessors
errmsg
- get errmsg(): string
Legacy name for server error responses
-Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
+
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoBulkWriteError.html b/docs/Next/classes/MongoBulkWriteError.html
index ff82ca675f..8e73e1209f 100644
--- a/docs/Next/classes/MongoBulkWriteError.html
+++ b/docs/Next/classes/MongoBulkWriteError.html
@@ -33,9 +33,9 @@
Meant for internal use only.
Parameters
- error: AnyError | WriteConcernError | {
code: number;
message: string;
writeErrors?: WriteError[];
} - result: BulkWriteResult
Returns MongoBulkWriteError
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
-Optionalcode Name
code Name?: stringOptionalconnection Generation
connection Generation?: numberOptionalerr
Optionalerr Info
error Response
Raw error result document returned by server.
-message
message: stringOptionalok
ok?: numberresult
Optionalstack
stack?: stringOptionaltopology Version
Optionalwrite Concern Error
write Errors
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
+
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
+Optionalcode Name
code Name?: stringOptionalconnection Generation
connection Generation?: numberOptionalerr
Optionalerr Info
error Response
Raw error result document returned by server.
+message
message: stringOptionalok
ok?: numberresult
Optionalstack
stack?: stringOptionaltopology Version
Optionalwrite Concern Error
write Errors
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -44,16 +44,16 @@
not capture any frames.
Accessors
deleted Count
- get deletedCount(): number
Number of documents deleted.
Returns number
errmsg
- get errmsg(): string
Legacy name for server error responses
-Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
inserted Count
- get insertedCount(): number
Number of documents inserted.
+Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
inserted Count
- get insertedCount(): number
Number of documents inserted.
Returns number
inserted Ids
- get insertedIds(): {
[key: number]: any;
} Inserted document generated Id's, hash key is the index of the originating operation
Returns {
[key: number]: any;
}
[key: number]: any
matched Count
- get matchedCount(): number
Number of documents matched for update.
Returns number
modified Count
- get modifiedCount(): number
Number of documents modified.
Returns number
name
- get name(): string
Returns string
upserted Count
- get upsertedCount(): number
Number of documents upserted.
Returns number
upserted Ids
- get upsertedIds(): {
[key: number]: any;
} Upserted document generated Id's, hash key is the index of the originating operation
-Returns {
[key: number]: any;
}
[key: number]: any
Methods
add Error Label
has Error Label
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
+
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoChangeStreamError.html b/docs/Next/classes/MongoChangeStreamError.html
index cee57fca2b..205961eeb5 100644
--- a/docs/Next/classes/MongoChangeStreamError.html
+++ b/docs/Next/classes/MongoChangeStreamError.html
@@ -1,5 +1,5 @@
MongoChangeStreamError | mongodb Class MongoChangeStreamError
An error generated when a ChangeStream operation fails to execute.
-Hierarchy (view full)
- MongoRuntimeError
- MongoChangeStreamError
Index
Constructors
Hierarchy (view full)
- MongoRuntimeError
- MongoChangeStreamError
Index
Constructors
Properties
Parameters
- message: string
Returns MongoChangeStreamError
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
-Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
+
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
+Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -27,10 +27,10 @@
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
Accessors
errmsg
- get errmsg(): string
Legacy name for server error responses
-Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
+
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoClientBulkWriteCursorError.html b/docs/Next/classes/MongoClientBulkWriteCursorError.html
index 927f2eab28..825e9f671c 100644
--- a/docs/Next/classes/MongoClientBulkWriteCursorError.html
+++ b/docs/Next/classes/MongoClientBulkWriteCursorError.html
@@ -1,5 +1,5 @@
MongoClientBulkWriteCursorError | mongodb Class MongoClientBulkWriteCursorError
An error indicating that an error occurred when processing bulk write results.
-Hierarchy (view full)
- MongoRuntimeError
- MongoClientBulkWriteCursorError
Index
Constructors
Hierarchy (view full)
- MongoRuntimeError
- MongoClientBulkWriteCursorError
Index
Constructors
Properties
Parameters
- message: string
Returns MongoClientBulkWriteCursorError
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
-Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
+
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
+Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -27,10 +27,10 @@
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
Accessors
errmsg
- get errmsg(): string
Legacy name for server error responses
-Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
+
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoClientBulkWriteError.html b/docs/Next/classes/MongoClientBulkWriteError.html
index e089925f44..4be118d393 100644
--- a/docs/Next/classes/MongoClientBulkWriteError.html
+++ b/docs/Next/classes/MongoClientBulkWriteError.html
@@ -1,5 +1,5 @@
MongoClientBulkWriteError | mongodb Class MongoClientBulkWriteError
An error indicating that an error occurred when executing the bulk write.
-Hierarchy (view full)
- MongoServerError
- MongoClientBulkWriteError
Index
Constructors
Hierarchy (view full)
- MongoServerError
- MongoClientBulkWriteError
Index
Constructors
Properties
Constructors
constructor
- new
Mongo Client Bulk Write Error(message): MongoClientBulkWriteError Initialize the client bulk write error.
Parameters
- message: ErrorDescription
The error message.
-
Returns MongoClientBulkWriteError
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
-Optionalcode Name
code Name?: stringOptionalconnection Generation
connection Generation?: numberOptionalerr Info
error Response
Raw error result document returned by server.
-message
message: stringOptionalok
ok?: numberOptionalpartial Result
The results of any successful operations that were performed before the error was
+
Returns MongoClientBulkWriteError
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
+Optionalcode Name
code Name?: stringOptionalconnection Generation
connection Generation?: numberOptionalerr Info
error Response
Raw error result document returned by server.
+message
message: stringOptionalok
ok?: numberOptionalpartial Result
The results of any successful operations that were performed before the error was
encountered.
-Optionalstack
stack?: stringOptionaltopology Version
Optionalwrite Concern Error
write Concern Errors
Write concern errors that occurred while executing the bulk write. This list may have
+
Optionalstack
stack?: stringOptionaltopology Version
Optionalwrite Concern Error
write Concern Errors
Write concern errors that occurred while executing the bulk write. This list may have
multiple items if more than one server command was required to execute the bulk write.
-write Errors
Errors that occurred during the execution of individual write operations. This map will
+
write Errors
Errors that occurred during the execution of individual write operations. This map will
contain at most one entry if the bulk write was ordered.
-Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
+
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -40,10 +40,10 @@
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
Accessors
errmsg
- get errmsg(): string
Legacy name for server error responses
-Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
+
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoClientBulkWriteExecutionError.html b/docs/Next/classes/MongoClientBulkWriteExecutionError.html
index 1a4d1ae1b7..b80838cfca 100644
--- a/docs/Next/classes/MongoClientBulkWriteExecutionError.html
+++ b/docs/Next/classes/MongoClientBulkWriteExecutionError.html
@@ -1,5 +1,5 @@
MongoClientBulkWriteExecutionError | mongodb Class MongoClientBulkWriteExecutionError
An error indicating that an error occurred on the client when executing a client bulk write.
-Hierarchy (view full)
- MongoRuntimeError
- MongoClientBulkWriteExecutionError
Index
Constructors
Hierarchy (view full)
- MongoRuntimeError
- MongoClientBulkWriteExecutionError
Index
Constructors
Properties
Parameters
- message: string
Returns MongoClientBulkWriteExecutionError
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
-Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
+
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
+Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -27,10 +27,10 @@
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
Accessors
errmsg
- get errmsg(): string
Legacy name for server error responses
-Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
+
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoClientClosedError.html b/docs/Next/classes/MongoClientClosedError.html
index 504fb6dcd4..83b9abac21 100644
--- a/docs/Next/classes/MongoClientClosedError.html
+++ b/docs/Next/classes/MongoClientClosedError.html
@@ -1,6 +1,6 @@
MongoClientClosedError | mongodb Class MongoClientClosedError
An error generated when the MongoClient is closed and async
operations are interrupted.
-Hierarchy (view full)
- MongoAPIError
- MongoClientClosedError
Index
Constructors
Hierarchy (view full)
- MongoAPIError
- MongoClientClosedError
Index
Constructors
Properties
Returns MongoClientClosedError
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
-Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
+
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
+Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -28,10 +28,10 @@
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
Accessors
errmsg
- get errmsg(): string
Legacy name for server error responses
-Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
+
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoCompatibilityError.html b/docs/Next/classes/MongoCompatibilityError.html
index 9d4ebaf305..1e51f98527 100644
--- a/docs/Next/classes/MongoCompatibilityError.html
+++ b/docs/Next/classes/MongoCompatibilityError.html
@@ -1,6 +1,6 @@
MongoCompatibilityError | mongodb Class MongoCompatibilityError
An error generated when a feature that is not enabled or allowed for the current server
configuration is used
-Hierarchy (view full)
- MongoAPIError
- MongoCompatibilityError
Index
Constructors
Hierarchy (view full)
- MongoAPIError
- MongoCompatibilityError
Index
Constructors
Properties
Parameters
- message: string
Returns MongoCompatibilityError
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
-Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
+
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
+Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -28,10 +28,10 @@
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
Accessors
errmsg
- get errmsg(): string
Legacy name for server error responses
-Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
+
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoCredentials.html b/docs/Next/classes/MongoCredentials.html
index f59bfa7181..d0d2c546e4 100644
--- a/docs/Next/classes/MongoCredentials.html
+++ b/docs/Next/classes/MongoCredentials.html
@@ -18,4 +18,4 @@
Parameters
- other: MongoCredentials
Returns boolean
resolve Auth Mechanism
- resolve
Auth Mechanism(hello): MongoCredentials If the authentication mechanism is set to "default", resolves the authMechanism
based on the server version and server supported sasl mechanisms.
Parameters
- hello: null | Document
A hello response from the server
-
Returns MongoCredentials
validate
Staticmerge
- merge(creds, options): MongoCredentials
Parameters
- creds: undefined | MongoCredentials
- options: Partial<MongoCredentialsOptions>
Returns MongoCredentials
+Returns MongoCredentials
validate
Staticmerge
- merge(creds, options): MongoCredentials
Parameters
- creds: undefined | MongoCredentials
- options: Partial<MongoCredentialsOptions>
Returns MongoCredentials
diff --git a/docs/Next/classes/MongoCryptAzureKMSRequestError.html b/docs/Next/classes/MongoCryptAzureKMSRequestError.html
index d6f5ddeede..9cc83e0911 100644
--- a/docs/Next/classes/MongoCryptAzureKMSRequestError.html
+++ b/docs/Next/classes/MongoCryptAzureKMSRequestError.html
@@ -20,8 +20,8 @@
Parameters
- message: string
Optionalbody: Document
Returns MongoCryptAzureKMSRequestError
Properties
Optionalbody
The body of the http response that failed, if present.
-Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
-Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
+
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
+Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -29,10 +29,10 @@
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
Accessors
errmsg
- get errmsg(): string
Legacy name for server error responses
-Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
+
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoCryptCreateDataKeyError.html b/docs/Next/classes/MongoCryptCreateDataKeyError.html
index 14a569ed45..df1d01e317 100644
--- a/docs/Next/classes/MongoCryptCreateDataKeyError.html
+++ b/docs/Next/classes/MongoCryptCreateDataKeyError.html
@@ -19,8 +19,8 @@
Meant for internal use only.
Parameters
- encryptedFields: Document
- __namedParameters: {
cause: Error;
}cause: Error
Returns MongoCryptCreateDataKeyError
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
-Optionalconnection Generation
connection Generation?: numberencrypted Fields
message
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
+
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
+Optionalconnection Generation
connection Generation?: numberencrypted Fields
message
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -28,10 +28,10 @@
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
Accessors
errmsg
- get errmsg(): string
Legacy name for server error responses
-Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
+
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoCryptCreateEncryptedCollectionError.html b/docs/Next/classes/MongoCryptCreateEncryptedCollectionError.html
index 70e7ee2392..84fb946af0 100644
--- a/docs/Next/classes/MongoCryptCreateEncryptedCollectionError.html
+++ b/docs/Next/classes/MongoCryptCreateEncryptedCollectionError.html
@@ -19,8 +19,8 @@
Meant for internal use only.
Parameters
- encryptedFields: Document
- __namedParameters: {
cause: Error;
}cause: Error
Returns MongoCryptCreateEncryptedCollectionError
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
-Optionalconnection Generation
connection Generation?: numberencrypted Fields
message
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
+
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
+Optionalconnection Generation
connection Generation?: numberencrypted Fields
message
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -28,10 +28,10 @@
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
Accessors
errmsg
- get errmsg(): string
Legacy name for server error responses
-Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
+
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoCryptError.html b/docs/Next/classes/MongoCryptError.html
index 3a760007d3..f85498c2f5 100644
--- a/docs/Next/classes/MongoCryptError.html
+++ b/docs/Next/classes/MongoCryptError.html
@@ -18,8 +18,8 @@
Meant for internal use only.
Parameters
- message: string
- options: {
cause?: Error;
} = {}Optionalcause?: Error
Returns MongoCryptError
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
-Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
+
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
+Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -27,10 +27,10 @@
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
Accessors
errmsg
- get errmsg(): string
Legacy name for server error responses
-Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
+
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoCryptInvalidArgumentError.html b/docs/Next/classes/MongoCryptInvalidArgumentError.html
index faa1a017f4..a5a8238439 100644
--- a/docs/Next/classes/MongoCryptInvalidArgumentError.html
+++ b/docs/Next/classes/MongoCryptInvalidArgumentError.html
@@ -18,8 +18,8 @@
Meant for internal use only.
Parameters
- message: string
Returns MongoCryptInvalidArgumentError
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
-Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
+
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
+Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -27,10 +27,10 @@
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
Accessors
errmsg
- get errmsg(): string
Legacy name for server error responses
-Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
+
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoCryptKMSRequestNetworkTimeoutError.html b/docs/Next/classes/MongoCryptKMSRequestNetworkTimeoutError.html
index edc82debf3..76ce09c8bb 100644
--- a/docs/Next/classes/MongoCryptKMSRequestNetworkTimeoutError.html
+++ b/docs/Next/classes/MongoCryptKMSRequestNetworkTimeoutError.html
@@ -17,8 +17,8 @@
Meant for internal use only.
Parameters
- message: string
- options: {
cause?: Error;
} = {}Optionalcause?: Error
Returns MongoCryptKMSRequestNetworkTimeoutError
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
-Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
+
Properties
Optionalcause
cause?: ErrorOptionalcode
code?: string | numberThis is a number in MongoServerError and a string in MongoDriverError
+Optionalconnection Generation
connection Generation?: numbermessage
message: stringOptionalstack
stack?: stringOptionaltopology Version
Staticstack Trace Limit
stack Trace Limit: numberThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
@@ -26,10 +26,10 @@
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
Accessors
errmsg
- get errmsg(): string
Legacy name for server error responses
-Returns string
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
error Labels
- get errorLabels(): string[]
Returns string[]
name
- get name(): string
Returns string
Methods
add Error Label
has Error Label
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
+
Staticcapture Stack Trace
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/Next/classes/MongoCursorExhaustedError.html b/docs/Next/classes/MongoCursorExhaustedError.html
index 8c193e2853..eba7f72d5e 100644
--- a/docs/Next/classes/MongoCursorExhaustedError.html
+++ b/docs/Next/classes/MongoCursorExhaustedError.html
@@ -1,5 +1,5 @@
MongoCursorExhaustedError | mongodb Class MongoCursorExhaustedError
An error thrown when an attempt is made to read from a cursor that has been exhausted
-Hierarchy (view full)
- MongoAPIError
- MongoCursorExhaustedError
Index
Constructors
Hierarchy (view full)
Base class for all cursors.
+A cursor does not support overlapping calls to any method that reads from the cursor, such as +
+hasNext(),next()ortryNext(). Wait for each call to settle before making the next one on +the same cursor. Calls that overlap can result in undefined behaviour, which could produce +unpredictable or incorrect results.