Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ResponseTransform

Hierarchy

  • ResponseTransform

Index

Properties

matchReplaceBody?: [string | RegExp, string][]

Perform a series of string match & replace operations on the response body.

This parameter should be an array of pairs, which will be applied to the body decoded as a string like body.replace(p1, p2), applied in the order provided. The first parameter can be either a string or RegExp to match, and the second must be a string to insert. The normal str.replace $ placeholders can be used in the second argument, so that e.g. $1 will insert the 1st matched group.

replaceBody?: string | Uint8Array | Buffer

A string or buffer that replaces the response body entirely.

If this is specified, the downstream response will not wait for the original response body, so this may make responses arrive faster than they would be otherwise given large response bodies or slow/streaming servers.

replaceBodyFromFile?: string

The path to a file, which will be used to replace the response body entirely. The file will be re-read for each response, so the body will always reflect the latest file contents.

If this is specified, the downstream response will not wait for the original response body, so this may make responses arrive faster than they would be otherwise given large response bodies or slow/streaming servers.

replaceHeaders?: Headers

A headers object which will completely replace the real response headers.

replaceStatus?: number

A replacement response status code.

updateHeaders?: Headers

A headers object which will be merged with the real response headers to add or replace values. Headers with undefined values will be removed.

updateJsonBody?: {}

A JSON object which will be merged with the real response body. Undefined values will be removed. Any responses which are received with an invalid JSON body that match this rule will fail.

Type declaration

  • [key: string]: any

Generated using TypeDoc