minor js docs fixes

Oksydan · Sep 26, 2023 · 79e5a8e · 79e5a8e
1 parent 253c130
commit 79e5a8e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/_dev/js/theme/components/http/useHttpPayloadDefinition.js b/_dev/js/theme/components/http/useHttpPayloadDefinition.js
@@ -69,7 +69,7 @@ const useHttpPayloadDefinition = (payload, definition) => {
    * @param {string} fieldName - name of field
    * @param {any} value - value of field
    * @param {object} fieldDefinition - definition for field
-   * @returns {*[]}
+   * @returns {string[]}
    */
   const validate = (fieldName, value, fieldDefinition) => {
     const validateErrors = [];
@@ -150,7 +150,7 @@ const useHttpPayloadDefinition = (payload, definition) => {
    * Validates definition for field and returns errors
    * @param fieldName
    * @param fieldsDefinition
-   * @returns {*[]}
+   * @returns {string[]}
    */
   const validateDefinitionForField = (fieldName, fieldsDefinition) => {
     const definitionErrors = [];
@@ -169,7 +169,7 @@ const useHttpPayloadDefinition = (payload, definition) => {
    * @method
    * Validates definition and returns errors
    * @param fieldsDefinition
-   * @returns {*[]}
+   * @returns {string[]}
    */
   const validateDefinition = (fieldsDefinition) => {
     const definitionErrors = [];
@@ -189,7 +189,7 @@ const useHttpPayloadDefinition = (payload, definition) => {
   /**
    * @method
    * Validates payload against definition and returns errors
-   * @returns {*[]}
+   * @returns {string[]}
    */
   const validatePayload = () => {
     const payloadErrors = [];

diff --git a/_dev/js/theme/core/listing/request/updateListingFacetsRequest.js b/_dev/js/theme/core/listing/request/updateListingFacetsRequest.js
@@ -14,15 +14,15 @@ const { dispatch, abortAll } = useHttpController();
  * @property {int} pagination.items_shown_from - pagination items shown from
  * @property {int} pagination.items_shown_to - pagination items shown to
  * @property {array} pagination.pages - pagination pages array
- * @property {array[object]} products - array of front representations of products
+ * @property {object[]} products - array of front representations of products
  * @property {string} rendered_active_filters - active filters html content
  * @property {string} rendered_facets - facets html content
  * @property {string} rendered_products - listing products html content
  * @property {string} rendered_products_bottom - listing products bottom html content
  * @property {string} rendered_products_header - listing products header html content
  * @property {string} rendered_products_top - listing products top html content
  * @property {object} result - result empty object
- * @property {array[object]} sort_orders - available sort orders
+ * @property {object[]} sort_orders - available sort orders
  * @property {string} sort_selected - selected sort order
  */