Globals

Class LightReport

Hierarchy

Report
- LightReport

Constructors

constructor

Properties

Constructors

constructor

new LightReport(__namedParameters: object): LightReport

- Defined in packages/yarnpkg-core/sources/LightReport.ts:35
Parameters
- __namedParameters: object
  - configuration: Configuration
  - stdout: Writable
  - suggestInstall: boolean
Returns LightReport

Properties

Private configuration

configuration: Configuration

Private errorCount

errorCount: number = 0

Private stdout

stdout: Writable

Private suggestInstall

suggestInstall: boolean

Methods

createStreamReporter

createStreamReporter(prefix?: string | null): PassThrough

Inherited from ThrowReport.createStreamReporter
- Defined in packages/yarnpkg-core/sources/Report.ts:213
Parameters
- Default value prefix: string | null = null
Returns PassThrough

exitCode

exitCode(): 0 | 1

- Defined in packages/yarnpkg-core/sources/LightReport.ts:51
Returns 0 | 1

finalize

finalize(): Promise<void>

Overrides Report.finalize
- Defined in packages/yarnpkg-core/sources/LightReport.ts:120
Returns Promise<void>

Private formatNameWithHyperlink

formatNameWithHyperlink(name: MessageName | null): string

- Defined in packages/yarnpkg-core/sources/LightReport.ts:131
Parameters
- name: MessageName | null
Returns string

hasErrors

hasErrors(): boolean

- Defined in packages/yarnpkg-core/sources/LightReport.ts:47
Returns boolean

reportCacheHit

reportCacheHit(locator: Locator): void

Overrides Report.reportCacheHit
- Defined in packages/yarnpkg-core/sources/LightReport.ts:55
Parameters
- locator: Locator
Returns void

reportCacheMiss

reportCacheMiss(locator: Locator): void

Overrides Report.reportCacheMiss
- Defined in packages/yarnpkg-core/sources/LightReport.ts:58
Parameters
- locator: Locator
Returns void

reportError

reportError(name: MessageName, text: string): void

Overrides Report.reportError
- Defined in packages/yarnpkg-core/sources/LightReport.ts:96
Parameters
- name: MessageName
- text: string
Returns void

reportErrorOnce

reportErrorOnce(name: MessageName, text: string, opts?: undefined | object): void

Inherited from ThrowReport.reportErrorOnce
- Defined in packages/yarnpkg-core/sources/Report.ts:194
Parameters
- name: MessageName
- text: string
- Optional opts: undefined | object
Returns void

reportExceptionOnce

reportExceptionOnce(error: Error | ReportError): void

Inherited from ThrowReport.reportExceptionOnce
- Defined in packages/yarnpkg-core/sources/Report.ts:205
Parameters
- error: Error | ReportError
Returns void

reportInfo

reportInfo(name: MessageName | null, text: string): void

Overrides Report.reportInfo
- Defined in packages/yarnpkg-core/sources/LightReport.ts:90
Parameters
- name: MessageName | null
- text: string
Returns void

reportInfoOnce

reportInfoOnce(name: MessageName, text: string, opts?: undefined | object): void

Inherited from ThrowReport.reportInfoOnce
- Defined in packages/yarnpkg-core/sources/Report.ts:172
Parameters
- name: MessageName
- text: string
- Optional opts: undefined | object
Returns void

reportJson

reportJson(data: any): void

Overrides Report.reportJson
- Defined in packages/yarnpkg-core/sources/LightReport.ts:116
Parameters
- data: any
Returns void

reportProgress

reportProgress(progress: AsyncIterable<object>): object

Overrides Report.reportProgress
- Defined in packages/yarnpkg-core/sources/LightReport.ts:101
Parameters
- progress: AsyncIterable<object>
Returns object
- stop: stop

reportSeparator

reportSeparator(): void

Overrides Report.reportSeparator
- Defined in packages/yarnpkg-core/sources/LightReport.ts:87
Returns void

reportWarning

reportWarning(name: MessageName, text: string): void

Overrides Report.reportWarning
- Defined in packages/yarnpkg-core/sources/LightReport.ts:93
Parameters
- name: MessageName
- text: string
Returns void

reportWarningOnce

reportWarningOnce(name: MessageName, text: string, opts?: undefined | object): void

Inherited from ThrowReport.reportWarningOnce
- Defined in packages/yarnpkg-core/sources/Report.ts:183
Parameters
- name: MessageName
- text: string
- Optional opts: undefined | object
Returns void

startCacheReport

startCacheReport<T>(cb: function): Promise<T>

Overrides Report.startCacheReport
- Defined in packages/yarnpkg-core/sources/LightReport.ts:83
Type parameters
- T
Parameters
- cb: function
  - - (): Promise<T>
    - Returns Promise<T>
Returns Promise<T>

startProgressPromise

startProgressPromise<T, P>(progressIt: P, cb: function): Promise<T>

Inherited from ThrowReport.startProgressPromise
- Defined in packages/yarnpkg-core/sources/Report.ts:152
Type parameters
- T
- P: ProgressIterable
Parameters
- progressIt: P
- cb: function
  - - (progressIt: P): Promise<T>
    - Parameters
      - progressIt: P
      Returns Promise<T>
Returns Promise<T>

startProgressSync

startProgressSync<T, P>(progressIt: P, cb: function): T

Inherited from ThrowReport.startProgressSync
- Defined in packages/yarnpkg-core/sources/Report.ts:162
Type parameters
- T
- P: ProgressIterable
Parameters
- progressIt: P
- cb: function
  - - (progressIt: P): T
    - Parameters
      - progressIt: P
      Returns T
Returns T

startSectionPromise

startSectionPromise<T>(opts: SectionOptions, cb: function): Promise<T>

Overrides Report.startSectionPromise
- Defined in packages/yarnpkg-core/sources/LightReport.ts:65
Type parameters
- T
Parameters
- opts: SectionOptions
- cb: function
  - - (): Promise<T>
    - Returns Promise<T>
Returns Promise<T>

startSectionSync

startSectionSync<T>(opts: SectionOptions, cb: function): T

Overrides Report.startSectionSync
- Defined in packages/yarnpkg-core/sources/LightReport.ts:61
Type parameters
- T
Parameters
- opts: SectionOptions
- cb: function
  - - (): T
    - Returns T
Returns T

startTimerPromise

startTimerPromise<T>(what: string, opts: TimerOptions, cb: function): Promise<T>
startTimerPromise<T>(what: string, cb: function): Promise<T>

Overrides Report.startTimerPromise
- Defined in packages/yarnpkg-core/sources/LightReport.ts:76
Type parameters
- T
Parameters
- what: string
- opts: TimerOptions
- cb: function
  - - (): Promise<T>
    - Returns Promise<T>
Returns Promise<T>
Overrides Report.startTimerPromise
- Defined in packages/yarnpkg-core/sources/LightReport.ts:77
Type parameters
- T
Parameters
- what: string
- cb: function
  - - (): Promise<T>
    - Returns Promise<T>
Returns Promise<T>

startTimerSync

startTimerSync<T>(what: string, opts: TimerOptions, cb: function): T
startTimerSync<T>(what: string, cb: function): T

Overrides Report.startTimerSync
- Defined in packages/yarnpkg-core/sources/LightReport.ts:69
Type parameters
- T
Parameters
- what: string
- opts: TimerOptions
- cb: function
  - - (): T
    - Returns T
Returns T
Overrides Report.startTimerSync
- Defined in packages/yarnpkg-core/sources/LightReport.ts:70
Type parameters
- T
Parameters
- what: string
- cb: function
  - - (): T
    - Returns T
Returns T

Static progressViaCounter

progressViaCounter(max: number): object

Inherited from ThrowReport.progressViaCounter
- Defined in packages/yarnpkg-core/sources/Report.ts:71
Parameters
- max: number
Returns object
- hasProgress: boolean
- hasTitle: boolean
- set: set
- tick: tick
- __computed: function
  - __computed(): AsyncGenerator<object, void, unknown>
  - - Defined in packages/yarnpkg-core/sources/Report.ts:104
    Returns AsyncGenerator<object, void, unknown>

Static progressViaTitle

progressViaTitle(): object

Inherited from ThrowReport.progressViaTitle
- Defined in packages/yarnpkg-core/sources/Report.ts:114
Returns object
- hasProgress: boolean
- hasTitle: boolean
- setTitle: function
  - - (title: string): void
    - Parameters
      - title: string
      Returns void
- __computed: function
  - __computed(): AsyncGenerator<object, never, unknown>
  - - Defined in packages/yarnpkg-core/sources/Report.ts:143
    Returns AsyncGenerator<object, never, unknown>

Static start

start(opts: LightReportOptions, cb: function): Promise<LightReport>

- Defined in packages/yarnpkg-core/sources/LightReport.ts:17
Parameters
- opts: LightReportOptions
- cb: function
  - - (report: LightReport): Promise<void>
    - Parameters
      - report: LightReport
      Returns Promise<void>
Returns Promise<LightReport>

Generated using TypeDoc