Globals

Class Report

Hierarchy

Report

Properties

cacheHits

cacheHits: Set<string & object> = new Set<LocatorHash>()

cacheMisses

cacheMisses: Set<string & object> = new Set<LocatorHash>()

Private reportedErrors

reportedErrors: Set<any> = new Set()

Private reportedInfos

reportedInfos: Set<any> = new Set()

Private reportedWarnings

reportedWarnings: Set<any> = new Set()

Methods

createStreamReporter

createStreamReporter(prefix?: string | null): PassThrough

- Defined in packages/yarnpkg-core/sources/Report.ts:224
Parameters
- Default value prefix: string | null = null
Returns PassThrough

Abstract finalize

finalize(): void

- Defined in packages/yarnpkg-core/sources/Report.ts:80
Returns void

getRecommendedLength

getRecommendedLength(): number

- Defined in packages/yarnpkg-core/sources/Report.ts:51
Returns number

reportCacheHit

reportCacheHit(locator: Locator): void

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

reportCacheMiss

reportCacheMiss(locator: Locator, message?: undefined | string): void

- Defined in packages/yarnpkg-core/sources/Report.ts:59
Parameters
- locator: Locator
- Optional message: undefined | string
Returns void

Abstract reportError

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

- Defined in packages/yarnpkg-core/sources/Report.ts:75
Parameters
- name: MessageName
- text: string
Returns void

reportErrorOnce

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

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

reportExceptionOnce

reportExceptionOnce(error: Error | ReportError): void

- Defined in packages/yarnpkg-core/sources/Report.ts:216
Parameters
- error: Error | ReportError
Returns void

Abstract reportFold

reportFold(title: string, text: string): void

- Defined in packages/yarnpkg-core/sources/Report.ts:78
Parameters
- title: string
- text: string
Returns void

Abstract reportInfo

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

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

reportInfoOnce

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

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

Abstract reportJson

reportJson(data: any): void

- Defined in packages/yarnpkg-core/sources/Report.ts:77
Parameters
- data: any
Returns void

Abstract reportProgress

reportProgress(progress: AsyncIterable<ProgressDefinition>): Promise<void> & object

- Defined in packages/yarnpkg-core/sources/Report.ts:76
Parameters
- progress: AsyncIterable<ProgressDefinition>
Returns Promise<void> & object

Abstract reportSeparator

reportSeparator(): void

- Defined in packages/yarnpkg-core/sources/Report.ts:72
Returns void

Abstract reportWarning

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

- Defined in packages/yarnpkg-core/sources/Report.ts:74
Parameters
- name: MessageName
- text: string
Returns void

reportWarningOnce

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

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

startProgressPromise

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

- Defined in packages/yarnpkg-core/sources/Report.ts:163
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

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

Abstract startSectionPromise

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

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

Abstract startSectionSync

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

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

Abstract startTimerPromise

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

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

Abstract startTimerSync

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

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

Static progressViaCounter

progressViaCounter(max: number): object

- Defined in packages/yarnpkg-core/sources/Report.ts:82
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:115
    Returns AsyncGenerator<object, void, unknown>

Static progressViaTitle

progressViaTitle(): object

- Defined in packages/yarnpkg-core/sources/Report.ts:125
Returns object
- hasProgress: boolean
- hasTitle: boolean
- setTitle: DebouncedFunc<(Anonymous function)>
- __computed: function
  - __computed(): AsyncGenerator<object, never, unknown>
  - - Defined in packages/yarnpkg-core/sources/Report.ts:154
    Returns AsyncGenerator<object, never, unknown>

Generated using TypeDoc