Skip to content

Commit 05737f5

Browse files
author
pinnacle-comp
committed
1 parent ecb8700 commit 05737f5

3 files changed

Lines changed: 48 additions & 0 deletions

File tree

main/classes/pinnacle.process.Child.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,24 @@ The pid of the spawned command.
2121

2222
This process's standard input, if any.
2323

24+
This will only exist if `pipe_stdin` was set on the `Command` before spawning.
25+
2426
### stdout <Badge type="danger" text="nullable" />
2527

2628
`stdout?`: <code><a href="/lua-reference/main/classes/pinnacle.process.ChildStdout">pinnacle.process.ChildStdout</a></code>
2729

2830
This process's standard output, if any.
2931

32+
This will only exist if `pipe_stdout` was set on the `Command` before spawning.
33+
3034
### stderr <Badge type="danger" text="nullable" />
3135

3236
`stderr?`: <code><a href="/lua-reference/main/classes/pinnacle.process.ChildStderr">pinnacle.process.ChildStderr</a></code>
3337

3438
This process's standard error, if any.
3539

40+
This will only exist if `pipe_stderr` was set on the `Command` before spawning.
41+
3642

3743
## Functions
3844

main/classes/pinnacle.process.Command.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,24 @@ A command representing a to-be-spawned process.
3939

4040

4141

42+
### pipe_stdin <Badge type="danger" text="nullable" />
43+
44+
`pipe_stdin?`: <code>boolean</code>
45+
46+
47+
48+
### pipe_stdout <Badge type="danger" text="nullable" />
49+
50+
`pipe_stdout?`: <code>boolean</code>
51+
52+
53+
54+
### pipe_stderr <Badge type="danger" text="nullable" />
55+
56+
`pipe_stderr?`: <code>boolean</code>
57+
58+
59+
4260

4361
## Functions
4462

main/classes/pinnacle.process.CommandOpts.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,28 @@ Prevents the spawn from occurring if the process is already running.
4141
Causes the command to only spawn the process if it hasn't been spawned before within the
4242
lifetime of the compositor.
4343

44+
### pipe_stdin <Badge type="danger" text="nullable" />
45+
46+
`pipe_stdin?`: <code>boolean</code>
47+
48+
Sets up a pipe to allow the config to write to the process's stdin.
49+
50+
The pipe will be available through the spawned child's `stdin`.
51+
52+
### pipe_stdout <Badge type="danger" text="nullable" />
53+
54+
`pipe_stdout?`: <code>boolean</code>
55+
56+
Sets up a pipe to allow the config to read from the process's stdout.
57+
58+
The pipe will be available through the spawned child's `stdout`.
59+
60+
### pipe_stderr <Badge type="danger" text="nullable" />
61+
62+
`pipe_stderr?`: <code>boolean</code>
63+
64+
Sets up a pipe to allow the config to read from the process's stderr.
65+
66+
The pipe will be available through the spawned child's `stderr`.
67+
4468

0 commit comments

Comments
 (0)