Improve documentation of error.*
fields
#1006
Merged
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.
This PR documents the error-related fields as
error.*
instead ofresult.*
.Technically, on success,
result.timedOut
,result.isCanceled
,result.isMaxBuffer
andresult.isTerminated
arefalse
, andresult.exitCode
is0
. However, those are defined on success mostly for orthogonality reasons.Users should instead check whether the subprocess failed first. If not, they do not need to check those properties. They can check whether the subprocess failed by using
reject: true
(the default value),error.failed
, orerror instanceof ExecaError
.Documenting those fields as
error.*
makes it clearer that those are intended for subprocess failures.