improve JSDoc

Author: econdepe

lib/constants.js

@@ -533,4 +533,4 @@ export const TOKEN_TYPES = {
 
 export const LABEL_LEGACY_MESSAGE = '11';
 export const QUERY_LEGACY_MESSAGES_MAX_PAGESIZE = 150;
-export const UPDATE_MESSAGE_SUCESS_CODE = 1000;
+export const UPDATE_BODY_SUCESS_CODE = 1000;

lib/legacyMessages/helpers.js

@@ -1,23 +1,28 @@
 import { encryptMessage, decryptMessageLegacy } from 'pmcrypto';
 // import { fromUnixTime } from 'date-fns';
 
-import { LABEL_LEGACY_MESSAGE, QUERY_LEGACY_MESSAGES_MAX_PAGESIZE, UPDATE_MESSAGE_SUCESS_CODE } from '../constants';
+import { LABEL_LEGACY_MESSAGE, QUERY_LEGACY_MESSAGES_MAX_PAGESIZE, UPDATE_BODY_SUCESS_CODE } from '../constants';
 import { chunk } from '../helpers/array';
 import { wait } from '../helpers/promise';
 import { noop } from '../helpers/function';
 
 const fromUnixTime = (Time = 0) => new Date(Time * 1000);
 
 const LEGACY_MESSAGES_CHUNK_SIZE = 5; // how many messages we want to decrypt and encrypt simultaneously
+const RELAX_TIME = 5 * 1000; // 5s . Time to wait (for other operations) after a batch of legacy messages has been migrated
 
 /**
  * Given a list of legacy message IDs, fetch, decrypt, re-encrypt and send them to API
  * @param {Array<String>} messageIDs        List of IDs of legacy messages
  * @param {AbortController.signal} signal   { aborted: true/false }
- * @param {Function} obj.getMessage
- * @param {Function} obj.updateBody
- * @param {Function} obj.getPrivateKeys
+ * @param {Function} obj.getMessage         Retrive message from database by ID
+ * @param {Function} obj.updateBody         Replace body of a message identified by ID
+ * @param {Function} obj.getPrivateKeys     Get privateKeys corresponding to an address ID
  * @param {Function} obj.onError
+ *
+ * @return {Object}                         { noneMigratedInBatch: false is some message from the batch is succesfully migrated. True otherwise }
+ *
+ * @dev    The keys returned by getPrivateKeys must have the method toPublic()
  */
 const clearSome = async (messageIDs = [], { signal, getMessage, updateBody, getPrivateKeys, onError = noop }) => {
     if (!messageIDs.length) {
@@ -68,7 +73,7 @@ const clearSome = async (messageIDs = [], { signal, getMessage, updateBody, getP
                 }
                 // Send re-encrypted message to API
                 const { Code } = await updateBody({ ID, Body: newBody });
-                if (Code === UPDATE_MESSAGE_SUCESS_CODE) {
+                if (Code === UPDATE_BODY_SUCESS_CODE) {
                     noneMigratedInBatch = false;
                 }
                 return;
@@ -84,6 +89,15 @@ const clearSome = async (messageIDs = [], { signal, getMessage, updateBody, getP
 
 /**
  * Fetch legacy messages, re-encrypt and send them to API
+ * @param {AbortController.signal} signal   { aborted: true/false }
+ * @param {Number} page                     Legacy messages query parameter
+ * @param {Function} obj.queryMessages      Retrive legacy messages from database
+ * @param {Function} obj.getMessage         Retrive message from database by ID
+ * @param {Function} obj.updateBody         Replace body of a message identified by ID
+ * @param {Function} obj.getPrivateKeys     Get privateKeys corresponding to an address ID
+ * @param {Function} obj.onError
+ *
+ * @dev    The keys returned by getPrivateKeys must have the method toPublic()
  */
 export const clearAll = async ({
     signal,
@@ -94,8 +108,6 @@ export const clearAll = async ({
     getPrivateKeys,
     onError
 }) => {
-    const RELAX_TIME = 5 * 1000; // 5s
-
     if (signal.aborted) {
         return;
     }