Skip to content

Commit b21b96b

Browse files
committed
Add to jsdocs about withOptions(), categories
1 parent 5aad4a8 commit b21b96b

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

lib/documents.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ function wipeOutputTransform(/*headers, data*/) {
169169
/**
170170
* Categories of information to read or write for documents.
171171
* The possible values of the enumeration are
172-
* content|collections|permissions|properties|quality|metadataValues|metadata where
172+
* content|collections|metadataValues|permissions|properties|quality|metadata|none where
173173
* metadata is an alias for all of the categories other than content.
174174
* @typedef {enum} documents.categories
175175
*/

lib/query-builder.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4986,14 +4986,16 @@ function snippet() {
49864986
* This function may be called on the result of building a query. When the
49874987
* 'debug', 'metrics', 'queryPlan', or 'similarDocs' parameter is set, a
49884988
* search summary object will be returned along with the result documents.
4989+
* When 'categories' is set to 'none', only a search summary is returned.
49894990
* @method
49904991
* @memberof queryBuilder#
49914992
* @param {documents.categories} [categories] - the categories of information
49924993
* to retrieve for the result documents
49934994
* @param {number} [concurrencyLevel] - the maximum number of threads to use to calculate facets
49944995
* @param {...string} [forestNames] - the names of forests providing documents
49954996
* for the result set
4996-
* @param {...string} [search] - options modifying the default behaviour of the query
4997+
* @param {...string} [search] - <a href="https://docs.marklogic.com/guide/search-dev/appendixa#id_77801">options</a>
4998+
* modifying the default behaviour of the query
49974999
* @param {string|transactions.Transaction} [txid] - a string
49985000
* transaction id or Transaction object identifying an open
49995001
* multi-statement transaction

0 commit comments

Comments
 (0)