Add isResumable()

CHANGELOG.md

@@ -1,3 +1,11 @@
+# 2.2.0 (2024-03-25)
+
+- Added some missing instructions for how to format the download rate / estimated time remaining
+
+Added to `DownloadData`:
+
+- `isDownloadResumable()`
+
 # 2.1.0 (2024-03-25)
 
 Added to `DownloadData`:

README.md

@@ -69,6 +69,7 @@ manager.resumeDownload(id);
       - [Formatting download progress](#formatting-download-progress)
     - [`isDownloadInProgress()`](#isdownloadinprogress)
     - [`isDownloadPaused()`](#isdownloadpaused)
+    - [`isDownloadResumable()`](#isdownloadresumable)
     - [`isDownloadCancelled()`](#isdownloadcancelled)
     - [`isDownloadInterrupted()`](#isdownloadinterrupted)
     - [`isDownloadCompleted()`](#isdownloadcompleted)
@@ -375,6 +376,11 @@ $ npm install @types/bytes --save-dev
 ```typescript
 import bytes from 'bytes'
 import dayjs from 'dayjs'
+import relativeTime from 'dayjs/plugin/relativeTime';
+import duration from 'dayjs/plugin/duration';
+
+dayjs.extend(relativeTime);
+dayjs.extend(duration);
 
 const downloadData = manager.getDownloadData(id); // or DataItem from the callbacks
 
@@ -401,6 +407,14 @@ Returns true if the download is paused.
 isDownloadPaused(): boolean
 ```
 
+### `isDownloadResumable()`
+
+Returns true if the download is resumable.
+
+```typescript
+isDownloadResumable(): boolean
+```
+
 ### `isDownloadCancelled()`
 
 Returns true if the download is cancelled.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-dl-manager",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "A library for implementing file downloads in Electron with 'save as' dialog and id support.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

src/DownloadData.ts

@@ -74,6 +74,10 @@ export class DownloadData {
     return this.item.getState() === 'interrupted'
   }
 
+  isDownloadResumable() {
+    return this.item.canResume()
+  }
+
   isDownloadPaused() {
     return this.item.isPaused()
   }

src/__mocks__/DownloadData.ts

@@ -40,6 +40,7 @@ export function createMockDownloadData() {
     isDownloadCompleted: jest.fn(),
     isDownloadCancelled: jest.fn(),
     isDownloadInterrupted: jest.fn(),
+    isDownloadResumable: jest.fn(),
     isDownloadPaused: jest.fn(),
     item,
   }