add comment

4dn-dcic · Jul 28, 2024 · cd35f9d · cd35f9d
1 parent 80c3794
commit cd35f9d
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/es/components/ui/Alerts.js b/es/components/ui/Alerts.js
@@ -98,7 +98,12 @@ export var Alerts = /*#__PURE__*/function (_React$Component) {
     }
   }], [{
     key: "setStore",
-    value: /** This must be called with the current Redux store for the app before Alerts can be used. */
+    value:
+    /**
+     * This must be called with the current Redux store for the app before Alerts can be used.
+     * @param {*} useStore
+     * @param {*} isLegacy pass false to use new redux v5 dispatcher call ({ type: 'STRING', payload: ... })
+     */
     function setStore(useStore, isLegacy) {
       store = useStore;
       if (typeof isLegacy === 'boolean') {

diff --git a/src/components/ui/Alerts.js b/src/components/ui/Alerts.js
@@ -21,7 +21,11 @@ let reduxIsLegacy = true;
  */
 export class Alerts extends React.Component {
 
-    /** This must be called with the current Redux store for the app before Alerts can be used. */
+    /**
+     * This must be called with the current Redux store for the app before Alerts can be used.
+     * @param {*} useStore
+     * @param {*} isLegacy pass false to use new redux v5 dispatcher call ({ type: 'STRING', payload: ... })
+     */
     static setStore(useStore, isLegacy){
         store = useStore;
         if (typeof isLegacy === 'boolean') {