Skip to content

Fix: build error due to jsdoc #2317

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
allyoucanmap merged 2 commits into from
Jan 9, 2026
Merged

Fix: build error due to jsdoc #2317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48d78ba
Fix: build error due to jsdoc
Jan 8, 2026
744268c
updated hook js doc
Jan 8, 2026
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
5 changes: 2 additions & 3 deletions ...de_mapstore_client/client/js/plugins/DocumentsCatalog/containers/DocumentsFiltersForm.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,9 @@ import { isMenuItemSupportedSupported } from '@mapstore/framework/utils/Resource

/**
* This renders a configurable input filters for documents catalog
* @class
* @name DocumentsFiltersForm
* @prop {object[]} cfg.fields array of filter object configurations
* @example
* @prop {object[]} props.fields array of filter object configurations
Copy link

@gemini-code-assist gemini-code-assist bot Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better JSDoc accuracy and clarity, it's best to refer to the prop by its actual name as expected by the component. Since the prop is named fields, the documentation should reflect that instead of props.fields.

Suggested change
* @prop {object[]} props.fields array of filter object configurations
* @prop {object[]} fields array of filter object configurations

* @private
*/
function DocumentsFiltersForm({
id = 'ms-filter-form',
Expand Down
1 change: 1 addition & 0 deletions ...ode_mapstore_client/client/js/plugins/DocumentsCatalog/hooks/useQueryResourcesByParams.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ const mergeParams = (params, defaultQuery) => {
* @param {func} props.request function returning the resources request
* @param {object} props.defaultQuery default query object always applied to the requests
* @param {number} props.pageSize page size for the request
* @private
*/

const useQueryResourcesByParams = ({
Expand Down