feat: define Symbol.toPrimitive

google · Feb 23, 2025 · d38269b · d38269b
1 parent 147104a
commit d38269b
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 2 deletions.
diff --git a/.size-limit.json b/.size-limit.json
@@ -9,14 +9,14 @@
   {
     "name": "zx/index",
     "path": "build/*.{js,cjs}",
-    "limit": "811 kB",
+    "limit": "812 kB",
     "brotli": false,
     "gzip": false
   },
   {
     "name": "dts libdefs",
     "path": "build/*.d.ts",
-    "limit": "38.7 kB",
+    "limit": "39 kB",
     "brotli": false,
     "gzip": false
   },

diff --git a/src/core.ts b/src/core.ts
@@ -489,6 +489,10 @@ export class ProcessPromise extends Promise<ProcessOutput> {
     return 'ProcessPromise'
   }
 
+  [Symbol.toPrimitive](): string {
+    return `${this}`
+  }
+
   // Configurators
   stdio(
     stdin: IOType,
@@ -732,6 +736,10 @@ export class ProcessOutput extends Error {
     return 'ProcessOutput'
   }
 
+  [Symbol.toPrimitive](): string {
+    return this.valueOf()
+  }
+
   toString(): string {
     return this.stdall
   }

diff --git a/test/core.test.js b/test/core.test.js
@@ -423,6 +423,9 @@ describe('core', () => {
       assert.ok(p.signal instanceof AbortSignal)
       assert.equal(p.output, null)
       assert.equal(Object.prototype.toString.call(p), '[object ProcessPromise]')
+      assert.equal('' + p, '[object ProcessPromise]')
+      assert.equal(`${p}`, '[object ProcessPromise]')
+      assert.equal(+p, NaN)
 
       await p
       assert.ok(p.output instanceof ProcessOutput)
@@ -1103,6 +1106,13 @@ describe('core', () => {
       assert.equal(Object.prototype.toString.call(o), '[object ProcessOutput]')
     })
 
+    test('[Symbol.toPrimitive]', () => {
+      const o = new ProcessOutput(-1, 'SIGTERM', '', '', 'foo\n', 'msg', 20)
+      assert.equal('' + o, 'foo')
+      assert.equal(`${o}`, 'foo')
+      assert.equal(+o, NaN)
+    })
+
     test('toString()', async () => {
       const o = new ProcessOutput(null, null, '', '', 'foo\n')
       assert.equal(o.toString(), 'foo\n')