IReportingTask

Docs / Reference / Search TypeScript APIs / Aspire.Hosting / IReportingTask

IReportingTask

Docs Reference Search TypeScript APIs Aspire.Hosting IReportingTask

Interface

📦 Aspire.Hosting v13.2.0

interface IReportingTask {
  completeTask(
      completionMessage?: string,
      completionState?: string,
      cancellationToken?: cancellationToken): void;
  completeTaskMarkdown(
      markdownString: string,
      completionState?: string,
      cancellationToken?: cancellationToken): void;
  updateTask(
      statusText: string,
      cancellationToken?: cancellationToken): void;
  updateTaskMarkdown(
      markdownString: string,
      cancellationToken?: cancellationToken): void;
}

Methods

method completeTask

Completes the reporting task with plain-text completion text

completeTask(
    completionMessage?: string,
    completionState?: string,
    cancellationToken?: cancellationToken): void

Parameters

completionMessage string optional

completionState string optional = completed

cancellationToken cancellationToken optional

method completeTaskMarkdown

Completes the reporting task with Markdown-formatted completion text

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

Parameters

markdownString string

completionState string optional = completed

cancellationToken cancellationToken optional

method updateTask

Updates the reporting task with plain-text status text

updateTask(
    statusText: string,
    cancellationToken?: cancellationToken): void

Parameters

statusText string

cancellationToken cancellationToken optional

method updateTaskMarkdown

Updates the reporting task with Markdown-formatted status text

updateTaskMarkdown(
    markdownString: string,
    cancellationToken?: cancellationToken): void

Parameters

markdownString string

cancellationToken cancellationToken optional