Skip to content

Commit 7f18132

Browse files
committed
Update documents#read, documents#createWriteStream documentation
1 parent 1cd9c32 commit 7f18132

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

lib/documents.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -289,9 +289,9 @@ function singleReadOutputTransform(headers, data) {
289289
* @param {string|transactions.Transaction} [txid] - a string
290290
* transaction id or Transaction object identifying an open
291291
* multi-statement transaction
292-
* @param {string} [transform] - the name of a transform extension to apply
293-
* to each document; the transform must have been installed using
294-
* the {@link transforms#write} function.
292+
* @param {string|mixed[]} [transform] - the name of a transform extension to apply to each document
293+
* or an array with the name of the transform extension and an object of parameter values; the
294+
* transform must have been installed using the {@link transforms#write} function.
295295
* @param {number[]} [range] - the range of bytes to extract
296296
* from a binary document; the range is specified with a zero-based
297297
* start byte and the position after the end byte as in Array.slice()
@@ -458,9 +458,9 @@ function readDocumentsImpl(contentOnly, args) {
458458
* @param {string|transactions.Transaction} [txid] - a string
459459
* transaction id or Transaction object identifying an open
460460
* multi-statement transaction
461-
* @param {string} [transform] - the name of a transform extension to apply
462-
* to the document; the transform must have been installed using
463-
* the {@link transforms#write} function.
461+
* @param {string|mixed[]} [transform] - the name of a transform extension to apply to each document
462+
* or an array with the name of the transform extension and an object of parameter values; the
463+
* transform must have been installed using the {@link transforms#write} function.
464464
* @returns {WritableStream} a stream for writing the database document; the
465465
* stream object also has a result() function that takes
466466
* a {@link documents#writeResult} success callback.
@@ -607,7 +607,7 @@ function writeListOutputTransform(headers, data) {
607607
* transaction id or Transaction object identifying an open
608608
* multi-statement transaction
609609
* @param {string|mixed[]} [transform] - the name of a transform extension to apply to each document
610-
* or an array including the name of the transform extension and an object of parameter values; the
610+
* or an array with the name of the transform extension and an object of parameter values; the
611611
* transform must have been installed using the {@link transforms#write} function.
612612
* @param {string} [forestName] - the name of a forest in which to write
613613
* the documents.

0 commit comments

Comments
 (0)