withDescription

1. Docs
2. /Reference
3. /Search TypeScript APIs
4. /Aspire.Hosting
5. /withDescription

Method

📦 Aspire.Hosting v13.6.0

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

Signature

methodwithDescriptionbuilder

Sets the description of the parameter resource.

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

Parameters

descriptionstringThe parameter description.

enableMarkdownbooleanoptional= FalseA value indicating whether the description should be rendered as Markdown. `true` allows the description to contain Markdown elements such as links, text decoration and lists.

Returns

ParameterResource

Applies to

This method applies to the following types:

typeParameterResource