EndpointReference

Docs / Reference / TypeScript APIs / Aspire.Hosting.Testing / EndpointReference

EndpointReference

Docs Reference TypeScript APIs Aspire.Hosting.Testing EndpointReference

Handle TypeScript

📦 Aspire.Hosting.Testing v13.2.0-preview.1.26159.1

interface EndpointReference
  extends IManifestExpressionProvider,
    IValueProvider,
    IValueWithReferences {
  readonly endpointName: string;
  errorMessage: string;
  readonly exists: boolean;
  readonly host: string;
  readonly isAllocated: boolean;
  readonly isHttp: boolean;
  readonly isHttps: boolean;
  readonly port: number;
  readonly scheme: string;
  readonly targetPort: number;
  readonly url: string;
  getValueAsync(cancellationToken?: cancellationToken): string;
}

Implements

• IManifestExpressionProvider
• IValueProvider
• IValueWithReferences

Search members of EndpointReference…

method property

13 members Clear filters

Properties

property endpointName string get

Gets the EndpointName property

property errorMessage string get · set

Gets the ErrorMessage property

property exists boolean get

Gets the Exists property

property host string get

Gets the Host property

property isAllocated boolean get

Gets the IsAllocated property

property isHttp boolean get

Gets the IsHttp property

property isHttps boolean get

Gets the IsHttps property

property port number get

Gets the Port property

property scheme string get

Gets the Scheme property

property targetPort number get

Gets the TargetPort property

property url string get

Gets the Url property

Methods

method getValueAsync

Gets the URL of the endpoint asynchronously

getValueAsync(cancellationToken?: cancellationToken): string

Parameters

cancellationToken cancellationToken optional

Returns

string