promise api

Author: gms1

.editorconfig

@@ -13,8 +13,8 @@ trim_trailing_whitespace = true
 insert_final_newline = true
 
 # Matches multiple files with the same settings
-[*.js]
-indent_size = 2
+[*.js;*.ts]
+indent_size = 4
 
 [*.json]
 indent_size = 2

.gitignore

@@ -26,6 +26,7 @@ local.env
 setup.sh
 /build-tmp-napi-v3
 /build-tmp-napi-v6
+/.nyc_output
 *.tgz
 package-lock.json
 prebuilds

docs/DEVELOP.md

@@ -27,10 +27,10 @@ This project uses [npm version](https://docs.npmjs.com/cli/v10/commands/npm-vers
    - Publish the package to npm
 
 3. ** Edit the generated Pre-release
-  - select "Generate release notes"
+  - select "Generate release notes" and adjust them to your needs
   - uncheck "Set as pre-release"
   - check "Set as latest release" if it is
-  - click "Update Releasse
+  - click "Update Release
 
 ### Version format
 

lib/promise/backup.js

@@ -0,0 +1,121 @@
+/**
+ * Promise-based wrapper for the Backup class from node-sqlite3
+ * @module promise/backup
+ */
+
+'use strict';
+
+/**
+ * A thin wrapper for the 'Backup' class from 'node-sqlite3' using Promises
+ * instead of callbacks
+ *
+ * @see https://github.com/mapbox/node-sqlite3/wiki/API
+ */
+class SqliteBackup {
+    /**
+   * Creates an instance of SqliteBackup.
+   *
+   * @param {import('../sqlite3.js').Backup} backup - The underlying Backup instance
+   */
+    constructor(backup) {
+        /**
+      * @type {import('../sqlite3.js').Backup}
+      * @private
+      */
+        this._backup = backup;
+    }
+
+    /**
+   * Returns true if the backup is idle (not actively copying)
+   *
+   * @returns {boolean}
+   */
+    get idle() {
+        return this._backup.idle;
+    }
+
+    /**
+   * Returns true if the backup is completed
+   *
+   * @returns {boolean}
+   */
+    get completed() {
+        return this._backup.completed;
+    }
+
+    /**
+   * Returns true if the backup has failed
+   *
+   * @returns {boolean}
+   */
+    get failed() {
+        return this._backup.failed;
+    }
+
+    /**
+   * Returns the remaining number of pages left to copy
+   * Returns -1 if `step` not yet called
+   *
+   * @returns {number}
+   */
+    get remaining() {
+        return this._backup.remaining;
+    }
+
+    /**
+   * Returns the total number of pages
+   * Returns -1 if `step` not yet called
+   *
+   * @returns {number}
+   */
+    get pageCount() {
+        return this._backup.pageCount;
+    }
+
+    /**
+   * Returns the progress (percentage completion)
+   *
+   * @returns {number} Progress as percentage (0-100)
+   */
+    get progress() {
+        const pageCount = this.pageCount;
+        const remaining = this.remaining;
+        if (pageCount === -1 || remaining === -1) {
+            return 0;
+        }
+        return pageCount === 0 ? 100 : ((pageCount - remaining) / pageCount) * 100;
+    }
+
+    /**
+   * Copy the next page or all remaining pages of the backup
+   *
+   * @param {number} [pages=-1] - Number of pages to copy (-1 for all remaining)
+   * @returns {Promise<void>}
+   */
+    step(pages) {
+        return new Promise((resolve, reject) => {
+            if (!this._backup) {
+                reject(new Error('backup handle not open'));
+                return;
+            }
+            this._backup.step(pages === undefined ? -1 : pages, (err) => {
+                if (err) {
+                    reject(err);
+                } else {
+                    resolve();
+                }
+            });
+        });
+    }
+
+    /**
+   * Finish the backup (synchronous)
+   */
+    finish() {
+        if (this._backup) {
+            this._backup.finish();
+        }
+    }
+}
+
+module.exports = { SqliteBackup };