withTransformForwarded

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

Method

📦 Aspire.Hosting.Yarp v13.6.0

interface YarpRoute {
  // ... omitted for brevity
  withTransformForwarded(
      useHost?: boolean,
      useProto?: boolean,
      forFormat?: NodeFormat,
      byFormat?: NodeFormat,
      action?: ForwardedTransformActions): YarpRoute;
}

Signature

methodwithTransformForwarded

Adds the transform which will add the Forwarded header as defined by [RFC 7239](https://tools.ietf.org/html/rfc7239).

withTransformForwarded(
    useHost?: boolean,
    useProto?: boolean,
    forFormat?: NodeFormat,
    byFormat?: NodeFormat,
    action?: ForwardedTransformActions): YarpRoute

Parameters

useHostbooleanoptional= True

useProtobooleanoptional= True

forFormatNodeFormatoptional= Random

byFormatNodeFormatoptional= Random

actionForwardedTransformActionsoptional= Set

Returns

YarpRoute

Applies to

This method applies to the following types:

typeYarpRoute