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.6.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 filtersReset all

Methods

methodwithMatch

Set the parameters used to match requests.

withMatch(match: YarpRouteMatch): YarpRoute

Parameters

matchYarpRouteMatch

Returns

YarpRoute

methodwithMatchHeaders

Only match requests that contain all of these headers.

withMatchHeaders(headers: YarpRouteHeaderMatch[]): YarpRoute

Parameters

headersYarpRouteHeaderMatch[]

Returns

YarpRoute

methodwithMatchHosts

Only match requests with the given Host header. Supports wildcards and ports. For unicode host names, do not use punycode.

withMatchHosts(hosts: string[]): YarpRoute

Parameters

hostsstring[]

Returns

YarpRoute

methodwithMatchMethods

Only match requests that use these optional HTTP methods. E.g. GET, POST.

withMatchMethods(methods: string[]): YarpRoute

Parameters

methodsstring[]

Returns

YarpRoute

methodwithMatchPath

Only match requests with the given Path pattern.

withMatchPath(path: string): YarpRoute

Parameters

pathstring

Returns

YarpRoute

methodwithMatchRouteQueryParameter

Only match requests that contain all of these query parameters.

withMatchRouteQueryParameter(queryParameters: YarpRouteQueryParameterMatch[]): YarpRoute

Parameters

queryParametersYarpRouteQueryParameterMatch[]

Returns

YarpRoute

methodwithMaxRequestBodySize

Set the MaxRequestBodySize for the destination

withMaxRequestBodySize(maxRequestBodySize: number): YarpRoute

Parameters

maxRequestBodySizenumber

Returns

YarpRoute

methodwithMetadata

Set the Metadata of the destination

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

Parameters

metadataDict<string,string>

Returns

YarpRoute

methodwithOrder

Set the order for the destination

withOrder(order: number): YarpRoute

Parameters

ordernumber

Returns

YarpRoute

methodwithTransform

Add a new transform to the destination.

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

Parameters

transformDict<string,string>

Returns

YarpRoute

methodwithTransformClientCertHeader

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

withTransformClientCertHeader(headerName: string): YarpRoute

Parameters

headerNamestring

Returns

YarpRoute

methodwithTransformCopyRequestHeaders

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

withTransformCopyRequestHeaders(copy?: boolean): YarpRoute

Parameters

copybooleanoptional= True

Returns

YarpRoute

methodwithTransformCopyResponseHeaders

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

withTransformCopyResponseHeaders(copy?: boolean): YarpRoute

Parameters

copybooleanoptional= True

Returns

YarpRoute

methodwithTransformCopyResponseTrailers

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

withTransformCopyResponseTrailers(copy?: boolean): YarpRoute

Parameters

copybooleanoptional= True

Returns

YarpRoute

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

methodwithTransformHttpMethodChange

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

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

Parameters

fromHttpMethodstring

toHttpMethodstring

Returns

YarpRoute

methodwithTransformPathPrefix

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

withTransformPathPrefix(prefix: string): YarpRoute

Parameters

prefixstring

Returns

YarpRoute

methodwithTransformPathRemovePrefix

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

withTransformPathRemovePrefix(prefix: string): YarpRoute

Parameters

prefixstring

Returns

YarpRoute

methodwithTransformPathRouteValues

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

withTransformPathRouteValues(pattern: string): YarpRoute

Parameters

patternstring

Returns

YarpRoute

methodwithTransformPathSet

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

withTransformPathSet(path: string): YarpRoute

Parameters

pathstring

Returns

YarpRoute

methodwithTransformQueryRemoveKey

Adds the transform that will remove the given query key.

withTransformQueryRemoveKey(queryKey: string): YarpRoute

Parameters

queryKeystring

Returns

YarpRoute

methodwithTransformQueryRouteValue

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

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

Parameters

queryKeystring

routeValueKeystring

appendbooleanoptional= True

Returns

YarpRoute

methodwithTransformQueryValue

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

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

Parameters

queryKeystring

valuestring

appendbooleanoptional= True

Returns

YarpRoute

methodwithTransformRequestHeader

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

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

Parameters

headerNamestring

valuestring

appendbooleanoptional= True

Returns

YarpRoute

methodwithTransformRequestHeaderRemove

Adds the transform which will remove the request header.

withTransformRequestHeaderRemove(headerName: string): YarpRoute

Parameters

headerNamestring

Returns

YarpRoute

methodwithTransformRequestHeaderRouteValue

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

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

Parameters

headerNamestring

routeValueKeystring

appendbooleanoptional= True

Returns

YarpRoute

methodwithTransformRequestHeadersAllowed

Adds the transform which will only copy the allowed request headers. Other transforms that modify or append to existing headers may be affected if not included in the allow list.

withTransformRequestHeadersAllowed(allowedHeaders: string[]): YarpRoute

Parameters

allowedHeadersstring[]

Returns

YarpRoute

methodwithTransformResponseHeader

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

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

Parameters

headerNamestring

valuestring

appendbooleanoptional= True

conditionResponseConditionoptional= Success

Returns

YarpRoute

methodwithTransformResponseHeaderRemove

Adds the transform which will remove the response header.

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

Parameters

headerNamestring

conditionResponseConditionoptional= Success

Returns

YarpRoute

methodwithTransformResponseHeadersAllowed

Adds the transform which will only copy the allowed response headers. Other transforms that modify or append to existing headers may be affected if not included in the allow list.

withTransformResponseHeadersAllowed(allowedHeaders: string[]): YarpRoute

Parameters

allowedHeadersstring[]

Returns

YarpRoute

methodwithTransformResponseTrailer

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

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

Parameters

headerNamestring

valuestring

appendbooleanoptional= True

conditionResponseConditionoptional= Success

Returns

YarpRoute

methodwithTransformResponseTrailerRemove

Adds the transform which will remove the response trailer.

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

Parameters

headerNamestring

conditionResponseConditionoptional= Success

Returns

YarpRoute

methodwithTransformResponseTrailersAllowed

Adds the transform which will only copy the allowed response trailers. Other transforms that modify or append to existing trailers may be affected if not included in the allow list.

withTransformResponseTrailersAllowed(allowedHeaders: string[]): YarpRoute

Parameters

allowedHeadersstring[]

Returns

YarpRoute

methodwithTransforms

Set the Transforms of the destination

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

Parameters

transformsDict<string,string>[]

Returns

YarpRoute

methodwithTransformUseOriginalHostHeader

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

withTransformUseOriginalHostHeader(useOriginal?: boolean): YarpRoute

Parameters

useOriginalbooleanoptional= True

Returns

YarpRoute

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