YarpRoute

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

YarpRoute

Docs Reference Search TypeScript APIs Aspire.Hosting.Yarp YarpRoute

Handle

📦 Aspire.Hosting.Yarp v13.2.0

interface YarpRoute {
  withMatch(match: YarpRouteMatch): YarpRoute;
  withMatchHeaders(headers: YarpRouteHeaderMatch[]): YarpRoute;
  withMatchHosts(hosts: string[]): YarpRoute;
  withMatchMethods(methods: string[]): YarpRoute;
  withMatchPath(path: string): YarpRoute;
  withMatchRouteQueryParameter(queryParameters: YarpRouteQueryParameterMatch[]): YarpRoute;
  withMaxRequestBodySize(maxRequestBodySize: number): YarpRoute;
  withMetadata(metadata: Dict<string,string>): YarpRoute;
  withOrder(order: number): YarpRoute;
  withTransform(transform: Dict<string,string>): YarpRoute;
  withTransformClientCertHeader(headerName: string): YarpRoute;
  withTransformCopyRequestHeaders(copy?: boolean): YarpRoute;
  withTransformCopyResponseHeaders(copy?: boolean): YarpRoute;
  withTransformCopyResponseTrailers(copy?: boolean): YarpRoute;
  withTransformForwarded(
      useHost?: boolean,
      useProto?: boolean,
      forFormat?: NodeFormat,
      byFormat?: NodeFormat,
      action?: ForwardedTransformActions): YarpRoute;
  withTransformHttpMethodChange(
      fromHttpMethod: string,
      toHttpMethod: string): YarpRoute;
  withTransformPathPrefix(prefix: string): YarpRoute;
  withTransformPathRemovePrefix(prefix: string): YarpRoute;
  withTransformPathRouteValues(pattern: string): YarpRoute;
  withTransformPathSet(path: string): YarpRoute;
  withTransformQueryRemoveKey(queryKey: string): YarpRoute;
  withTransformQueryRouteValue(
      queryKey: string,
      routeValueKey: string,
      append?: boolean): YarpRoute;
  withTransformQueryValue(
      queryKey: string,
      value: string,
      append?: boolean): YarpRoute;
  withTransformRequestHeader(
      headerName: string,
      value: string,
      append?: boolean): YarpRoute;
  withTransformRequestHeaderRemove(headerName: string): YarpRoute;
  withTransformRequestHeaderRouteValue(
      headerName: string,
      routeValueKey: string,
      append?: boolean): YarpRoute;
  withTransformRequestHeadersAllowed(allowedHeaders: string[]): YarpRoute;
  withTransformResponseHeader(
      headerName: string,
      value: string,
      append?: boolean,
      condition?: ResponseCondition): YarpRoute;
  withTransformResponseHeaderRemove(
      headerName: string,
      condition?: ResponseCondition): YarpRoute;
  withTransformResponseHeadersAllowed(allowedHeaders: string[]): YarpRoute;
  withTransformResponseTrailer(
      headerName: string,
      value: string,
      append?: boolean,
      condition?: ResponseCondition): YarpRoute;
  withTransformResponseTrailerRemove(
      headerName: string,
      condition?: ResponseCondition): YarpRoute;
  withTransformResponseTrailersAllowed(allowedHeaders: string[]): YarpRoute;
  withTransforms(transforms: Dict<string,string>[]): YarpRoute;
  withTransformUseOriginalHostHeader(useOriginal?: boolean): YarpRoute;
  withTransformXForwarded(
      headerPrefix?: string,
      xDefault?: ForwardedTransformActions,
      xFor?: ForwardedTransformActions,
      xHost?: ForwardedTransformActions,
      xProto?: ForwardedTransformActions,
      xPrefix?: ForwardedTransformActions): YarpRoute;
}

Search members of YarpRoute…

36 members Clear filters

Methods

method withMatch

Sets the route match criteria.

withMatch(match: YarpRouteMatch): YarpRoute

Parameters

match YarpRouteMatch

Returns

YarpRoute

method withMatchHeaders

Matches requests that contain the specified headers.

withMatchHeaders(headers: YarpRouteHeaderMatch[]): YarpRoute

Parameters

headers YarpRouteHeaderMatch[]

Returns

YarpRoute

method withMatchHosts

Matches requests that contain the specified host headers.

withMatchHosts(hosts: string[]): YarpRoute

Parameters

hosts string[]

Returns

YarpRoute

method withMatchMethods

Matches requests that use the specified HTTP methods.

withMatchMethods(methods: string[]): YarpRoute

Parameters

methods string[]

Returns

YarpRoute

method withMatchPath

Matches requests with the specified path pattern.

withMatchPath(path: string): YarpRoute

Parameters

path string

Returns

YarpRoute

method withMatchRouteQueryParameter

Matches requests that contain the specified query parameters.

withMatchRouteQueryParameter(queryParameters: YarpRouteQueryParameterMatch[]): YarpRoute

Parameters

queryParameters YarpRouteQueryParameterMatch[]

Returns

YarpRoute

method withMaxRequestBodySize

Sets the maximum request body size for the route.

withMaxRequestBodySize(maxRequestBodySize: number): YarpRoute

Parameters

maxRequestBodySize number

Returns

YarpRoute

method withMetadata

Sets metadata for the route.

withMetadata(metadata: Dict<string,string>): YarpRoute

Parameters

metadata Dict<string,string>

Returns

YarpRoute

method withOrder

Sets the route order.

withOrder(order: number): YarpRoute

Parameters

order number

Returns

YarpRoute

method withTransform

Adds a transform to the route.

withTransform(transform: Dict<string,string>): YarpRoute

Parameters

transform Dict<string,string>

Returns

YarpRoute

method withTransformClientCertHeader

Adds the transform which will set the given header with the Base64 encoded client certificate.

withTransformClientCertHeader(headerName: string): YarpRoute

Parameters

headerName string

Returns

YarpRoute

method withTransformCopyRequestHeaders

Adds the transform which will enable or suppress copying request headers to the proxy request.

withTransformCopyRequestHeaders(copy?: boolean): YarpRoute

Parameters

copy boolean optional = True

Returns

YarpRoute

method withTransformCopyResponseHeaders

Adds the transform which will enable or suppress copying response headers to the client response.

withTransformCopyResponseHeaders(copy?: boolean): YarpRoute

Parameters

copy boolean optional = True

Returns

YarpRoute

method withTransformCopyResponseTrailers

Adds the transform which will enable or suppress copying response trailers to the client response.

withTransformCopyResponseTrailers(copy?: boolean): YarpRoute

Parameters

copy boolean optional = True

Returns

YarpRoute

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

method withTransformHttpMethodChange

Adds the transform that will replace the HTTP method if it matches.

withTransformHttpMethodChange(
    fromHttpMethod: string,
    toHttpMethod: string): YarpRoute

Parameters

fromHttpMethod string

toHttpMethod string

Returns

YarpRoute

method withTransformPathPrefix

Adds the transform which will prefix the request path with the given value.

withTransformPathPrefix(prefix: string): YarpRoute

Parameters

prefix string

Returns

YarpRoute

method withTransformPathRemovePrefix

Adds the transform which will remove the matching prefix from the request path.

withTransformPathRemovePrefix(prefix: string): YarpRoute

Parameters

prefix string

Returns

YarpRoute

method withTransformPathRouteValues

Adds the transform which will set the request path with route values.

withTransformPathRouteValues(pattern: string): YarpRoute

Parameters

pattern string

Returns

YarpRoute

method withTransformPathSet

Adds the transform which sets the request path with the given value.

withTransformPathSet(path: string): YarpRoute

Parameters

path string

Returns

YarpRoute

method withTransformQueryRemoveKey

Adds the transform that will remove the given query key.

withTransformQueryRemoveKey(queryKey: string): YarpRoute

Parameters

queryKey string

Returns

YarpRoute

method withTransformQueryRouteValue

Adds the transform that will append or set the query parameter from a route value.

withTransformQueryRouteValue(
    queryKey: string,
    routeValueKey: string,
    append?: boolean): YarpRoute

Parameters

queryKey string

routeValueKey string

append boolean optional = True

Returns

YarpRoute

method withTransformQueryValue

Adds the transform that will append or set the query parameter from the given value.

withTransformQueryValue(
    queryKey: string,
    value: string,
    append?: boolean): YarpRoute

Parameters

queryKey string

value string

append boolean optional = True

Returns

YarpRoute

method withTransformRequestHeader

Adds the transform which will append or set the request header.

withTransformRequestHeader(
    headerName: string,
    value: string,
    append?: boolean): YarpRoute

Parameters

headerName string

value string

append boolean optional = True

Returns

YarpRoute

method withTransformRequestHeaderRemove

Adds the transform which will remove the request header.

withTransformRequestHeaderRemove(headerName: string): YarpRoute

Parameters

headerName string

Returns

YarpRoute

method withTransformRequestHeaderRouteValue

Adds the transform which will append or set the request header from a route value.

withTransformRequestHeaderRouteValue(
    headerName: string,
    routeValueKey: string,
    append?: boolean): YarpRoute

Parameters

headerName string

routeValueKey string

append boolean optional = True

Returns

YarpRoute

method withTransformRequestHeadersAllowed

Adds the transform which will only copy the allowed request headers. Other transforms

withTransformRequestHeadersAllowed(allowedHeaders: string[]): YarpRoute

Parameters

allowedHeaders string[]

Returns

YarpRoute

method withTransformResponseHeader

Adds the transform which will append or set the response header.

withTransformResponseHeader(
    headerName: string,
    value: string,
    append?: boolean,
    condition?: ResponseCondition): YarpRoute

Parameters

headerName string

value string

append boolean optional = True

condition ResponseCondition optional = Success

Returns

YarpRoute

method withTransformResponseHeaderRemove

Adds the transform which will remove the response header.

withTransformResponseHeaderRemove(
    headerName: string,
    condition?: ResponseCondition): YarpRoute

Parameters

headerName string

condition ResponseCondition optional = Success

Returns

YarpRoute

method withTransformResponseHeadersAllowed

Adds the transform which will only copy the allowed response headers. Other transforms

withTransformResponseHeadersAllowed(allowedHeaders: string[]): YarpRoute

Parameters

allowedHeaders string[]

Returns

YarpRoute

method withTransformResponseTrailer

Adds the transform which will append or set the response trailer.

withTransformResponseTrailer(
    headerName: string,
    value: string,
    append?: boolean,
    condition?: ResponseCondition): YarpRoute

Parameters

headerName string

value string

append boolean optional = True

condition ResponseCondition optional = Success

Returns

YarpRoute

method withTransformResponseTrailerRemove

Adds the transform which will remove the response trailer.

withTransformResponseTrailerRemove(
    headerName: string,
    condition?: ResponseCondition): YarpRoute

Parameters

headerName string

condition ResponseCondition optional = Success

Returns

YarpRoute

method withTransformResponseTrailersAllowed

Adds the transform which will only copy the allowed response trailers. Other transforms

withTransformResponseTrailersAllowed(allowedHeaders: string[]): YarpRoute

Parameters

allowedHeaders string[]

Returns

YarpRoute

method withTransforms

Sets the transforms for the route.

withTransforms(transforms: Dict<string,string>[]): YarpRoute

Parameters

transforms Dict<string,string>[]

Returns

YarpRoute

method withTransformUseOriginalHostHeader

Adds the transform which will copy the incoming request Host header to the proxy request.

withTransformUseOriginalHostHeader(useOriginal?: boolean): YarpRoute

Parameters

useOriginal boolean optional = True

Returns

YarpRoute

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