abstractReport

Hierarchy

• Report
  • LightReport
  • StreamReport
  • ThrowReport

Index

Constructors

• constructor

Properties

• cacheHits
• cacheMisses

Methods

• createStreamReporter
• finalize
• getRecommendedLength
• reportCacheHit
• reportCacheMiss
• reportError
• reportErrorOnce
• reportExceptionOnce
• reportFold
• reportInfo
• reportInfoOnce
• reportJson
• reportProgress
• reportSeparator
• reportWarning
• reportWarningOnce
• startProgressPromise
• startProgressSync
• startSectionPromise
• startSectionSync
• startTimerPromise
• startTimerSync
• progressViaCounter
• progressViaTitle

Constructors

constructor

• new Report(): Report

• Returns Report

Properties

cacheHits

cacheHits: Set<LocatorHash> = ...

cacheMisses

cacheMisses: Set<LocatorHash> = ...

Methods

createStreamReporter

• createStreamReporter(prefix?: null | string): PassThrough

• Parameters

  • prefix: null | string = null

  Returns PassThrough

abstractfinalize

• finalize(): void

• Returns void

getRecommendedLength

• getRecommendedLength(): number

• Returns number

reportCacheHit

• reportCacheHit(locator: Locator): void

• Parameters

  • locator: Locator

  Returns void

reportCacheMiss

• reportCacheMiss(locator: Locator, message?: string): void

• Parameters

  • locator: Locator

  • optionalmessage: string

  Returns void

abstractreportError

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

• Parameters

  • name: MessageName

  • text: string

  Returns void

reportErrorOnce

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

• Parameters

  • name: MessageName

  • text: string

  • optionalopts: { key?: any; reportExtra?: (report: Report) => void }

  • optionalkey: any

  • optionalreportExtra: (report: Report) => void

  Returns void

reportExceptionOnce

• reportExceptionOnce(error: Error | ReportError): void

• Parameters

  • error: Error | ReportError

  Returns void

abstractreportFold

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

• Parameters

  • title: string

  • text: string

  Returns void

abstractreportInfo

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

• Parameters

  • name: null | MessageName

  • text: string

  Returns void

reportInfoOnce

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

• Parameters

  • name: MessageName

  • text: string

  • optionalopts: { key?: any; reportExtra?: (report: Report) => void }

  • optionalkey: any

  • optionalreportExtra: (report: Report) => void

  Returns void

abstractreportJson

• reportJson(data: any): void

• Parameters

  • data: any

  Returns void

abstractreportProgress

• reportProgress(progress: AsyncIterable<ProgressDefinition>): Promise<void> & { stop: () => void }

• Parameters

  • progress: AsyncIterable<ProgressDefinition>

  Returns Promise<void> & { stop: () => void }

abstractreportSeparator

• reportSeparator(): void

• Returns void

abstractreportWarning

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

• Parameters

  • name: MessageName

  • text: string

  Returns void

reportWarningOnce

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

• Parameters

  • name: MessageName

  • text: string

  • optionalopts: { key?: any; reportExtra?: (report: Report) => void }

  • optionalkey: any

  • optionalreportExtra: (report: Report) => void

  Returns void

startProgressPromise

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

• 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

• Type parameters

  • T
  • P: ProgressIterable

  Parameters

  • progressIt: P

  • cb: (progressIt: P) => T

  Returns T

abstractstartSectionPromise

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

• Type parameters

  • T

  Parameters

  • opts: SectionOptions

  • cb: () => Promise<T>

  Returns Promise<T>

abstractstartSectionSync

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

• Type parameters

  • T

  Parameters

  • opts: SectionOptions

  • cb: () => T

  Returns T

abstractstartTimerPromise

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

• Type parameters

  • T

  Parameters

  • what: string

  • opts: TimerOptions

  • cb: () => Promise<T>

  Returns Promise<T>

abstractstartTimerSync

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

• 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 }

• 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 }

• 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>