Skip to content

MLE-31992 add JSDoc block for planBuilder.cts.param #1113

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
RitaChen609 merged 1 commit into from
Aug 18, 2026
Merged

MLE-31992 add JSDoc block for planBuilder.cts.param #1113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions lib/plan-builder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,15 @@ bldrgen.AccessPlan.prototype.col = function(...args) {
return new bldrgen.PlanColumn('op', 'col', checkedArgs);
};

/**
* This function creates a placeholder for a cts query value bound at request time, for use as a
* sub-query or argument within a cts query tree (e.g. cts.andQuery, cts.orQuery, cts.wordQuery,
* cts.collectionQuery). Distinct from planBuilder#param, which creates an op-namespaced placeholder.
* @method planBuilder.cts#param
* @since 4.2.0
* @param { XsString } [name] - The name of the parameter.
* @returns { CtsParam }
*/
bldrgen.CtsExpr.prototype.param = function(...args) {
const paramdef = ['name', [types.XsString], true, false];
const checkedArgs = bldrbase.makeSingleArgs('cts.param', 1, paramdef, args);
Expand Down
Loading