[TS migration] Migrate 'sleep.js', 'NativeCommandsAction.js', 'wrapOnyxWithWaitForBatchedUpdates.js', 'waitForNetworkPromises.js' and 'waitForBatchedUpdates.js' tests to TypeScript

src/libs/E2E/client.ts

@@ -113,3 +113,5 @@ export default {
     updateNetworkCache,
     getNetworkCache,
 };
+
+export type {NativeCommand};

tests/e2e/nativeCommands/NativeCommandsAction.js → tests/e2e/nativeCommands/NativeCommandsAction.ts

@@ -1,17 +1,19 @@
+import type {NativeCommand} from '@libs/E2E/client';
+
 const NativeCommandsAction = {
     scroll: 'scroll',
     type: 'type',
     backspace: 'backspace',
-};
+} as const;
 
-const makeTypeTextCommand = (text) => ({
+const makeTypeTextCommand = (text: string): NativeCommand => ({
     actionName: NativeCommandsAction.type,
     payload: {
         text,
     },
 });
 
-const makeBackspaceCommand = () => ({
+const makeBackspaceCommand = (): NativeCommand => ({
     actionName: NativeCommandsAction.backspace,
 });
 

tests/e2e/utils/sleep.js → tests/e2e/utils/sleep.ts

@@ -1,5 +1,7 @@
-export default function sleep(ms) {
+function sleep(ms: number): Promise<void> {
     return new Promise((resolve) => {
         setTimeout(resolve, ms);
     });
 }
+
+export default sleep;

tests/utils/waitForBatchedUpdates.js → tests/utils/waitForBatchedUpdates.ts

@@ -10,10 +10,8 @@ import getIsUsingFakeTimers from './getIsUsingFakeTimers';
  *  than to do
  *  ❌  Onyx.merge(...)
  *      waitForBatchedUpdates().then(...)
- *
- * @returns {Promise}
  */
-export default () =>
+const waitForBatchedUpdates = (): Promise<void> =>
     new Promise((outerResolve) => {
         // We first need to exhaust the microtask queue, before we schedule the next task in the macrotask queue (setTimeout).
         // This is because we need to wait for all async onyx operations to finish, as they might schedule other macrotasks,
@@ -38,3 +36,5 @@ export default () =>
             setTimeout(outerResolve, 0);
         });
     });
+
+export default waitForBatchedUpdates;

tests/utils/waitForNetworkPromises.js → tests/utils/waitForNetworkPromises.ts

@@ -8,7 +8,7 @@ import waitForBatchedUpdates from './waitForBatchedUpdates';
  *  than to do
  *  ❌  Onyx.merge(...)
  *      waitForBatchedUpdates().then(...)
- *
- * @returns {Promise}
  */
-export default () => waitForBatchedUpdates().then(waitForBatchedUpdates);
+const waitForNetworkPromises = (): Promise<void> => waitForBatchedUpdates().then(waitForBatchedUpdates);
+
+export default waitForNetworkPromises;

tests/utils/wrapOnyxWithWaitForBatchedUpdates.js → tests/utils/wrapOnyxWithWaitForBatchedUpdates.ts

@@ -1,3 +1,4 @@
+import type Onyx from 'react-native-onyx';
 import waitForBatchedUpdates from './waitForBatchedUpdates';
 
 /**
@@ -7,14 +8,14 @@ import waitForBatchedUpdates from './waitForBatchedUpdates';
  * are rendered with the onyx data.
  * This is a convinience function, which wraps the onyxInstance's
  * functions, to for the promises to resolve.
- *
- * @param {Object} onyxInstance
  */
-export default function wrapOnyxWithWaitForBatchedUpdates(onyxInstance) {
+function wrapOnyxWithWaitForBatchedUpdates(onyxInstance: typeof Onyx) {
     const multiSetImpl = onyxInstance.multiSet;
     // eslint-disable-next-line no-param-reassign
     onyxInstance.multiSet = (...args) => multiSetImpl(...args).then((result) => waitForBatchedUpdates().then(() => result));
     const mergeImpl = onyxInstance.merge;
     // eslint-disable-next-line no-param-reassign
     onyxInstance.merge = (...args) => mergeImpl(...args).then((result) => waitForBatchedUpdates().then(() => result));
 }
+
+export default wrapOnyxWithWaitForBatchedUpdates;