docs: mention halt and run API (#1046)

closes #961
google · Dec 30, 2024 · 2bf873d · 2bf873d
1 parent b90eab3
commit 2bf873d
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/docs/process-promise.md b/docs/process-promise.md
@@ -4,10 +4,16 @@ The `$` returns a `ProcessPromise` instance. When resolved, it becomes a [`Proce
 
 ```js
 const p = $`command` // ProcessPromise
-
 const o = await p    // ProcessOutput
 ```
 
+By default, `$` spawns a new process immediately, but you can delay the start to trigger in manually.
+
+```ts
+const p = $({halt: true})`command`
+const o = await p.run()
+```
+
 ## `stdin`
 
 Returns a writable stream of the stdin process. Accessing