dollar-shell 1.0.5 → 1.1.0

package/README.md

@@ -204,6 +204,7 @@ BSD-3-Clause
 
 ## Release History
 
+* 1.1.0 *Added `asDuplex` to the sub-process object.*
 * 1.0.5 *Updated dev dependencies.*
 * 1.0.4 *Fixed `raw()` for spawn commands.*
 * 1.0.3 *Added TSDoc comments, improved docs, fixed typos, added the missing copying of properties.*

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dollar-shell",
   "description": "Run shell commands and use them in streams with ease in Node, Deno, Bun. Tiny, simple, no dependency package.",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "type": "module",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
@@ -46,7 +46,7 @@
   },
   "license": "BSD-3-Clause",
   "devDependencies": {
-    "tape-six": "^0.12.1",
+    "tape-six": "^0.12.2",
     "typescript": "^5.6.2"
   },
   "tape6": {

package/src/index.d.ts

@@ -29,6 +29,20 @@ export interface SpawnOptions {
   stderr?: SpawnStreamState;
 }
 
+/**
+ * Object with readable and writable streams. It can be used as a duplex stream.
+ */
+interface DuplexPair<R = any> {
+  /**
+   * The readable stream.
+   */
+  readable: ReadableStream<R>;
+  /**
+   * The writable stream.
+   */
+  writable: WritableStream<R>;
+}
+
 /**
  * Sub-process object.
  */
@@ -77,6 +91,11 @@ export interface Subprocess<R = any> {
    * It is `null` if `options.stderr` was not set to `'pipe'`.
    */
   readonly stderr: ReadableStream<R> | null;
+  /**
+   * Returns a duplex stream that can be used to pipe the input and output.
+   * It is defined as `{readable: this.stdout, writable: this.stdin}`.
+   */
+  readonly asDuplex: DuplexPair<R>;
   /**
    * Kill the process.
    */
@@ -181,20 +200,6 @@ export interface DollarResult {
   killed: boolean;
 }
 
-/**
- * Object with readable and writable streams. It can be used as a duplex stream.
- */
-interface DuplexPair<R = any> {
-  /**
-   * The readable stream.
-   */
-  readable: ReadableStream<R>;
-  /**
-   * The writable stream.
-   */
-  writable: WritableStream<R>;
-}
-
 /**
  * The type of the {@link $} function.
  */

package/src/index.js

@@ -50,7 +50,7 @@ const toProcess = bqSpawn((command, options) => {
 
 const throughProcess = bqSpawn((command, options) => {
   const sp = spawn(command, Object.assign({}, options, {stdin: 'pipe', stdout: 'pipe'}));
-  return {readable: sp.stdout, writable: sp.stdin};
+  return sp.asDuplex;
 });
 
 $.from = fromProcess;
@@ -79,7 +79,7 @@ const toShell = bqShell(shellEscape, (command, options) => {
 
 const throughShell = bqShell(shellEscape, (command, options) => {
   const sp = spawn(buildShellCommand(options?.shellPath, options?.shellArgs, command), Object.assign({}, options, {stdin: 'pipe', stdout: 'pipe'}));
-  return {readable: sp.stdout, writable: sp.stdin};
+  return sp.asDuplex;
 });
 
 $sh.from = fromShell;

package/src/spawn/bun.js

@@ -54,6 +54,10 @@ class Subprocess {
     return this.childProcess.signalCode;
   }
 
+  get asDuplex() {
+    return {readable: this.stdout, writable: this.stdin};
+  }
+
   kill() {
     this.killed = true;
     this.childProcess.kill();

package/src/spawn/deno.js

@@ -63,6 +63,10 @@ class Subprocess {
     return this.spawnOptions.stderr === 'piped' ? this.childProcess.stderr : null;
   }
 
+  get asDuplex() {
+    return {readable: this.stdout, writable: this.stdin};
+  }
+
   kill() {
     this.killed = true;
     this.controller.abort();

package/src/spawn/node.js

@@ -61,6 +61,10 @@ class Subprocess {
     this.stderr = this.childProcess.stderr && Readable.toWeb(this.childProcess.stderr);
   }
 
+  get asDuplex() {
+    return {readable: this.stdout, writable: this.stdin};
+  }
+
   kill() {
     this.killed = true;
     this.childProcess.kill();