From 3f42a809f64abdd953839af500bd5d18059da8fe Mon Sep 17 00:00:00 2001 From: mudaafi Date: Fri, 14 Nov 2025 11:35:27 +0800 Subject: [PATCH] update docs --- src/modules/search.js | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/modules/search.js b/src/modules/search.js index 05f3a081..cbe1691a 100644 --- a/src/modules/search.js +++ b/src/modules/search.js @@ -162,13 +162,13 @@ class Search { * @param {string} [parameters.sortBy='relevance'] - The sort method for results * @param {string} [parameters.sortOrder='descending'] - The sort order for results * @param {string} [parameters.section='Products'] - The section name for results - * @param {object} [parameters.fmtOptions] - The format options used to refine result groups. Please refer to https://docs.constructor.com/reference/search-search-resultsqueries for details + * @param {object} [parameters.fmtOptions] - The format options used to refine result groups. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results#query-params for details * @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.com/reference/configuration-collections * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return * @param {string[]} [parameters.hiddenFacets] - Hidden facets to return * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details - * @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results - * @param {object} [parameters.filterMatchTypes] - An object specifying whether results must match `all`, `any` or `none` of a given filter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results + * @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results#query-params + * @param {object} [parameters.filterMatchTypes] - An object specifying whether results must match `all`, `any` or `none` of a given filter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results#query-params * @param {object} [networkParameters] - Parameters relevant to the network request * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds) * @returns {Promise} @@ -245,12 +245,12 @@ class Search { * @param {number} [parameters.offset] - The number of results to skip from the beginning (Can't be used together with page) * @param {number} [parameters.resultsPerPage] - The number of results per page to return * @param {string} [parameters.section='Products'] - The section name for results - * @param {object} [parameters.fmtOptions] - The format options used to refine result groups. Please refer to https://docs.constructor.com/reference/search-search-resultsqueries for details + * @param {object} [parameters.fmtOptions] - The format options used to refine result groups. Please refer to https://docs.constructor.com/reference/v1-search-get-natural-language-search-results#query-params for details * @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.com/reference/configuration-collections * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return * @param {string[]} [parameters.hiddenFacets] - Hidden facets to return - * @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results + * @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/v1-search-get-natural-language-search-results#query-params * @param {object} [networkParameters] - Parameters relevant to the network request * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds) * @returns {Promise}