diff --git a/lib/documents.js b/lib/documents.js index e31fc41a..302ad0dd 100644 --- a/lib/documents.js +++ b/lib/documents.js @@ -169,7 +169,7 @@ function wipeOutputTransform(/*headers, data*/) { /** * Categories of information to read or write for documents. * The possible values of the enumeration are - * content|collections|permissions|properties|quality|metadataValues|metadata where + * content|collections|metadataValues|permissions|properties|quality|metadata|none where * metadata is an alias for all of the categories other than content. * @typedef {enum} documents.categories */ diff --git a/lib/query-builder.js b/lib/query-builder.js index 770cd01c..6123c711 100644 --- a/lib/query-builder.js +++ b/lib/query-builder.js @@ -4983,7 +4983,10 @@ function snippet() { /** * Sets the withOptions clause of a built query to configure the query; * takes a configuration object with the following named parameters. - * This function may be called on the result of building a query. + * This function may be called on the result of building a query. When the + * 'debug', 'metrics', 'queryPlan', or 'similarDocs' parameter is set, a + * search summary object will be returned along with the result documents. + * When 'categories' is set to 'none', only a search summary is returned. * @method * @memberof queryBuilder# * @param {documents.categories} [categories] - the categories of information @@ -4991,7 +4994,8 @@ function snippet() { * @param {number} [concurrencyLevel] - the maximum number of threads to use to calculate facets * @param {...string} [forestNames] - the names of forests providing documents * for the result set - * @param {...string} [search] - options modifying the default behaviour of the query + * @param {...string} [search] - options + * modifying the default behaviour of the query * @param {string|transactions.Transaction} [txid] - a string * transaction id or Transaction object identifying an open * multi-statement transaction