Skip to content

docs: generate docs from latest main #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: generate docs from latest main #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Next/assets/search.js
View file
Open in desktop

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions docs/Next/classes/AbstractCursor.html
View file
Open in desktop

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions docs/Next/classes/Admin.html
View file
Open in desktop

Large diffs are not rendered by default.

58 changes: 29 additions & 29 deletions docs/Next/classes/AggregationCursor.html
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/Batch.html
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/Next/classes/BulkOperationBase.html
View file
Open in desktop

Large diffs are not rendered by default.

48 changes: 24 additions & 24 deletions docs/Next/classes/BulkWriteResult.html
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/CancellationToken.html
View file
Open in desktop

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions docs/Next/classes/ChangeStream.html
View file
Open in desktop

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions docs/Next/classes/ClientSession.html
View file
Open in desktop

Large diffs are not rendered by default.

102 changes: 51 additions & 51 deletions docs/Next/classes/Collection.html
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/CommandFailedEvent.html
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/CommandStartedEvent.html
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/CommandSucceededEvent.html
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/Next/classes/ConnectionCheckOutFailedEvent.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ConnectionCheckOutFailedEvent | mongodb</title><meta name="description" content="Documentation for mongodb"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">mongodb</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">mongodb</a></li><li><a href="ConnectionCheckOutFailedEvent.html">ConnectionCheckOutFailedEvent</a></li></ul><h1>Class ConnectionCheckOutFailedEvent</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<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">
</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/avaly/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/avaly/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">
<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">
</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/avaly/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>
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="ConnectionCheckOutFailedEvent.html" class="tsd-kind-icon">Connection<wbr/>Check<wbr/>Out<wbr/>Failed<wbr/>Event</a><ul><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></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
Loading