feat: Promise-based API

sntran · sntran · commit 783c9b59accb · 2021-03-14T18:28:37.000-05:00
The `rclone.promises` API provides an alternative set of asynchronous
Rclone methods that return Promise objects rather than using subprocess

The API is accessible via require("rclone").promises.
diff --git a/README.md b/README.md
@@ -36,6 +36,17 @@ ls.stderr.on("data", (data) => {
 });
 ```
 
+There is also a Promise-based API:
+
+```js
+const rclone = require("rclone.js").promises;
+
+(async function() {
+  const results = await rclone.ls("source:");
+  console.log(results);
+})();
+```
+
 ### CLI
 
 This simple CLI calls the JS API above and outputs `stdout` and `stderr`.
diff --git a/index.js b/index.js
@@ -84,6 +84,9 @@ api.cat = function() {
   });
 }
 
+// Promise-based API.
+const promises = api.promises = {};
+
 const COMMANDS = [
   "about", // Get quota information from the remote.
   "authorize", // Remote authorization.
@@ -154,9 +157,30 @@ const COMMANDS = [
 ];
 
 COMMANDS.forEach(commandName => {
+  // Normal API command to return a subprocess.
   api[commandName] = function() {
     return api(commandName, ...arguments);
   }
+
+  // Promise API command to return a Promise.
+  promises[commandName] = function() {
+    const args = Array.from(arguments);
+
+    return new Promise((resolve, reject) => {
+      const { stdout, stderr } = api(commandName, ...args);
+
+      let output = "";
+      stdout.on("data", data => {
+        output += data;
+      });
+      stdout.on("end", () => {
+        resolve(output.trim());
+      });
+      stderr.on("data", (data) => {
+        reject(data.toString());
+      });
+    });
+  }
 });
 
 module.exports = api;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "rclone.js",
-  "version": "0.4.2",
+  "version": "0.5.0",
   "description": "JavaScript API for rclone",
   "main": "index.js",
   "bin": {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "rclone.js",`
`3`		`- "version": "0.4.2",`
	`3`	`+ "version": "0.5.0",`
`4`	`4`	`"description": "JavaScript API for rclone",`
`5`	`5`	`"main": "index.js",`
`6`	`6`	`"bin": {`