Skip to content

Commit

Permalink
docs: add options documentation (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
43081j authored Jun 14, 2024
1 parent e8047c3 commit ce57d86
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,24 @@ for await (const line of result) {
}
```

### Options

Options can be passed to have finer control over spawning of the process:

```ts
await x('ls', [], {
timeout: 1000
});
```

The options object can have the following properties:

- `signal` - an `AbortSignal` to allow aborting of the execution
- `timeout` - time in milliseconds at which the process will be forceably killed
- `persist` - if `true`, the process will continue after the host exits
- `stdin` - another `Result` can be used as the input to this process
- `nodeOptions` - any valid options to node's underlying `spawn` function

### Piping to another process

You can pipe a process to another via the `pipe` method:
Expand Down

0 comments on commit ce57d86

Please sign in to comment.