feat(api): rejecting promise depending on the success to standarized the api

Author: mateoguzmana

example/src/App.tsx

@@ -52,8 +52,6 @@ export default function App() {
   const executeGetLz4VersionNumber = async () => {
     const _versionNumber = await getLz4VersionNumber();
 
-    console.log({ _versionNumber });
-
     setVersionNumber(_versionNumber);
   };
 
@@ -95,7 +93,12 @@ export default function App() {
             operation: 'compress',
           });
         } catch (error) {
-          console.log({ error });
+          setFileOperationResult({
+            ...(error as FileOperationResult),
+            sourcePath,
+            destinationPath,
+            operation: 'compress',
+          });
         }
       }
     } catch (error) {
@@ -106,26 +109,35 @@ export default function App() {
   const executeCompressFileUsingDocumentPicker = async () => {
     onReset();
 
-    const [file] = await pick({ copyTo: 'cachesDirectory' });
-
-    if (!file || !file.fileCopyUri) return;
-
-    const sourcePath = file.fileCopyUri;
-    const destinationPath = file.fileCopyUri.replace(/(.*)(\..*)/, '$1.lz4');
-
     try {
-      const decompressFileResult = await compressFile(
-        sourcePath,
-        destinationPath,
-        onProgress
-      );
-
-      setFileOperationResult({
-        ...decompressFileResult,
-        sourcePath,
-        destinationPath,
-        operation: 'compress',
-      });
+      const [file] = await pick({ copyTo: 'cachesDirectory' });
+
+      if (!file || !file.fileCopyUri) return;
+
+      const sourcePath = file.fileCopyUri;
+      const destinationPath = file.fileCopyUri.replace(/(.*)(\..*)/, '$1.lz4');
+
+      try {
+        const compressFileResult = await compressFile(
+          sourcePath,
+          destinationPath,
+          onProgress
+        );
+
+        setFileOperationResult({
+          ...compressFileResult,
+          sourcePath,
+          destinationPath,
+          operation: 'compress',
+        });
+      } catch (error) {
+        setFileOperationResult({
+          ...(error as FileOperationResult),
+          sourcePath,
+          destinationPath,
+          operation: 'compress',
+        });
+      }
     } catch (error) {
       console.log({ error });
     }
@@ -134,26 +146,35 @@ export default function App() {
   const executeDecompressFile = async () => {
     onReset();
 
-    const [file] = await pick({ copyTo: 'cachesDirectory' });
-
-    if (!file || !file.fileCopyUri) return;
-
-    const sourcePath = file.fileCopyUri;
-    const destinationPath = file.fileCopyUri.replace(/(.*)(\..*)/, '$1.lz4');
-
     try {
-      const decompressFileResult = await decompressFile(
-        sourcePath,
-        destinationPath,
-        onProgress
-      );
-
-      setFileOperationResult({
-        ...decompressFileResult,
-        sourcePath,
-        destinationPath,
-        operation: 'decompress',
-      });
+      const [file] = await pick({ copyTo: 'cachesDirectory' });
+
+      if (!file || !file.fileCopyUri) return;
+
+      const sourcePath = file.fileCopyUri;
+      const destinationPath = file.fileCopyUri.replace(/(.*)(\..*)/, '$1.lz4');
+
+      try {
+        const decompressFileResult = await decompressFile(
+          sourcePath,
+          destinationPath,
+          onProgress
+        );
+
+        setFileOperationResult({
+          ...decompressFileResult,
+          sourcePath,
+          destinationPath,
+          operation: 'decompress',
+        });
+      } catch (error) {
+        setFileOperationResult({
+          ...(error as FileOperationResult),
+          sourcePath,
+          destinationPath,
+          operation: 'decompress',
+        });
+      }
     } catch (error) {
       console.log({ error });
     }

src/__tests__/index.test.ts

@@ -32,7 +32,7 @@ describe('LZ4 Module', () => {
     (global as any).lz4 = {
       getLz4VersionNumber: jest.fn(() => Promise.resolve(1001)),
       getLz4VersionString: jest.fn(() => Promise.resolve('1.0.0')),
-      performFileOperation: jest.fn(() => Promise.resolve(fileOperationResult)),
+      performFileOperation: jest.fn(() => fileOperationResult),
     };
   });
 

src/index.tsx

@@ -50,12 +50,20 @@ export function compressFile(
   const strippedSourcePath = formatFilePath(sourcePath);
   const strippedDestinationPath = formatFilePath(destinationPath);
 
-  return _global.lz4.performFileOperation(
+  const result = _global.lz4.performFileOperation(
     'compress',
     strippedSourcePath,
     strippedDestinationPath,
     onProgress
   );
+
+  return new Promise((resolve, reject) => {
+    if (result.success) {
+      resolve(result);
+    } else {
+      reject(result);
+    }
+  });
 }
 
 /**
@@ -73,12 +81,20 @@ export function decompressFile(
   const strippedSourcePath = formatFilePath(sourcePath);
   const strippedDestinationPath = formatFilePath(destinationPath);
 
-  return _global.lz4.performFileOperation(
-    'decompress',
-    strippedSourcePath,
-    strippedDestinationPath,
-    onProgress
-  );
+  return new Promise((resolve, reject) => {
+    const result = _global.lz4.performFileOperation(
+      'decompress',
+      strippedSourcePath,
+      strippedDestinationPath,
+      onProgress
+    );
+
+    if (result.success) {
+      resolve(result);
+    } else {
+      reject(result);
+    }
+  });
 }
 
 export type { FileOperationResult, FileOperationMode } from './types';

src/types.ts

@@ -38,6 +38,6 @@ export interface Lz4Type {
       sourcePath: string,
       destinationPath: string,
       onProgress?: (processedSize: number, totalSize: number) => void
-    ) => Promise<FileOperationResult>;
+    ) => FileOperationResult;
   };
 }