Skip to content

Commit

Permalink
SpawnSyncOptions docs: reduce supported input types to Buffer
Browse files Browse the repository at this point in the history
The option only supports `Maybe Buffer` and providing anything else
like `Maybe String` will result in compilation error.
  • Loading branch information
Hi-Angel committed Sep 30, 2024
1 parent e8e4159 commit 1fb24a0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/Node/ChildProcess.purs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
-- | defined in this library that doesn't exist in the Node docs.
-- | It exists to allow the end-user to append additional values to the `safeStdio` value
-- | used here. For example,
-- |
-- |
-- | ```
-- | spawn' file args (_ { appendStdio = Just [ fileDescriptor8, pipe, pipe ]})
-- | ```
Expand Down Expand Up @@ -242,7 +242,7 @@ spawnSync command args = (UnsafeCP.spawnSync command args) <#> \r ->
}

-- | - `cwd` <string> | <URL> Current working directory of the child process.
-- | - `input` <string> | <Buffer> | <TypedArray> | <DataView> The value which will be passed as stdin to the spawned process. Supplying this value will override stdio[0].
-- | - `input` <Buffer> The value which will be passed as stdin to the spawned process. Supplying this value will override stdio[0].
-- | - `argv0` <string> Explicitly set the value of argv[0] sent to the child process. This will be set to command if not specified.
-- | - `env` <Object> Environment key-value pairs. Default: process.env.
-- | - `uid` <number> Sets the user identity of the process (see setuid(2)).
Expand Down

0 comments on commit 1fb24a0

Please sign in to comment.