Skip to content

Commit

Permalink
docs: generate docs from latest main [skip-ci] (#3734)
Browse files Browse the repository at this point in the history 
Co-authored-by: durran <durran@users.noreply.github.com>
  • Loading branch information
@github-actions @durran
github-actions[bot] and durran authored Jun 26, 2023
1 parent c015e54 commit 777d57b
Show file tree
Hide file tree
Showing 293 changed files with 3,970 additions and 392 deletions.
2 changes: 1 addition & 1 deletion docs/Next/assets/search.js
View file

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion docs/Next/classes/AbstractCursor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1372,6 +1372,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="HostAddress.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Host<wbr/>Address</span></a></li>
<li><a href="ListCollectionsCursor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>List<wbr/>Collections<wbr/>Cursor</span></a></li>
<li><a href="ListIndexesCursor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>List<wbr/>Indexes<wbr/>Cursor</span></a></li>
<li><a href="ListSearchIndexesCursor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>List<wbr/>Search<wbr/>Indexes<wbr/>Cursor</span></a></li>
<li><a href="MongoAPIError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>MongoAPIError</span></a></li>
<li><a href="MongoAWSError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>MongoAWSError</span></a></li>
<li><a href="MongoAzureError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Mongo<wbr/>Azure<wbr/>Error</span></a></li>
Expand Down Expand Up @@ -1524,7 +1525,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../interfaces/ListDatabasesOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>List<wbr/>Databases<wbr/>Options</span></a></li>
<li><a href="../interfaces/ListDatabasesResult.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>List<wbr/>Databases<wbr/>Result</span></a></li>
<li><a href="../interfaces/ListIndexesOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>List<wbr/>Indexes<wbr/>Options</span></a></li>
<li><a href="../interfaces/ModifyResult.html" class="deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Modify<wbr/>Result</span></a></li>
<li><a href="../interfaces/ModifyResult.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Modify<wbr/>Result</span></a></li>
<li><a href="../interfaces/MongoClientOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Mongo<wbr/>Client<wbr/>Options</span></a></li>
<li><a href="../interfaces/MongoCredentialsOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Mongo<wbr/>Credentials<wbr/>Options</span></a></li>
<li><a href="../interfaces/MongoNetworkErrorOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Mongo<wbr/>Network<wbr/>Error<wbr/>Options</span></a></li>
Expand All @@ -1543,6 +1544,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../interfaces/ResumeOptions.html" class="deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Resume<wbr/>Options</span></a></li>
<li><a href="../interfaces/RoleSpecification.html" class="deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Role<wbr/>Specification</span></a></li>
<li><a href="../interfaces/RootFilterOperators.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Root<wbr/>Filter<wbr/>Operators</span></a></li>
<li><a href="../interfaces/SearchIndexDescription.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Search<wbr/>Index<wbr/>Description</span></a></li>
<li><a href="../interfaces/SelectServerOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Select<wbr/>Server<wbr/>Options</span></a></li>
<li><a href="../interfaces/ServerApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>Api</span></a></li>
<li><a href="../interfaces/StreamDescriptionOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Stream<wbr/>Description<wbr/>Options</span></a></li>
Expand Down Expand Up @@ -1608,6 +1610,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../types/Join.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Join</span></a></li>
<li><a href="../types/KeysOfAType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Keys<wbr/>OfAType</span></a></li>
<li><a href="../types/KeysOfOtherType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Keys<wbr/>Of<wbr/>Other<wbr/>Type</span></a></li>
<li><a href="../types/ListSearchIndexesOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>List<wbr/>Search<wbr/>Indexes<wbr/>Options</span></a></li>
<li><a href="../types/MatchKeysAndValues.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Match<wbr/>Keys<wbr/>And<wbr/>Values</span></a></li>
<li><a href="../types/MongoClientEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Mongo<wbr/>Client<wbr/>Events</span></a></li>
<li><a href="../types/MongoErrorLabel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Mongo<wbr/>Error<wbr/>Label</span></a></li>
Expand Down
5 changes: 4 additions & 1 deletion docs/Next/classes/Admin.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="HostAddress.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Host<wbr/>Address</span></a></li>
<li><a href="ListCollectionsCursor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>List<wbr/>Collections<wbr/>Cursor</span></a></li>
<li><a href="ListIndexesCursor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>List<wbr/>Indexes<wbr/>Cursor</span></a></li>
<li><a href="ListSearchIndexesCursor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>List<wbr/>Search<wbr/>Indexes<wbr/>Cursor</span></a></li>
<li><a href="MongoAPIError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>MongoAPIError</span></a></li>
<li><a href="MongoAWSError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>MongoAWSError</span></a></li>
<li><a href="MongoAzureError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Mongo<wbr/>Azure<wbr/>Error</span></a></li>
Expand Down Expand Up @@ -523,7 +524,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../interfaces/ListDatabasesOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>List<wbr/>Databases<wbr/>Options</span></a></li>
<li><a href="../interfaces/ListDatabasesResult.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>List<wbr/>Databases<wbr/>Result</span></a></li>
<li><a href="../interfaces/ListIndexesOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>List<wbr/>Indexes<wbr/>Options</span></a></li>
<li><a href="../interfaces/ModifyResult.html" class="deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Modify<wbr/>Result</span></a></li>
<li><a href="../interfaces/ModifyResult.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Modify<wbr/>Result</span></a></li>
<li><a href="../interfaces/MongoClientOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Mongo<wbr/>Client<wbr/>Options</span></a></li>
<li><a href="../interfaces/MongoCredentialsOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Mongo<wbr/>Credentials<wbr/>Options</span></a></li>
<li><a href="../interfaces/MongoNetworkErrorOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Mongo<wbr/>Network<wbr/>Error<wbr/>Options</span></a></li>
Expand All @@ -542,6 +543,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../interfaces/ResumeOptions.html" class="deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Resume<wbr/>Options</span></a></li>
<li><a href="../interfaces/RoleSpecification.html" class="deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Role<wbr/>Specification</span></a></li>
<li><a href="../interfaces/RootFilterOperators.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Root<wbr/>Filter<wbr/>Operators</span></a></li>
<li><a href="../interfaces/SearchIndexDescription.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Search<wbr/>Index<wbr/>Description</span></a></li>
<li><a href="../interfaces/SelectServerOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Select<wbr/>Server<wbr/>Options</span></a></li>
<li><a href="../interfaces/ServerApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>Api</span></a></li>
<li><a href="../interfaces/StreamDescriptionOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Stream<wbr/>Description<wbr/>Options</span></a></li>
Expand Down Expand Up @@ -607,6 +609,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../types/Join.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Join</span></a></li>
<li><a href="../types/KeysOfAType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Keys<wbr/>OfAType</span></a></li>
<li><a href="../types/KeysOfOtherType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Keys<wbr/>Of<wbr/>Other<wbr/>Type</span></a></li>
<li><a href="../types/ListSearchIndexesOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>List<wbr/>Search<wbr/>Indexes<wbr/>Options</span></a></li>
<li><a href="../types/MatchKeysAndValues.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Match<wbr/>Keys<wbr/>And<wbr/>Values</span></a></li>
<li><a href="../types/MongoClientEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Mongo<wbr/>Client<wbr/>Events</span></a></li>
<li><a href="../types/MongoErrorLabel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Mongo<wbr/>Error<wbr/>Label</span></a></li>
Expand Down
9 changes: 7 additions & 2 deletions docs/Next/classes/AggregationCursor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><a href="AbstractCursor.html" class="tsd-signature-type tsd-kind-class">AbstractCursor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">TSchema</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li><span class="target">AggregationCursor</span></li></ul></li></ul></section><aside class="tsd-sources">
<li><span class="target">AggregationCursor</span>
<ul class="tsd-hierarchy">
<li><a href="ListSearchIndexesCursor.html" class="tsd-signature-type tsd-kind-class">ListSearchIndexesCursor</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/cursor/aggregation_cursor.ts#L28">src/cursor/aggregation_cursor.ts:28</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
Expand Down Expand Up @@ -1645,6 +1647,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="HostAddress.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Host<wbr/>Address</span></a></li>
<li><a href="ListCollectionsCursor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>List<wbr/>Collections<wbr/>Cursor</span></a></li>
<li><a href="ListIndexesCursor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>List<wbr/>Indexes<wbr/>Cursor</span></a></li>
<li><a href="ListSearchIndexesCursor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>List<wbr/>Search<wbr/>Indexes<wbr/>Cursor</span></a></li>
<li><a href="MongoAPIError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>MongoAPIError</span></a></li>
<li><a href="MongoAWSError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>MongoAWSError</span></a></li>
<li><a href="MongoAzureError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Mongo<wbr/>Azure<wbr/>Error</span></a></li>
Expand Down Expand Up @@ -1797,7 +1800,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../interfaces/ListDatabasesOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>List<wbr/>Databases<wbr/>Options</span></a></li>
<li><a href="../interfaces/ListDatabasesResult.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>List<wbr/>Databases<wbr/>Result</span></a></li>
<li><a href="../interfaces/ListIndexesOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>List<wbr/>Indexes<wbr/>Options</span></a></li>
<li><a href="../interfaces/ModifyResult.html" class="deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Modify<wbr/>Result</span></a></li>
<li><a href="../interfaces/ModifyResult.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Modify<wbr/>Result</span></a></li>
<li><a href="../interfaces/MongoClientOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Mongo<wbr/>Client<wbr/>Options</span></a></li>
<li><a href="../interfaces/MongoCredentialsOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Mongo<wbr/>Credentials<wbr/>Options</span></a></li>
<li><a href="../interfaces/MongoNetworkErrorOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Mongo<wbr/>Network<wbr/>Error<wbr/>Options</span></a></li>
Expand All @@ -1816,6 +1819,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../interfaces/ResumeOptions.html" class="deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Resume<wbr/>Options</span></a></li>
<li><a href="../interfaces/RoleSpecification.html" class="deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Role<wbr/>Specification</span></a></li>
<li><a href="../interfaces/RootFilterOperators.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Root<wbr/>Filter<wbr/>Operators</span></a></li>
<li><a href="../interfaces/SearchIndexDescription.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Search<wbr/>Index<wbr/>Description</span></a></li>
<li><a href="../interfaces/SelectServerOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Select<wbr/>Server<wbr/>Options</span></a></li>
<li><a href="../interfaces/ServerApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>Api</span></a></li>
<li><a href="../interfaces/StreamDescriptionOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Stream<wbr/>Description<wbr/>Options</span></a></li>
Expand Down Expand Up @@ -1881,6 +1885,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../types/Join.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Join</span></a></li>
<li><a href="../types/KeysOfAType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Keys<wbr/>OfAType</span></a></li>
<li><a href="../types/KeysOfOtherType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Keys<wbr/>Of<wbr/>Other<wbr/>Type</span></a></li>
<li><a href="../types/ListSearchIndexesOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>List<wbr/>Search<wbr/>Indexes<wbr/>Options</span></a></li>
<li><a href="../types/MatchKeysAndValues.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Match<wbr/>Keys<wbr/>And<wbr/>Values</span></a></li>
<li><a href="../types/MongoClientEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Mongo<wbr/>Client<wbr/>Events</span></a></li>
<li><a href="../types/MongoErrorLabel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Mongo<wbr/>Error<wbr/>Label</span></a></li>
Expand Down
Loading

0 comments on commit 777d57b

Please sign in to comment.