docs: generate docs from latest main (#3371)

Author: github-actions[bot]

docs/Next/assets/highlight.css

@@ -23,10 +23,10 @@
     --dark-hl-10: #C8C8C8;
     --light-hl-11: #000000FF;
     --dark-hl-11: #D4D4D4;
-    --light-hl-12: #811F3F;
-    --dark-hl-12: #D16969;
-    --light-hl-13: #EE0000;
-    --dark-hl-13: #D7BA7D;
+    --light-hl-12: #EE0000;
+    --dark-hl-12: #D7BA7D;
+    --light-hl-13: #811F3F;
+    --dark-hl-13: #D16969;
     --light-code-background: #F5F5F5;
     --dark-code-background: #1E1E1E;
 }

docs/Next/assets/search.js

@@ -2,7 +2,7 @@
 <p>An event published when a request to check a connection out fails</p>
 </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="ConnectionPoolMonitoringEvent.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionPoolMonitoringEvent</a><ul class="tsd-hierarchy"><li><span class="target">ConnectionCheckOutFailedEvent</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionCheckOutFailedEvent.html#address" class="tsd-kind-icon">address</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ConnectionCheckOutFailedEvent.html#reason" class="tsd-kind-icon">reason</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionCheckOutFailedEvent.html#time" class="tsd-kind-icon">time</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="address" class="tsd-anchor"></a><h3 class="tsd-anchor-link">address<a href="#address" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionPoolMonitoringEvent.html">ConnectionPoolMonitoringEvent</a>.<a href="ConnectionPoolMonitoringEvent.html#address">address</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cmap/connection_pool_events.ts#L15">src/cmap/connection_pool_events.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>The address (host/port pair) of the pool</p>
-</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="reason" class="tsd-anchor"></a><h3 class="tsd-anchor-link">reason<a href="#reason" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">reason<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#AnyError" class="tsd-signature-type" data-tsd-kind="Type alias">AnyError</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cmap/connection_pool_events.ts#L124">src/cmap/connection_pool_events.ts:124</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="reason" class="tsd-anchor"></a><h3 class="tsd-anchor-link">reason<a href="#reason" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">reason<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#AnyError" class="tsd-signature-type" data-tsd-kind="Type alias">AnyError</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cmap/connection_pool_events.ts#L136">src/cmap/connection_pool_events.ts:136</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>The reason the attempt to check out failed</p>
 </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="time" class="tsd-anchor"></a><h3 class="tsd-anchor-link">time<a href="#time" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionPoolMonitoringEvent.html">ConnectionPoolMonitoringEvent</a>.<a href="ConnectionPoolMonitoringEvent.html#time">time</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cmap/connection_pool_events.ts#L13">src/cmap/connection_pool_events.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>A timestamp when the event was created</p>

docs/Next/classes/AbstractCursor.html

@@ -2,7 +2,7 @@
 <p>An event published when a connection is checked into the connection pool</p>
 </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="ConnectionPoolMonitoringEvent.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionPoolMonitoringEvent</a><ul class="tsd-hierarchy"><li><span class="target">ConnectionCheckedInEvent</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionCheckedInEvent.html#address" class="tsd-kind-icon">address</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ConnectionCheckedInEvent.html#connectionId" class="tsd-kind-icon">connection<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionCheckedInEvent.html#time" class="tsd-kind-icon">time</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="address" class="tsd-anchor"></a><h3 class="tsd-anchor-link">address<a href="#address" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionPoolMonitoringEvent.html">ConnectionPoolMonitoringEvent</a>.<a href="ConnectionPoolMonitoringEvent.html#address">address</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cmap/connection_pool_events.ts#L15">src/cmap/connection_pool_events.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>The address (host/port pair) of the pool</p>
-</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="connectionId" class="tsd-anchor"></a><h3 class="tsd-anchor-link">connection<wbr/>Id<a href="#connectionId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">connection<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;&lt;monitor&gt;&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cmap/connection_pool_events.ts#L156">src/cmap/connection_pool_events.ts:156</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="connectionId" class="tsd-anchor"></a><h3 class="tsd-anchor-link">connection<wbr/>Id<a href="#connectionId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">connection<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;&lt;monitor&gt;&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cmap/connection_pool_events.ts#L168">src/cmap/connection_pool_events.ts:168</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>The id of the connection</p>
 </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="time" class="tsd-anchor"></a><h3 class="tsd-anchor-link">time<a href="#time" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionPoolMonitoringEvent.html">ConnectionPoolMonitoringEvent</a>.<a href="ConnectionPoolMonitoringEvent.html#time">time</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cmap/connection_pool_events.ts#L13">src/cmap/connection_pool_events.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>A timestamp when the event was created</p>

docs/Next/classes/Admin.html

@@ -2,7 +2,7 @@
 <p>An event published when a connection is checked out of the connection pool</p>
 </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="ConnectionPoolMonitoringEvent.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionPoolMonitoringEvent</a><ul class="tsd-hierarchy"><li><span class="target">ConnectionCheckedOutEvent</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionCheckedOutEvent.html#address" class="tsd-kind-icon">address</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ConnectionCheckedOutEvent.html#connectionId" class="tsd-kind-icon">connection<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionCheckedOutEvent.html#time" class="tsd-kind-icon">time</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="address" class="tsd-anchor"></a><h3 class="tsd-anchor-link">address<a href="#address" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionPoolMonitoringEvent.html">ConnectionPoolMonitoringEvent</a>.<a href="ConnectionPoolMonitoringEvent.html#address">address</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cmap/connection_pool_events.ts#L15">src/cmap/connection_pool_events.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>The address (host/port pair) of the pool</p>
-</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="connectionId" class="tsd-anchor"></a><h3 class="tsd-anchor-link">connection<wbr/>Id<a href="#connectionId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">connection<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;&lt;monitor&gt;&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cmap/connection_pool_events.ts#L140">src/cmap/connection_pool_events.ts:140</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="connectionId" class="tsd-anchor"></a><h3 class="tsd-anchor-link">connection<wbr/>Id<a href="#connectionId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">connection<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;&lt;monitor&gt;&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cmap/connection_pool_events.ts#L152">src/cmap/connection_pool_events.ts:152</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>The id of the connection</p>
 </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="time" class="tsd-anchor"></a><h3 class="tsd-anchor-link">time<a href="#time" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionPoolMonitoringEvent.html">ConnectionPoolMonitoringEvent</a>.<a href="ConnectionPoolMonitoringEvent.html#time">time</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cmap/connection_pool_events.ts#L13">src/cmap/connection_pool_events.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>A timestamp when the event was created</p>