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-core
ThrowReport
Globals
{"Generic Packages":{"@yarnpkg/core":"yarnpkg_core","@yarnpkg/fslib":"yarnpkg_fslib","@yarnpkg/libzip":"yarnpkg_libzip","@yarnpkg/nm":"yarnpkg_nm","@yarnpkg/parsers":"yarnpkg_parsers","@yarnpkg/pnp":"yarnpkg_pnp","@yarnpkg/pnpify":"yarnpkg_pnpify","@yarnpkg/sdks":"yarnpkg_sdks","@yarnpkg/shell":"yarnpkg_shell"},"Yarn Packages":{"@yarnpkg/builder":"yarnpkg_builder","@yarnpkg/cli":"yarnpkg_cli"},"Default Plugins":{"@yarnpkg/plugin-compat":"plugin_compat","@yarnpkg/plugin-dlx":"plugin_dlx","@yarnpkg/plugin-essentials":"plugin_essentials","@yarnpkg/plugin-file":"plugin_file","@yarnpkg/plugin-git":"plugin_git","@yarnpkg/plugin-github":"plugin_github","@yarnpkg/plugin-http":"plugin_http","@yarnpkg/plugin-init":"plugin_init","@yarnpkg/plugin-link":"plugin_link","@yarnpkg/plugin-nm":"plugin_nm","@yarnpkg/plugin-npm":"plugin_npm","@yarnpkg/plugin-npm-cli":"plugin_npm_cli","@yarnpkg/plugin-pack":"plugin_pack","@yarnpkg/plugin-patch":"plugin_patch","@yarnpkg/plugin-pnp":"plugin_pnp"},"Contrib Plugins":{"@yarnpkg/plugin-constraints":"plugin_constraints","@yarnpkg/plugin-exec":"plugin_exec","@yarnpkg/plugin-interactive-tools":"plugin_interactive_tools","@yarnpkg/plugin-stage":"plugin_stage","@yarnpkg/plugin-typescript":"plugin_typescript","@yarnpkg/plugin-version":"plugin_version","@yarnpkg/plugin-workspace-tools":"plugin_workspace_tools"}}
Class ThrowReport
Hierarchy
Report
ThrowReport
Methods
createStreamReporter
finalize
reportCacheHit
reportCacheMiss
reportError
reportErrorOnce
reportExceptionOnce
reportInfo
reportInfoOnce
reportJson
reportProgress
reportSeparator
reportWarning
reportWarningOnce
startCacheReport
startProgressPromise
startProgressSync
startSectionPromise
startSectionSync
startTimerPromise
startTimerSync
progressViaCounter
progressViaTitle
Methods
create
Stream
Reporter
create
Stream
Reporter
(
prefix
?:
string
|
null
)
:
PassThrough
Parameters
Default value
prefix:
string
|
null
= null
Returns
PassThrough
finalize
finalize
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
report
Cache
Hit
report
Cache
Hit
(
locator
:
Locator
)
:
void
Parameters
locator:
Locator
Returns
void
report
Cache
Miss
report
Cache
Miss
(
locator
:
Locator
)
:
void
Parameters
locator:
Locator
Returns
void
report
Error
report
Error
(
name
:
MessageName
, text
:
string
)
:
void
Parameters
name:
MessageName
text:
string
Returns
void
report
Error
Once
report
Error
Once
(
name
:
MessageName
, text
:
string
, opts
?:
undefined
|
object
)
:
void
Parameters
name:
MessageName
text:
string
Optional
opts:
undefined
|
object
Returns
void
report
Exception
Once
report
Exception
Once
(
error
:
Error
|
ReportError
)
:
void
Parameters
error:
Error
|
ReportError
Returns
void
report
Info
report
Info
(
name
:
MessageName
|
null
, text
:
string
)
:
void
Parameters
name:
MessageName
|
null
text:
string
Returns
void
report
Info
Once
report
Info
Once
(
name
:
MessageName
, text
:
string
, opts
?:
undefined
|
object
)
:
void
Parameters
name:
MessageName
text:
string
Optional
opts:
undefined
|
object
Returns
void
report
Json
report
Json
(
data
:
any
)
:
void
Parameters
data:
any
Returns
void
report
Progress
report
Progress
(
progress
:
AsyncIterable
<
object
>
)
:
object
Parameters
progress:
AsyncIterable
<
object
>
Returns
object
stop
:
stop
report
Separator
report
Separator
(
)
:
void
Returns
void
report
Warning
report
Warning
(
name
:
MessageName
, text
:
string
)
:
void
Parameters
name:
MessageName
text:
string
Returns
void
report
Warning
Once
report
Warning
Once
(
name
:
MessageName
, text
:
string
, opts
?:
undefined
|
object
)
:
void
Parameters
name:
MessageName
text:
string
Optional
opts:
undefined
|
object
Returns
void
start
Cache
Report
start
Cache
Report<T>
(
cb
:
function
)
:
Promise
<
T
>
Type parameters
T
Parameters
cb:
function
(
)
:
Promise
<
T
>
Returns
Promise
<
T
>
Returns
Promise
<
T
>
start
Progress
Promise
start
Progress
Promise<T, P>
(
progressIt
:
P
, cb
:
function
)
:
Promise
<
T
>
Type parameters
T
P
:
ProgressIterable
Parameters
progressIt:
P
cb:
function
(
progressIt
:
P
)
:
Promise
<
T
>
Parameters
progressIt:
P
Returns
Promise
<
T
>
Returns
Promise
<
T
>
start
Progress
Sync
start
Progress
Sync<T, P>
(
progressIt
:
P
, cb
:
function
)
:
T
Type parameters
T
P
:
ProgressIterable
Parameters
progressIt:
P
cb:
function
(
progressIt
:
P
)
:
T
Parameters
progressIt:
P
Returns
T
Returns
T
start
Section
Promise
start
Section
Promise<T>
(
opts
:
SectionOptions
, cb
:
function
)
:
Promise
<
T
>
Type parameters
T
Parameters
opts:
SectionOptions
cb:
function
(
)
:
Promise
<
T
>
Returns
Promise
<
T
>
Returns
Promise
<
T
>
start
Section
Sync
start
Section
Sync<T>
(
opts
:
SectionOptions
, cb
:
function
)
:
T
Type parameters
T
Parameters
opts:
SectionOptions
cb:
function
(
)
:
T
Returns
T
Returns
T
start
Timer
Promise
start
Timer
Promise<T>
(
what
:
string
, opts
:
TimerOptions
, cb
:
function
)
:
Promise
<
T
>
start
Timer
Promise<T>
(
what
:
string
, cb
:
function
)
:
Promise
<
T
>
Type parameters
T
Parameters
what:
string
opts:
TimerOptions
cb:
function
(
)
:
Promise
<
T
>
Returns
Promise
<
T
>
Returns
Promise
<
T
>
Type parameters
T
Parameters
what:
string
cb:
function
(
)
:
Promise
<
T
>
Returns
Promise
<
T
>
Returns
Promise
<
T
>
start
Timer
Sync
start
Timer
Sync<T>
(
what
:
string
, opts
:
TimerOptions
, cb
:
function
)
:
T
start
Timer
Sync<T>
(
what
:
string
, cb
:
function
)
:
T
Type parameters
T
Parameters
what:
string
opts:
TimerOptions
cb:
function
(
)
:
T
Returns
T
Returns
T
Type parameters
T
Parameters
what:
string
cb:
function
(
)
:
T
Returns
T
Returns
T
Static
progress
Via
Counter
progress
Via
Counter
(
max
:
number
)
:
object
Parameters
max:
number
Returns
object
has
Progress
:
boolean
has
Title
:
boolean
set
:
set
tick
:
tick
__computed
:
function
__computed
(
)
:
AsyncGenerator
<
object
,
void
,
unknown
>
Returns
AsyncGenerator
<
object
,
void
,
unknown
>
Static
progress
Via
Title
progress
Via
Title
(
)
:
object
Returns
object
has
Progress
:
boolean
has
Title
:
boolean
set
Title
:
function
(
title
:
string
)
:
void
Parameters
title:
string
Returns
void
__computed
:
function
__computed
(
)
:
AsyncGenerator
<
object
,
never
,
unknown
>
Returns
AsyncGenerator
<
object
,
never
,
unknown
>
"scripts/extract-
hooks"
acceptance-
tests
plugin-
compat
plugin-
constraints
plugin-
dlx
plugin-
essentials
plugin-
exec
plugin-
file
plugin-
git
plugin-
github
plugin-
http
plugin-
init
plugin-
interactive-
tools
plugin-
link
plugin-
nm
plugin-
npm
plugin-
npm-
cli
plugin-
pack
plugin-
patch
plugin-
pnp
plugin-
pnpm
plugin-
stage
plugin-
typescript
plugin-
version
plugin-
workspace-
tools
vscode-
zipfs
yarnpkg-
builder
yarnpkg-
cli
yarnpkg-
core
Throw
Report
create
Stream
Reporter
finalize
report
Cache
Hit
report
Cache
Miss
report
Error
report
Error
Once
report
Exception
Once
report
Info
report
Info
Once
report
Json
report
Progress
report
Separator
report
Warning
report
Warning
Once
start
Cache
Report
start
Progress
Promise
start
Progress
Sync
start
Section
Promise
start
Section
Sync
start
Timer
Promise
start
Timer
Sync
progress
Via
Counter
progress
Via
Title
yarnpkg-
doctor
yarnpkg-
extensions
yarnpkg-
fslib
yarnpkg-
libui
yarnpkg-
libzip
yarnpkg-
nm
yarnpkg-
parsers
yarnpkg-
pnp
yarnpkg-
pnpify
yarnpkg-
sdks
yarnpkg-
shell
Generated using
TypeDoc