Skip to content
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

feat(FindCursor): fluent builder for allowDiskUse option #2678

Merged
merged 6 commits into from
Dec 21, 2020

Conversation

emadum
Copy link
Contributor

@emadum emadum commented Dec 15, 2020

@emadum emadum marked this pull request as ready for review December 16, 2020 00:24
package.json Outdated Show resolved Hide resolved
@@ -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. */
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

@emadum emadum Dec 16, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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}
 */

test/functional/cursor.test.js Outdated Show resolved Hide resolved
src/cursor/find_cursor.ts Show resolved Hide resolved
Copy link
Member

@mbroadst mbroadst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@emadum emadum requested a review from nbbeeken December 17, 2020 20:02
@emadum emadum merged commit d442aac into master Dec 21, 2020
@emadum emadum deleted the NODE-2955/cursor-sort-allow-disk-use branch December 21, 2020 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants