LightReport
Hierarchy
- Report
- LightReport
Index
Constructors
Properties
Methods
- createStreamReporter
- exitCode
- finalize
- getRecommendedLength
- hasErrors
- reportCacheHit
- reportCacheMiss
- reportError
- reportErrorOnce
- reportExceptionOnce
- reportFold
- reportInfo
- reportInfoOnce
- reportJson
- reportProgress
- reportSeparator
- reportWarning
- reportWarningOnce
- startProgressPromise
- startProgressSync
- startSectionPromise
- startSectionSync
- startTimerPromise
- startTimerSync
- progressViaCounter
- progressViaTitle
- start
Constructors
constructor
Parameters
__namedParameters: LightReportOptions
Returns LightReport
Properties
cacheHits
cacheMisses
Methods
createStreamReporter
Parameters
prefix: null | string = null
Returns PassThrough
exitCode
Returns 0 | 1
finalize
Returns Promise<void>
getRecommendedLength
Returns number
hasErrors
Returns boolean
reportCacheHit
Parameters
locator: Locator
Returns void
reportCacheMiss
Parameters
locator: Locator
Returns void
reportError
Parameters
name: MessageName
text: string
Returns void
reportErrorOnce
Parameters
name: MessageName
text: string
optionalopts: { key?: any; reportExtra?: (report: Report) => void }
Returns void
reportExceptionOnce
Parameters
error: Error | ReportError
Returns void
reportFold
Parameters
title: string
text: string
Returns void
reportInfo
Parameters
name: null | MessageName
text: string
Returns void
reportInfoOnce
Parameters
name: MessageName
text: string
optionalopts: { key?: any; reportExtra?: (report: Report) => void }
Returns void
reportJson
Parameters
data: any
Returns void
reportProgress
Parameters
progress: AsyncIterable<{ progress: number; title?: string }>
Returns { stop: () => void }
stop: () => void
Returns void
reportSeparator
Returns void
reportWarning
Parameters
name: MessageName
text: string
Returns void
reportWarningOnce
Parameters
name: MessageName
text: string
optionalopts: { key?: any; reportExtra?: (report: Report) => void }
Returns void
startProgressPromise
Type parameters
- T
- P: ProgressIterable
Parameters
progressIt: P
cb: (progressIt: P) => Promise<T>
Returns Promise<T>
startProgressSync
Type parameters
- T
- P: ProgressIterable
Parameters
progressIt: P
cb: (progressIt: P) => T
Returns T
startSectionPromise
Type parameters
- T
Parameters
opts: SectionOptions
cb: () => Promise<T>
Returns Promise<T>
startSectionSync
Type parameters
- T
Parameters
opts: SectionOptions
cb: () => T
Returns T
startTimerPromise
Type parameters
- T
Parameters
what: string
opts: TimerOptions
cb: () => Promise<T>
Returns Promise<T>
startTimerSync
Type parameters
- T
Parameters
what: string
opts: TimerOptions
cb: () => T
Returns T
staticprogressViaCounter
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
Parameters
n: number
Returns void
tick: (n?: number) => void
Parameters
n: number = 0
Returns void
[asyncIterator]: function
Returns AsyncGenerator<{ progress: number }, void, unknown>
staticprogressViaTitle
Returns { hasProgress: boolean; hasTitle: boolean; setTitle: (title: string) => void; [asyncIterator]: any }
hasProgress: boolean
hasTitle: boolean
setTitle: (title: string) => void
Parameters
title: string
Returns void
[asyncIterator]: function
Returns AsyncGenerator<{ title: undefined | string }, never, unknown>
staticstart
Parameters
opts: LightReportOptions
cb: (report: LightReport) => Promise<void>
Returns Promise<LightReport>