withTransformForwarded

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

withTransformForwarded

Docs Reference Search TypeScript APIs Aspire.Hosting.Yarp withTransformForwarded

Function

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

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

Signature

method withTransformForwarded

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

useHost boolean optional = True

useProto boolean optional = True

forFormat NodeFormat optional = Random

byFormat NodeFormat optional = Random

action ForwardedTransformActions optional = Set

Returns

YarpRoute

Applies to

This function is an extension method on the following types:

type YarpRoute