withTransformXForwarded

1. Docs
2. /Reference
3. /Search TypeScript APIs
4. /Aspire.Hosting.Yarp
5. /withTransformXForwarded

Method

📦 Aspire.Hosting.Yarp v13.6.0

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

Signature

methodwithTransformXForwarded

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

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

Parameters

headerPrefixstringoptional= X-Forwarded-

xDefaultForwardedTransformActionsoptional= Set

xForForwardedTransformActionsoptional

xHostForwardedTransformActionsoptional

xProtoForwardedTransformActionsoptional

xPrefixForwardedTransformActionsoptional

Returns

YarpRoute

Applies to

This method applies to the following types:

typeYarpRoute