Applying PR Reviews

Author: ismi29ch

index.d.ts

@@ -1,19 +1,25 @@
-
 /**
-  This function is used to determine the filename for each downloaded file.
-  @param options - The options for renaming.
-  @returns The new filename for the downloaded file.
+  @param options   -  The options for renaming.
+  
+  @returns         -  The new filename for the downloaded file.
+
+  @description     -  This function is used to determine the filename for each downloaded file.
 */
-export type RenameFunction = (options: {url: string; index: number; urls: string[]}) => string;
+export type RenameFunction = (options: {
+	url: string;
+	index: number;
+	urls: string[];
+}) => string;
 
 /*
   Options for the multiDownload function.
  */
-export type MultiDownloadOptions = {
+export type Options = {
 	/**
-	  The function to rename the downloaded files.
-	  @default undefined (use original filenames)
-	 */
+	  @default undefined  - (use original filenames)
+    
+	  @description        - A function that returns the new filename for each downloaded file.
+    */
 	rename?: RenameFunction;
 	/**
 	  The delay time between each file download in milliseconds.
@@ -23,36 +29,42 @@ export type MultiDownloadOptions = {
 };
 
 /**
-  Download multiple files from an array of URLs.
-  @param urls - The URLs to download.
-  @param options - The options for downloading.
-  @returns A promise that resolves when all files have been downloaded.
+  @param urls     - The URLs to download.
+
+  @param options  - The options for downloading.
+
+  @returns        - A promise that resolves when all files have been downloaded.
+
+  @description    - Download multiple files from an array of URLs.
+
   @example
   ```
-  import { multiDownload } from 'multi-download';
+  import { multiDownload } from "multi-download";
 
   async function downloadFiles() {
-    const urls = [
-      'https://example.com/file1.txt',
-      'https://example.com/file2.txt',
-      'https://example.com/file3.txt',
-    ];
-
-    try {
-      await multiDownload(urls, {
-        rename: ({ url, index }) => `file${index + 1}.txt`,
-        downloadInterval: 1000,
-      });
-      console.log('Files downloaded successfully');
-    } catch (error) {
-      console.error('Error downloading files:', error);
-    }
+    
+  	const urls = [
+  		"https://example.com/file1.txt",
+  		"https://example.com/file2.txt",
+  		"https://example.com/file3.txt",
+  	];
+
+  	try {
+  		await multiDownload(urls, {
+  			rename: ({ url, index }) => `file${index + 1}.txt`,
+  			downloadInterval: 1000,
+  		});
+  		console.log("Files downloaded successfully");
+  	} catch (error) {
+  		console.error("Error downloading files:", error);
+  	}
+
   }
 
-  downloadFiles();
+  await downloadFiles();
   ```
  */
 export default function multiDownload(
 	urls: string[],
-	options?: MultiDownloadOptions
+	options?: Options
 ): Promise<void>;

index.js

@@ -1,13 +1,13 @@
-const delay = milliseconds =>
-	new Promise(resolve => {
+const delay = (milliseconds) =>
+	new Promise((resolve) => {
 		setTimeout(resolve, milliseconds);
 	});
 
 const download = async (url, name) => {
-	const a = document.createElement('a');
+	const a = document.createElement("a");
 	a.download = name;
 	a.href = url;
-	a.style.display = 'none';
+	a.style.display = "none";
 	document.body.append(a);
 	a.click();
 
@@ -16,31 +16,31 @@ const download = async (url, name) => {
 	a.remove();
 };
 
-const getName = ({url}) => {
+const getName = ({ url }) => {
 	const match = url.match(/\/([^/]+)$/);
-	return match ? match[1] : 'file';
+	return match ? match[1] : "file";
 };
 
 export default async function multiDownload(urls = [], options = {}) {
-	const {downloadInterval = 1000, rename = getName} = options;
+	const { downloadInterval = 1000, rename = getName } = options;
 	if (!urls?.length) {
-		throw new Error('`urls` required');
+		throw new Error("`urls` required");
 	}
 
-	if (urls.some(url => typeof url !== 'string')) {
-		throw new Error('`urls` must be an array of strings');
+	if (urls.some((url) => typeof url !== "string")) {
+		throw new Error("`urls` must be an array of strings");
 	}
 
-	if (typeof downloadInterval !== 'number') {
-		throw new TypeError('`downloadInterval` must be a number');
+	if (typeof downloadInterval !== "number") {
+		throw new TypeError("The `downloadInterval` option must be a number");
 	}
 
-	if (typeof rename !== 'function') {
-		throw new TypeError('`rename` must be a function');
+	if (typeof rename !== "function") {
+		throw new TypeError("The `rename` option must be a function");
 	}
 
 	for (const [index, url] of urls.entries()) {
-		const name = rename({url, index, urls});
+		const name = rename({ url, index, urls });
 		await delay(index * downloadInterval); // eslint-disable-line no-await-in-loop
 		download(url, name);
 	}

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "multi-download",
-	"version": "4.1.0",
+	"version": "4.0.0",
 	"description": "Download multiple files at once in the browser",
 	"license": "MIT",
 	"repository": "sindresorhus/multi-download",