IReportingStep

Interface

📦 Aspire.Hosting v13.4.0

interface IReportingStep {
  completeStep(
      completionText: string,
      completionState?: string,
      cancellationToken?: cancellationToken): void;
  completeStepMarkdown(
      markdownString: string,
      completionState?: string,
      cancellationToken?: cancellationToken): void;
  createMarkdownTask(
      markdownString: string,
      cancellationToken?: cancellationToken): IReportingTask;
  createTask(
      statusText: string,
      cancellationToken?: cancellationToken): IReportingTask;
  logStep(
      level: string,
      message: string): void;
  logStepMarkdown(
      level: string,
      markdownString: string): void;
}

6 members

Methods

methodcompleteStep

Completes the reporting step with plain-text completion text.

completeStep(
    completionText: string,
    completionState?: string,
    cancellationToken?: cancellationToken): void

Parameters

completionTextstring

completionStatestringoptional= completed

cancellationTokencancellationTokenoptional

methodcompleteStepMarkdown

Completes the reporting step with Markdown-formatted completion text.

completeStepMarkdown(
    markdownString: string,
    completionState?: string,
    cancellationToken?: cancellationToken): void

Parameters

markdownStringstring

completionStatestringoptional= completed

cancellationTokencancellationTokenoptional

methodcreateMarkdownTask

Creates a reporting task with Markdown-formatted status text.

createMarkdownTask(
    markdownString: string,
    cancellationToken?: cancellationToken): IReportingTask

Parameters

markdownStringstring

cancellationTokencancellationTokenoptional

Returns

IReportingTask

methodcreateTask

Creates a reporting task with plain-text status text.

createTask(
    statusText: string,
    cancellationToken?: cancellationToken): IReportingTask

Parameters

statusTextstring

cancellationTokencancellationTokenoptional

Returns

IReportingTask

methodlogStep

Logs a plain-text message for the reporting step.

logStep(
    level: string,
    message: string): void

Parameters

levelstring

messagestring

methodlogStepMarkdown

Logs a Markdown-formatted message for the reporting step.

logStepMarkdown(
    level: string,
    markdownString: string): void

Parameters

levelstring

markdownStringstring