withTunnelEndpoint

1. Docs
2. /Reference
3. /Search TypeScript APIs
4. /CommunityToolkit.Aspire.Hosting.Ngrok
5. /withTunnelEndpoint

Method

📦 CommunityToolkit.Aspire.Hosting.Ngrok v13.5.0

interface NgrokResource {
  // ... omitted for brevity
  withTunnelEndpoint(
      resource: IResourceWithEndpoints,
      endpointName: string,
      ngrokUrl?: string,
      labels?: Dict<string,string>): NgrokResource;
}

Signature

methodwithTunnelEndpointbuilder

Configures a resource with endpoints as a ngrok tunnel endpoint.

withTunnelEndpoint(
    resource: IResourceWithEndpoints,
    endpointName: string,
    ngrokUrl?: string,
    labels?: Dict<string,string>): NgrokResource

Parameters

resourceIResourceWithEndpoints

endpointNamestring

ngrokUrlstringoptional

labelsDict<string,string>optional

Returns

NgrokResource

Applies to

This method applies to the following types:

typeNgrokResource