Node 28 : Document the writeAll Api. #610
Merged
Conversation
This file contains hidden or 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
ehennum
approved these changes
Oct 1, 2021
lib/documents.js
Outdated
| * @param {function(progress, documents, error)} [onBatchError] - Responds to any error while writing a batch of documents. | ||
| * @param {function(summary)} [onCompletion] - Provides a summary of the results. | ||
| * @param {Integer} [batchSize] - The number of documents in each batch. | ||
| * @param {object[]} [concurrentRequests] - JavaScript object literal that controls the maximum number of concurrent |
There was a problem hiding this comment.
Given that the parameter accepts only one object, would the correct type be object instead of object[]?
The same concern applies to defaultMetadata
lib/documents.js
Outdated
| * requests that can be pending at the same time. Valid keys are "multipleOf" and "multiplier". | ||
| * @param {object[]} [defaultMetadata] - the metadata values applied to each document including collections, | ||
| * permissions, properties, quality, and metadataValues. | ||
| * @param {object[]} [transform] - transformSpecification applied to each document. |
There was a problem hiding this comment.
Should this have the same JSDoc as writeDocuments(): @param {string|mixed[]} [transform]
lib/documents.js
Outdated
| * @param {object[]} [defaultMetadata] - the metadata values applied to each document including collections, | ||
| * permissions, properties, quality, and metadataValues. | ||
| * @param {object[]} [transform] - transformSpecification applied to each document. | ||
| * @returns {PassThrough|stream} - a stream.Writable in object mode that receives document descriptor input from the |
There was a problem hiding this comment.
The type should be stream.Writable to align with the comment.
Internally, the current implementation uses the stream.PassThrough subclass of stream.Writable, but the user doesn't need to know and that could change to a different subclass of stream.Writable at the convenience of the maintainers of the Node.js API.
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.
No description provided.