Document pageFilter and PageSelector usage

Adding jsdoc comments allows for easier usage of both in the IDE.
greenbone · Jan 15, 2025 · baeba3b · baeba3b
1 parent 30401d5
commit baeba3b
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/src/web/store/pages/actions.js b/src/web/store/pages/actions.js
@@ -5,6 +5,13 @@
 
 export const CHANGE_PAGE_FILTER = 'CHANGE_PAGE_FILTER';
 
+/**
+ * Action creator to set a filter for a page
+ *
+ * @param {String} page
+ * @param {Filter} filter
+ * @returns A dispatchable action
+ */
 export const pageFilter = (page, filter) => ({
   type: CHANGE_PAGE_FILTER,
   page,

diff --git a/src/web/store/pages/selectors.js b/src/web/store/pages/selectors.js
@@ -16,6 +16,12 @@ class PageSelector {
   }
 }
 
+/**
+ * Get a PageSelector from the root state
+ *
+ * @param {Object} rootState
+ * @returns {PageSelector} A PageSelector instance
+ */
 const getPage = (rootState = {}) => new PageSelector(rootState.pages);
 
 export default getPage;