Skip to content

Commit 2bf873d

Browse files
authored
docs: mention halt and run API (#1046)
closes #961
1 parent b90eab3 commit 2bf873d

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/process-promise.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,16 @@ The `$` returns a `ProcessPromise` instance. When resolved, it becomes a [`Proce
44

55
```js
66
const p = $`command` // ProcessPromise
7-
87
const o = await p // ProcessOutput
98
```
109

10+
By default, `$` spawns a new process immediately, but you can delay the start to trigger in manually.
11+
12+
```ts
13+
const p = $({halt: true})`command`
14+
const o = await p.run()
15+
```
16+
1117
## `stdin`
1218

1319
Returns a writable stream of the stdin process. Accessing

0 commit comments

Comments
 (0)