From 1fb24a06edb01d9a3f1c576bb9d01887815b243c Mon Sep 17 00:00:00 2001 From: Konstantin Kharlamov Date: Mon, 30 Sep 2024 18:49:23 +0300 Subject: [PATCH] SpawnSyncOptions docs: reduce supported `input` types to Buffer The option only supports `Maybe Buffer` and providing anything else like `Maybe String` will result in compilation error. --- src/Node/ChildProcess.purs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Node/ChildProcess.purs b/src/Node/ChildProcess.purs index 8921441..2ec1900 100644 --- a/src/Node/ChildProcess.purs +++ b/src/Node/ChildProcess.purs @@ -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 ]}) -- | ``` @@ -242,7 +242,7 @@ spawnSync command args = (UnsafeCP.spawnSync command args) <#> \r -> } -- | - `cwd` | Current working directory of the child process. --- | - `input` | | | The value which will be passed as stdin to the spawned process. Supplying this value will override stdio[0]. +-- | - `input` The value which will be passed as stdin to the spawned process. Supplying this value will override stdio[0]. -- | - `argv0` Explicitly set the value of argv[0] sent to the child process. This will be set to command if not specified. -- | - `env` Environment key-value pairs. Default: process.env. -- | - `uid` Sets the user identity of the process (see setuid(2)).