Class ProgressReportingProgressLog

ProgressLog implementation that uses the configured ReportProgress instance to report goal execution updates.

Hierarchy

ProgressReportingProgressLog

Implements

ProgressLog

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ProgressReportingProgressLog(progressReporter: ReportProgress, sdmGoal: SdmGoalEvent, context: HandlerContext): ProgressReportingProgressLog

- Defined in lib/api-helper/goal/executeGoal.ts:454
Parameters
- progressReporter: ReportProgress
- sdmGoal: SdmGoalEvent
- context: HandlerContext
Returns ProgressReportingProgressLog

Properties

Private Readonly context

context: HandlerContext

log

log: string

Readonly name

name: string

Private Readonly progressReporter

progressReporter: ReportProgress

Private Readonly sdmGoal

sdmGoal: SdmGoalEvent

url

url: string

Methods

close

close(): Promise<void>

Implementation of ProgressLog.close
- Defined in lib/api-helper/goal/executeGoal.ts:464
Returns Promise<void>

flush

flush(): Promise<void>

Implementation of ProgressLog.flush
- Defined in lib/api-helper/goal/executeGoal.ts:468
Returns Promise<void>

isAvailable

isAvailable(): Promise<boolean>

Implementation of ProgressLog.isAvailable
- Defined in lib/api-helper/goal/executeGoal.ts:472
Returns Promise<boolean>

write

write(msg: string, ...args: string[]): void

- Defined in lib/api-helper/goal/executeGoal.ts:476
Parameters
- msg: string
- Rest ...args: string[]
Returns void

Generated using TypeDoc