Skip to content

Commit f28ba0d

Browse files
docs: generate docs from latest main (#3306)
1 parent 5644d3c commit f28ba0d

File tree

247 files changed

+1118
-1046
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

247 files changed

+1118
-1046
lines changed

docs/Next/assets/search.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/Next/classes/AbstractCursor.html

+18-18
Large diffs are not rendered by default.

docs/Next/classes/Admin.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@
3232
<p>Validate an existing collection</p>
3333
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>collectionName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
3434
<p>The name of the collection to validate.</p>
35-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">&gt;</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com./mongodb/node-mongodb-native/blob/main/src/admin.ts#L250">src/admin.ts:250</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>collectionName: <span class="tsd-signature-type">string</span></h5></li><li><h5>callback: <a href="../modules.html#Callback" class="tsd-signature-type" data-tsd-kind="Type alias">Callback</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com./mongodb/node-mongodb-native/blob/main/src/admin.ts#L251">src/admin.ts:251</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>collectionName: <span class="tsd-signature-type">string</span></h5></li><li><h5>options: <a href="../interfaces/ValidateCollectionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidateCollectionOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">&gt;</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com./mongodb/node-mongodb-native/blob/main/src/admin.ts#L252">src/admin.ts:252</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>collectionName: <span class="tsd-signature-type">string</span></h5></li><li><h5>options: <a href="../interfaces/ValidateCollectionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidateCollectionOptions</a></h5></li><li><h5>callback: <a href="../modules.html#Callback" class="tsd-signature-type" data-tsd-kind="Type alias">Callback</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></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="Admin.html" class="tsd-kind-icon">Admin</a><ul><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#addUser" class="tsd-kind-icon">add<wbr/>User</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#buildInfo" class="tsd-kind-icon">build<wbr/>Info</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#listDatabases" class="tsd-kind-icon">list<wbr/>Databases</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#ping" class="tsd-kind-icon">ping</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#removeUser" class="tsd-kind-icon">remove<wbr/>User</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#replSetGetStatus" class="tsd-kind-icon">repl<wbr/>Set<wbr/>Get<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#serverInfo" class="tsd-kind-icon">server<wbr/>Info</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#serverStatus" class="tsd-kind-icon">server<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#validateCollection" class="tsd-kind-icon">validate<wbr/>Collection</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>
35+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">&gt;</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com./mongodb/node-mongodb-native/blob/main/src/admin.ts#L250">src/admin.ts:250</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>collectionName: <span class="tsd-signature-type">string</span></h5></li><li><h5>callback: <a href="../modules.html#Callback" class="tsd-signature-type" data-tsd-kind="Type alias">Callback</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com./mongodb/node-mongodb-native/blob/main/src/admin.ts#L251">src/admin.ts:251</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>collectionName: <span class="tsd-signature-type">string</span></h5></li><li><h5>options: <a href="../interfaces/ValidateCollectionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidateCollectionOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">&gt;</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com./mongodb/node-mongodb-native/blob/main/src/admin.ts#L252">src/admin.ts:252</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>collectionName: <span class="tsd-signature-type">string</span></h5></li><li><h5>options: <a href="../interfaces/ValidateCollectionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidateCollectionOptions</a></h5></li><li><h5>callback: <a href="../modules.html#Callback" class="tsd-signature-type" data-tsd-kind="Type alias">Callback</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></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="Admin.html" class="tsd-kind-icon">Admin</a><ul><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#addUser" class="tsd-kind-icon">add<wbr/>User</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#buildInfo" class="tsd-kind-icon">build<wbr/>Info</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#listDatabases" class="tsd-kind-icon">list<wbr/>Databases</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#ping" class="tsd-kind-icon">ping</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#removeUser" class="tsd-kind-icon">remove<wbr/>User</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#replSetGetStatus" class="tsd-kind-icon">repl<wbr/>Set<wbr/>Get<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#serverInfo" class="tsd-kind-icon">server<wbr/>Info</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#serverStatus" class="tsd-kind-icon">server<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Admin.html#validateCollection" class="tsd-kind-icon">validate<wbr/>Collection</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>

0 commit comments

Comments
 (0)