withDescription

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

withDescription

Docs Reference Search TypeScript APIs Aspire.Hosting withDescription

Function

📦 Aspire.Hosting v13.2.0-preview.1.26159.1

interface ParameterResource {
  // ... omitted for brevity
  withDescription(
      description: string,
      enableMarkdown?: boolean): ParameterResource;
}

Signature

method withDescription builder

Sets a parameter description

withDescription(
    description: string,
    enableMarkdown?: boolean): ParameterResource

Parameters

description string

enableMarkdown boolean optional = False

Returns

ParameterResource

Applies to

This function is an extension method on the following types:

type ParameterResource