feat(FindCursor): fluent builder for allowDiskUse option #2678
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mbroadst
reviewed
Dec 16, 2020
src/operations/find.ts
Outdated
| @@ -52,7 +52,7 @@ export interface FindOptions extends CommandOperationOptions { | |||
| noCursorTimeout?: boolean; | |||
| /** Specify collation (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields). */ | |||
| collation?: CollationOptions; | |||
| /** Enables writing to temporary files on the server. */ | |||
| /** Allows disk use for blocking sort operations exceeding 100MB memory. */ | |||
There was a problem hiding this comment.
I wonder if this might be a good opportunity to experiment with improving these docs even more by linking to them: https://docs.mongodb.com/manual/reference/command/find/#find-cmd-allowdiskuse
Also, does typedoc support any way of marking an option supported since a certain MongoDB version? It would be cool to use jsdoc's @since tag here
There was a problem hiding this comment.
@since is not supported by tsdoc unfortunately, but we could maybe use @remarks to separate summary/details? E.g.
/**
* Allows disk use for blocking sort operations exceeding 100MB memory.
* @remarks
* Since MongoDB 3.2.
* {@link https://docs.mongodb.com/manual/reference/command/find/#find-cmd-allowdiskuse | find command allowDiskUse documentation}
*/
nbbeeken
approved these changes
Dec 21, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
NODE-2955