test: path to file url

Author: KatoakDR

electron/main/electron-next/__tests__/path-to-file-url.test.ts

@@ -13,13 +13,13 @@ describe('path-to-file-url', () => {
   });
 
   describe('#pathToFileURL', () => {
-    it('...', async () => {
+    it('returns absolute file url to directory path joined with file path', async () => {
       expect(
         pathToFileURL({
           dirPath: '/a/b/',
-          filePath: '/a/b/c.html',
+          filePath: 'c.html',
         })
-      ).toBe(true);
+      ).toEqual('file:///a/b/c.html');
     });
   });
 });

electron/main/electron-next/path-to-file-url.ts

@@ -2,11 +2,17 @@ import path from 'node:path';
 import url from 'node:url';
 
 /**
- * Converts a file path to an absolute file URL.
- * Example: '/path/to/file.txt' -> 'file:///path/to/file.txt'
+ * Converts a relative file path to an absolute file URL.
+ * Example: 'file.txt' -> 'file:///path/to/file.txt'
  */
 export const pathToFileURL = (options: {
+  /**
+   * The directory path to resolve the file path against.
+   */
   dirPath: string;
+  /**
+   * The relative file path to convert to a file URL.
+   */
   filePath: string;
 }): string => {
   const { dirPath, filePath } = options;