Improve types of childProcess.stdout and childProcess.stderr
#687
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ehmicky
force-pushed
the
child-process-ignored
branch
from
b6740b0
to
6bf1667
Compare
ehmicky
commented
Jan 14, 2024
| export type ExecaChildPromise<OptionsType extends Options = Options> = { | ||
| stdout: StreamUnlessIgnored<'1', OptionsType>; | ||
|
|
||
| stderr: StreamUnlessIgnored<'2', OptionsType>; |
There was a problem hiding this comment.
Leaving the documentation blank as we do not document this property.
Since the final type uses & ChildProcess, it turns out childProcess.stdout|stderr still shows the TypeScript documentation for it coming from Node.js' ChildProcess.
ehmicky
commented
Jan 14, 2024
| type StreamUnlessIgnored< | ||
| StreamIndex extends string, | ||
| OptionsType extends Options = Options, | ||
| > = IgnoresStreamResult<StreamIndex, OptionsType> extends true ? null : Readable; |
There was a problem hiding this comment.
Note: ChildProcess["stdout"] type is Readable | null.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow-up on #681.
While #681 fixed the types of
result.stdout|stderr, this PR fixes the types ofchildProcess.stdout|stderr.childProcess.stdout|stderrisnullwhen using options likestdout: 'inherit'. Otherwise it is aReadablestream.This PR does not fix
childProcess.allyet.