Skip to content

docs: generate docs from latest main #3246

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.

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

Merged
merged 1 commit into from
Jun 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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

Large diffs are not rendered by default.

48 changes: 24 additions & 24 deletions docs/Next/classes/AbstractCursor.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/Next/classes/Admin.html

Large diffs are not rendered by default.

60 changes: 30 additions & 30 deletions docs/Next/classes/AggregationCursor.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/BulkOperationBase.html

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/Next/classes/CancellationToken.html

Large diffs are not rendered by default.

34 changes: 18 additions & 16 deletions docs/Next/classes/ChangeStream.html

Large diffs are not rendered by default.

49 changes: 29 additions & 20 deletions docs/Next/classes/ClientSession.html

Large diffs are not rendered by default.

109 changes: 58 additions & 51 deletions docs/Next/classes/Collection.html

Large diffs are not rendered by default.

40 changes: 20 additions & 20 deletions docs/Next/classes/Db.html

Large diffs are not rendered by default.

54 changes: 27 additions & 27 deletions docs/Next/classes/FindCursor.html

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/Next/classes/GridFSBucket.html

Large diffs are not rendered by default.

68 changes: 37 additions & 31 deletions docs/Next/classes/GridFSBucketReadStream.html

Large diffs are not rendered by default.

44 changes: 22 additions & 22 deletions docs/Next/classes/GridFSBucketWriteStream.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/Next/classes/HostAddress.html

Large diffs are not rendered by default.

46 changes: 23 additions & 23 deletions docs/Next/classes/ListCollectionsCursor.html

Large diffs are not rendered by default.

48 changes: 24 additions & 24 deletions docs/Next/classes/ListIndexesCursor.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoAPIError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoAWSError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoBatchReExecutionError.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/Next/classes/MongoBulkWriteError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoChangeStreamError.html

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions docs/Next/classes/MongoClient.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoCompatibilityError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoCursorExhaustedError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoCursorInUseError.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/Next/classes/MongoDBNamespace.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoDecompressionError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoDriverError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoExpiredSessionError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoGridFSChunkError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoGridFSStreamError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoInvalidArgumentError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoKerberosError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoMissingCredentialsError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoMissingDependencyError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoNetworkError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoNetworkTimeoutError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoNotConnectedError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoParseError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoRuntimeError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoServerClosedError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoServerError.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/Next/classes/MongoServerSelectionError.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/Next/classes/MongoSystemError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoTailableCursorError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoTopologyClosedError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/MongoTransactionError.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/Next/classes/MongoWriteConcernError.html

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/Next/classes/ObjectId.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/OrderedBulkOperation.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/ServerCapabilities.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/ServerSession.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/StreamDescription.html

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/Next/classes/TypedEventEmitter.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Next/classes/UnorderedBulkOperation.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/Next/classes/WriteConcern.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@
<p>request acknowledgment that the write operation has propagated to a specified number of mongod instances or to mongod instances with specified tags.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="wtimeout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> wtimeout<a href="#wtimeout" 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">wtimeout<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/write_concern.ts#L41">src/write_concern.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>specify a time limit to prevent write operations from blocking indefinitely</p>
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="fromOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> from<wbr/>Options<a href="#fromOptions" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">from<wbr/>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/WriteConcernOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WriteConcernOptions</a><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#W" class="tsd-signature-type" data-tsd-kind="Type alias">W</a>, inherit<span class="tsd-signature-symbol">?: </span><a href="../interfaces/WriteConcernOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WriteConcernOptions</a><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/write_concern.ts#L74">src/write_concern.ts:74</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="fromOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> from<wbr/>Options<a href="#fromOptions" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">from<wbr/>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/WriteConcernOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WriteConcernOptions</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#W" class="tsd-signature-type" data-tsd-kind="Type alias">W</a><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a>, inherit<span class="tsd-signature-symbol">?: </span><a href="../interfaces/WriteConcernOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WriteConcernOptions</a><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/write_concern.ts#L74">src/write_concern.ts:74</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Construct a WriteConcern given an options object.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/WriteConcernOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WriteConcernOptions</a><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#W" class="tsd-signature-type" data-tsd-kind="Type alias">W</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> inherit: <a href="../interfaces/WriteConcernOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WriteConcernOptions</a><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a></h4></li></ul></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="WriteConcern.html" class="tsd-kind-icon">Write<wbr/>Concern</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="WriteConcern.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="WriteConcern.html#fsync" class="tsd-kind-icon">fsync</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="WriteConcern.html#j" class="tsd-kind-icon">j</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="WriteConcern.html#w" class="tsd-kind-icon">w</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="WriteConcern.html#wtimeout" class="tsd-kind-icon">wtimeout</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="WriteConcern.html#fromOptions" class="tsd-kind-icon">from<wbr/>Options</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><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</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>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/WriteConcernOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WriteConcernOptions</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#W" class="tsd-signature-type" data-tsd-kind="Type alias">W</a><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> inherit: <a href="../interfaces/WriteConcernOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WriteConcernOptions</a><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a></h4></li></ul></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="WriteConcern.html" class="tsd-kind-icon">Write<wbr/>Concern</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="WriteConcern.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="WriteConcern.html#fsync" class="tsd-kind-icon">fsync</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="WriteConcern.html#j" class="tsd-kind-icon">j</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="WriteConcern.html#w" class="tsd-kind-icon">w</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="WriteConcern.html#wtimeout" class="tsd-kind-icon">wtimeout</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="WriteConcern.html#fromOptions" class="tsd-kind-icon">from<wbr/>Options</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><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</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>
2 changes: 1 addition & 1 deletion docs/Next/index.html

Large diffs are not rendered by default.

Loading