Skip to content

Update documentation for transform params #298

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Sep 27, 2016
Merged

Update documentation for transform params #298

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1cd9c32
Update documents#write to address transform param as array
wooldridge Sep 27, 2016
7f18132
Update documents#read, documents#createWriteStream documentation
wooldridge Sep 27, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions lib/documents.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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;
Expand Down