withTransformXForwarded

Docs / Reference / Search TypeScript APIs / Aspire.Hosting.Yarp / withTransformXForwarded

withTransformXForwarded

Docs Reference Search TypeScript APIs Aspire.Hosting.Yarp withTransformXForwarded

Function

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

interface YarpRoute {
  // ... omitted for brevity
  withTransformXForwarded(
      headerPrefix?: string,
      xDefault?: ForwardedTransformActions,
      xFor?: ForwardedTransformActions,
      xHost?: ForwardedTransformActions,
      xProto?: ForwardedTransformActions,
      xPrefix?: ForwardedTransformActions): YarpRoute;
}

Signature

method withTransformXForwarded

Adds the transform which will add X-Forwarded-* headers.

withTransformXForwarded(
    headerPrefix?: string,
    xDefault?: ForwardedTransformActions,
    xFor?: ForwardedTransformActions,
    xHost?: ForwardedTransformActions,
    xProto?: ForwardedTransformActions,
    xPrefix?: ForwardedTransformActions): YarpRoute

Parameters

headerPrefix string optional = X-Forwarded-

xDefault ForwardedTransformActions optional = Set

xFor ForwardedTransformActions optional

xHost ForwardedTransformActions optional

xProto ForwardedTransformActions optional

xPrefix ForwardedTransformActions optional

Returns

YarpRoute

Applies to

This function is an extension method on the following types:

type YarpRoute