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

method publishWithStaticFiles builder

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

publishWithStaticFiles(resourceWithFiles: IResourceWithContainerFiles): YarpResource

Parameters

resourceWithFiles IResourceWithContainerFiles

Returns

YarpResource

method withConfiguration builder

Configure the YARP resource.

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

Parameters

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

Returns

YarpResource

method withHostHttpsPort builder

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

port number

Returns

YarpResource

method withHostPort builder

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

withHostPort(port: number): YarpResource

Parameters

port number

Returns

YarpResource

method withStaticFiles builder

Enables static file serving in the YARP resource.

withStaticFiles(sourcePath?: string): YarpResource

Parameters

sourcePath string optional

Returns

YarpResource