Fixes based on the PR review

Author: ismi29ch

index.d.ts

@@ -1,5 +1,5 @@
 /**
- * Function to rename downloaded files.
+  Function to rename downloaded files.
  */
 export interface RenameFunction {
 	/**
@@ -11,52 +11,51 @@ export interface RenameFunction {
 }
 
 /**
- * Options for the multiDownload function.
+  Options for the multiDownload function.
  */
 export interface MultiDownloadOptions {
 	/**
-	 * The function to rename the downloaded files.
-	 * @default undefined (use original filenames)
+	  The function to rename the downloaded files.
+	  @default undefined (use original filenames)
 	 */
 	rename?: RenameFunction;
 
 	/**
-	 * The delay time between each file download in milliseconds.
-	 * @default 1000
+	  The delay time between each file download in milliseconds.
+	  @default 1000
 	 */
-	delayTime?: number;
+	downloadInterval?: number;
 }
 
 /**
- * Download multiple files at once.
- * @param urls The URLs to download.
- * @param options The options for downloading.
- * @param options.rename The function to rename the downloaded files.
- * @param options.delayTime The delay time between each file download.
- * @example
- * ```typescript
- * 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`,
- *       delayTime: 1000,
- *     });
- *     console.log('Files downloaded successfully');
- *   } catch (error) {
- *     console.error('Error downloading files:', error);
- *   }
- * }
- *
- * downloadFiles();
- * ```
+  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.
+  @example
+  ```
+  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);
+    }
+  }
+ 
+  downloadFiles();
+  ```
  */
 export default function multiDownload(
 	urls: string[],

index.js

@@ -21,15 +21,15 @@ const getName = ({ url }) => {
 };
 
 export default async function multiDownload(urls = [], options = {}) {
-	const { delay = 1000, rename = getName } = options;
+	const { downloadInterval = 1000, rename = getName } = options;
 	if (!urls?.length) {
 		throw new Error("`urls` required");
 	}
 	if (urls.every((url) => typeof url !== "string")) {
 		throw new Error("`urls` must be an array of strings");
 	}
-	if (typeof delay !== "number") {
-		throw new Error("`delay` must be a number");
+	if (typeof downloadInterval !== "number") {
+		throw new Error("`downloadInterval` must be a number");
 	}
 	if (typeof rename !== "function") {
 		throw new Error("`rename` must be a function");
@@ -38,7 +38,7 @@ export default async function multiDownload(urls = [], options = {}) {
 	for (const [index, url] of urls.entries()) {
 		const name = rename({ url, index, urls });
 
-		await delay(index * delay);
+		await delay(index * downloadInterval);
 		download(url, name);
 	}
 }

package.json

@@ -1,18 +1,19 @@
 {
 	"name": "multi-download",
-	"version": "5.0.0",
+	"version": "4.1.0",
 	"description": "Download multiple files at once in the browser",
 	"license": "MIT",
 	"repository": "sindresorhus/multi-download",
 	"author": {
 		"name": "Sindre Sorhus",
 		"email": "[email protected]",
-		"url": "sindresorhus.com"
+		"url": "https://sindresorhus.com"
 	},
 	"type": "module",
 	"exports": "./index.js",
 	"files": [
-		"index.js"
+		"index.js",
+		"index.d.ts"
 	],
 	"typings": "index.d.ts",
 	"keywords": [

readme.md

@@ -74,11 +74,11 @@ Type: `Function`
 
 A function that accepts an object containing `url`, `index`, and `urls` properties and is expected to return the new filename.
 
-##### delayTime
+##### downloadInterval
 
 Type: `number`
 
-Time in miliseconds to delay between each download
+The delay time between each file download in milliseconds.
 
 ```html
 <button id="download-button" data-files="unicorn.jpg rainbow.jpg">Download</button>
@@ -91,7 +91,18 @@ document.querySelector('#download-button').addEventListener('click', event => {
 	const files = event.target.dataset.files.split(' ');
 	multiDownload(files, {
 		rename: ({url, index, urls}) => 'New name.pdf',
-		delayTime: 500
+	});
+});
+```
+
+```js
+import multiDownload from 'multi-download';
+
+document.querySelector('#download-button').addEventListener('click', event => {
+	const files = event.target.dataset.files.split(' ');
+	multiDownload(files, {
+		rename: ({url, index, urls}) => 'New name.pdf',
+		downloadInterval: 500
 	});
 });
 ```