Type alias GatewayControllerHeaderOptions

GatewayControllerHeaderOptions: {
    copy: string[];
    copyCustomHeaders: boolean;
    remove: string[];
    useXForwardedFor: boolean;
}

The options for how the gateway will handle the headers from the requests and the responses.

Type declaration

  • copy: string[]

    A list of "known" headers the gateway will try to copy from the incoming request.

    Default

    ['authorization','content-type', 'referer', 'user-agent']
    
  • copyCustomHeaders: boolean

    Whether or not to copy all custom headers from the request. By custom header, it means all the headers which names start with x-.

    Default

    true
    
  • remove: string[]

    A list of "known" headers the gateway will try to remove the response.

    Default

    ['server', 'x-powered-by']
    
  • useXForwardedFor: boolean

    Whether or not to include the header with the request's IP address.

    Default

    true
    

Generated using TypeDoc