Search
Preparing search index...
The search index is not available
Yarn API
Home
Configuration
Features
CLI
Advanced
GitHub
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
yarnpkg-shell
Handle
Globals
Generic Packages
@yarnpkg/core
@yarnpkg/fslib
@yarnpkg/libzip
@yarnpkg/nm
@yarnpkg/parsers
@yarnpkg/pnp
@yarnpkg/pnpify
@yarnpkg/sdks
@yarnpkg/shell
Yarn Packages
@yarnpkg/builder
@yarnpkg/cli
Default Plugins
@yarnpkg/plugin-compat
@yarnpkg/plugin-dlx
@yarnpkg/plugin-essentials
@yarnpkg/plugin-file
@yarnpkg/plugin-git
@yarnpkg/plugin-github
@yarnpkg/plugin-http
@yarnpkg/plugin-init
@yarnpkg/plugin-link
@yarnpkg/plugin-nm
@yarnpkg/plugin-npm
@yarnpkg/plugin-npm-cli
@yarnpkg/plugin-pack
@yarnpkg/plugin-patch
@yarnpkg/plugin-pnp
Contrib Plugins
@yarnpkg/plugin-constraints
@yarnpkg/plugin-exec
@yarnpkg/plugin-interactive-tools
@yarnpkg/plugin-stage
@yarnpkg/plugin-typescript
@yarnpkg/plugin-version
@yarnpkg/plugin-workspace-tools
Class Handle
Hierarchy
Handle
Constructors
constructor
Properties
ancestor
implementation
pipe
stderr
stdin
stdout
Methods
exec
pipeTo
run
start
Constructors
constructor
new
Handle
(
ancestor
:
Handle
|
null
, implementation
:
ProcessImplementation
)
:
Handle
Parameters
ancestor:
Handle
|
null
implementation:
ProcessImplementation
Returns
Handle
Properties
Private
ancestor
ancestor
:
Handle
|
null
Private
implementation
implementation
:
ProcessImplementation
Private
pipe
pipe
:
PipeStream
|
null
= null
Private
stderr
stderr
:
StreamLock
<
Writable
>
|
null
= null
Private
stdin
stdin
:
StreamLock
<
Readable
>
|
null
= null
Private
stdout
stdout
:
StreamLock
<
Writable
>
|
null
= null
Methods
exec
exec
(
)
:
Promise
<
number
>
Returns
Promise
<
number
>
pipe
To
pipe
To
(
implementation
:
ProcessImplementation
, source
?:
Pipe
)
:
Handle
Parameters
implementation:
ProcessImplementation
Default value
source:
Pipe
= Pipe.STDOUT
Returns
Handle
run
run
(
)
:
Promise
<
number
>
Returns
Promise
<
number
>
Static
start
start
(
implementation
:
ProcessImplementation
, __namedParameters
:
object
)
:
Handle
Parameters
implementation:
ProcessImplementation
__namedParameters:
object
stderr
:
StreamLock
<
Writable
>
stdin
:
StreamLock
<
Readable
>
stdout
:
StreamLock
<
Writable
>
Returns
Handle
yarnpkg-
shell
Handle
constructor
ancestor
implementation
pipe
stderr
stdin
stdout
exec
pipe
To
run
start
Generated using
TypeDoc