YarpResource

Handle

📦 Aspire.Hosting.Yarp v13.4.0

interface YarpResource
  extends IComputeResource,
    IContainerFilesDestinationResource,
    IResource,
    IResourceWithArgs,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IResourceWithServiceDiscovery {
  publishWithStaticFiles(resourceWithFiles: IResourceWithContainerFiles): YarpResource;
  withConfiguration(configurationBuilder: (obj: IYarpConfigurationBuilder) => Promise<void>): YarpResource;
  withHostHttpsPort(port: number): YarpResource;
  withHostPort(port: number): YarpResource;
  withStaticFiles(sourcePath?: string): YarpResource;
}

5 members

Methods

methodpublishWithStaticFilesbuilder

In publish mode, generates a Dockerfile that copies static files from the specified resource into /app/wwwroot.

publishWithStaticFiles(resourceWithFiles: IResourceWithContainerFiles): YarpResource

Parameters

resourceWithFilesIResourceWithContainerFiles

Returns

YarpResource

methodwithConfigurationbuilder

Configure the YARP resource.

withConfiguration(configurationBuilder: (obj: IYarpConfigurationBuilder) => Promise<void>): YarpResource

Parameters

configurationBuilder(obj: IYarpConfigurationBuilder) => Promise<void>

Returns

YarpResource

methodwithHostHttpsPortbuilder

Configures the host HTTPS port that the YARP resource is exposed on instead of using randomly assigned port. This will only have effect if an HTTPS endpoint is configured on the YARP resource due to TLS termination being enabled.

withHostHttpsPort(port: number): YarpResource

Parameters

portnumber

Returns

YarpResource

methodwithHostPortbuilder

Configures the host port that the YARP resource is exposed on instead of using randomly assigned port.

withHostPort(port: number): YarpResource

Parameters

portnumber

Returns

YarpResource

methodwithStaticFilesbuilder

Enables static file serving in the YARP resource.

withStaticFiles(sourcePath?: string): YarpResource

Parameters

sourcePathstringoptional

Returns

YarpResource