diff --git a/lib/documents.js b/lib/documents.js index 0c96f5fe..366c913f 100644 --- a/lib/documents.js +++ b/lib/documents.js @@ -289,9 +289,9 @@ function singleReadOutputTransform(headers, data) { * @param {string|transactions.Transaction} [txid] - a string * transaction id or Transaction object identifying an open * multi-statement transaction - * @param {string} [transform] - the name of a transform extension to apply - * to each document; the transform must have been installed using - * the {@link transforms#write} function. + * @param {string|mixed[]} [transform] - the name of a transform extension to apply to each document + * or an array with the name of the transform extension and an object of parameter values; the + * transform must have been installed using the {@link transforms#write} function. * @param {number[]} [range] - the range of bytes to extract * from a binary document; the range is specified with a zero-based * start byte and the position after the end byte as in Array.slice() @@ -458,9 +458,9 @@ function readDocumentsImpl(contentOnly, args) { * @param {string|transactions.Transaction} [txid] - a string * transaction id or Transaction object identifying an open * multi-statement transaction - * @param {string} [transform] - the name of a transform extension to apply - * to the document; the transform must have been installed using - * the {@link transforms#write} function. + * @param {string|mixed[]} [transform] - the name of a transform extension to apply to each document + * or an array with the name of the transform extension and an object of parameter values; the + * transform must have been installed using the {@link transforms#write} function. * @returns {WritableStream} a stream for writing the database document; the * stream object also has a result() function that takes * a {@link documents#writeResult} success callback. @@ -606,9 +606,9 @@ function writeListOutputTransform(headers, data) { * @param {string|transactions.Transaction} [txid] - a string * transaction id or Transaction object identifying an open * multi-statement transaction - * @param {string} [transform] - the name of a transform extension to apply - * to each document; the transform must have been installed using - * the {@link transforms#write} function. + * @param {string|mixed[]} [transform] - the name of a transform extension to apply to each document + * or an array with the name of the transform extension and an object of parameter values; the + * transform must have been installed using the {@link transforms#write} function. * @param {string} [forestName] - the name of a forest in which to write * the documents. * @param {string} [temporalCollection] - the name of the temporal collection;