Skip to main content

ThrowReport

Hierarchy

Report
- ThrowReport

Constructors

constructor

new ThrowReport(): ThrowReport

Inherited from Report.constructor
Returns ThrowReport

Properties

cacheHits

cacheHits: Set<LocatorHash> = ...

cacheMisses

cacheMisses: Set<LocatorHash> = ...

Methods

createStreamReporter

createStreamReporter(prefix?: null | string): PassThrough

Inherited from Report.createStreamReporter
Parameters
- prefix: null | string = null
Returns PassThrough

finalize

finalize(): Promise<void>

Overrides Report.finalize
Returns Promise<void>

getRecommendedLength

getRecommendedLength(): number

Inherited from Report.getRecommendedLength
Returns number

reportCacheHit

reportCacheHit(locator: Locator): void

Overrides Report.reportCacheHit
Parameters
- locator: Locator
Returns void

reportCacheMiss

reportCacheMiss(locator: Locator): void

Overrides Report.reportCacheMiss
Parameters
- locator: Locator
Returns void

reportError

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

Overrides Report.reportError
Parameters
- name: MessageName
- text: string
Returns void

reportErrorOnce

reportErrorOnce(name: MessageName, text: string, opts?: { key?: any; reportExtra?: (report: Report) => void }): void

Inherited from Report.reportErrorOnce
Parameters
- name: MessageName
- text: string
- optionalopts: { key?: any; reportExtra?: (report: Report) => void }
Returns void

reportExceptionOnce

reportExceptionOnce(error: Error | ReportError): void

Inherited from Report.reportExceptionOnce
Parameters
- error: Error | ReportError
Returns void

reportFold

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

Overrides Report.reportFold
Parameters
- title: string
- text: string
Returns void

reportInfo

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

Overrides Report.reportInfo
Parameters
- name: null | MessageName
- text: string
Returns void

reportInfoOnce

reportInfoOnce(name: MessageName, text: string, opts?: { key?: any; reportExtra?: (report: Report) => void }): void

Inherited from Report.reportInfoOnce
Parameters
- name: MessageName
- text: string
- optionalopts: { key?: any; reportExtra?: (report: Report) => void }
Returns void

reportJson

reportJson(data: any): void

Overrides Report.reportJson
Parameters
- data: any
Returns void

reportProgress

reportProgress(progress: AsyncIterable<{ progress: number; title?: string }>): { stop: () => void }

Overrides Report.reportProgress
Parameters
- progress: AsyncIterable<{ progress: number; title?: string }>
Returns { stop: () => void }
- stop: () => void
  - - (): void
    - Returns void

reportSeparator

reportSeparator(): void

Overrides Report.reportSeparator
Returns void

reportWarning

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

Overrides Report.reportWarning
Parameters
- name: MessageName
- text: string
Returns void

reportWarningOnce

reportWarningOnce(name: MessageName, text: string, opts?: { key?: any; reportExtra?: (report: Report) => void }): void

Inherited from Report.reportWarningOnce
Parameters
- name: MessageName
- text: string
- optionalopts: { key?: any; reportExtra?: (report: Report) => void }
Returns void

startProgressPromise

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

Inherited from Report.startProgressPromise
Type parameters
- T
- P: ProgressIterable
Parameters
- progressIt: P
- cb: (progressIt: P) => Promise<T>
Returns Promise<T>

startProgressSync

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

Inherited from Report.startProgressSync
Type parameters
- T
- P: ProgressIterable
Parameters
- progressIt: P
- cb: (progressIt: P) => T
Returns T

startSectionPromise

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

Overrides Report.startSectionPromise
Type parameters
- T
Parameters
- opts: SectionOptions
- cb: () => Promise<T>
Returns Promise<T>

startSectionSync

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

Overrides Report.startSectionSync
Type parameters
- T
Parameters
- opts: SectionOptions
- cb: () => T
Returns T

startTimerPromise

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

Overrides Report.startTimerPromise
Type parameters
- T
Parameters
- what: string
- opts: TimerOptions
- cb: () => Promise<T>
Returns Promise<T>

startTimerSync

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

Overrides Report.startTimerSync
Type parameters
- T
Parameters
- what: string
- opts: TimerOptions
- cb: () => T
Returns T

staticprogressViaCounter

progressViaCounter(max: number): { hasProgress: boolean; hasTitle: boolean; set: (n: number) => void; tick: (n?: number) => void; [asyncIterator]: any }

Inherited from Report.progressViaCounter
Parameters
- max: number
Returns { hasProgress: boolean; hasTitle: boolean; set: (n: number) => void; tick: (n?: number) => void; [asyncIterator]: any }
- hasProgress: boolean
- hasTitle: boolean
- set: (n: number) => void
  - - (n: number): void
    - Parameters
      - n: number
      Returns void
- tick: (n?: number) => void
  - - (n?: number): void
    - Parameters
      - n: number = 0
      Returns void
- [asyncIterator]: function
  - [asyncIterator](): AsyncGenerator<{ progress: number }, void, unknown>
  - Returns AsyncGenerator<{ progress: number }, void, unknown>

staticprogressViaTitle

progressViaTitle(): { hasProgress: boolean; hasTitle: boolean; setTitle: (title: string) => void; [asyncIterator]: any }

Inherited from Report.progressViaTitle
Returns { hasProgress: boolean; hasTitle: boolean; setTitle: (title: string) => void; [asyncIterator]: any }
- hasProgress: boolean
- hasTitle: boolean
- setTitle: (title: string) => void
  - - (title: string): void
    - Parameters
      - title: string
      Returns void
- [asyncIterator]: function
  - [asyncIterator](): AsyncGenerator<{ title: undefined | string }, never, unknown>
  - Returns AsyncGenerator<{ title: undefined | string }, never, unknown>