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
Report
Globals
{"Generic Packages":{"@yarnpkg/core":"yarnpkg_core","@yarnpkg/fslib":"yarnpkg_fslib","@yarnpkg/json-proxy":"yarnpkg_json_proxy","@yarnpkg/libzip":"yarnpkg_libzip","@yarnpkg/parsers":"yarnpkg_parsers","@yarnpkg/pnp":"yarnpkg_pnp","@yarnpkg/pnpify":"yarnpkg_pnpify","@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-node-modules":"plugin_node_modules","@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 Report
Hierarchy
Report
ThrowReport
StreamReport
LightReport
Properties
reportedErrors
reportedInfos
reportedWarnings
Methods
createStreamReporter
finalize
reportCacheHit
reportCacheMiss
reportError
reportErrorOnce
reportExceptionOnce
reportInfo
reportInfoOnce
reportJson
reportProgress
reportSeparator
reportWarning
reportWarningOnce
startCacheReport
startTimerPromise
startTimerSync
progressViaCounter
Properties
Private
reported
Errors
reported
Errors
:
Set
<
any
>
= new Set()
Private
reported
Infos
reported
Infos
:
Set
<
any
>
= new Set()
Private
reported
Warnings
reported
Warnings
:
Set
<
any
>
= new Set()
Methods
create
Stream
Reporter
create
Stream
Reporter
(
prefix
?:
string
|
null
)
:
PassThrough
Parameters
Default value
prefix:
string
|
null
= null
Returns
PassThrough
Abstract
finalize
finalize
(
)
:
void
Returns
void
Abstract
report
Cache
Hit
report
Cache
Hit
(
locator
:
Locator
)
:
void
Parameters
locator:
Locator
Returns
void
Abstract
report
Cache
Miss
report
Cache
Miss
(
locator
:
Locator
, message
?:
undefined
|
string
)
:
void
Parameters
locator:
Locator
Optional
message:
undefined
|
string
Returns
void
Abstract
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
Abstract
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
Abstract
report
Json
report
Json
(
data
:
any
)
:
void
Parameters
data:
any
Returns
void
Abstract
report
Progress
report
Progress
(
progress
:
AsyncIterable
<
ProgressDefinition
>
)
:
Promise
<
void
>
&
object
Parameters
progress:
AsyncIterable
<
ProgressDefinition
>
Returns
Promise
<
void
>
&
object
Abstract
report
Separator
report
Separator
(
)
:
void
Returns
void
Abstract
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
Abstract
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
>
Abstract
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
>
Abstract
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
set
:
set
tick
:
tick
[
Symbol.async
Iterator]
:
function
[
Symbol.async
Iterator]
(
)
:
AsyncGenerator
<
object
,
void
,
unknown
>
Returns
AsyncGenerator
<
object
,
void
,
unknown
>
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-
node-
modules
plugin-
npm
plugin-
npm-
cli
plugin-
pack
plugin-
patch
plugin-
pnp
plugin-
stage
plugin-
typescript
plugin-
version
plugin-
workspace-
tools
vscode-
zipfs
yarnpkg-
builder
yarnpkg-
cli
yarnpkg-
core
Report
reported
Errors
reported
Infos
reported
Warnings
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
Timer
Promise
start
Timer
Sync
progress
Via
Counter
yarnpkg-
doctor
yarnpkg-
fslib
yarnpkg-
json-
proxy
yarnpkg-
libui
yarnpkg-
libzip
yarnpkg-
parsers
yarnpkg-
pnp
yarnpkg-
pnpify
yarnpkg-
shell
Generated using
TypeDoc