Page Contents

Home > @loopback/rest > RequestContext

RequestContext class

A per-request Context combining an IoC container with handler context (request, response, etc.).

Signature:

export declare class RequestContext extends MiddlewareContext implements HandlerContext 

Extends: MiddlewareContext

Implements: HandlerContext

Constructors

Constructor Modifiers Description

(constructor)(request, response, parent, serverConfig, name)

Constructs a new instance of the RequestContext class

Properties

Property Modifiers Type Description

basePath

readonly

string

Get the effective base path of the incoming request. This base path combines baseUrl provided by Express when LB4 handler is mounted on a non-root path, with the basePath value configured at LB4 side.

request

readonly

Request

requestedBaseUrl

readonly

string

Get the base URL used by the client to make the request. This URL contains the protocol, hostname, port and base path. The path of the invoked route and query string is not included.

Please note these values may be different from what we are observing at HTTP/TCP level, because reverse proxies like nginx are rewriting them.

requestedProtocol

readonly

string

Get the protocol used by the client to make the request. Please note this protocol may be different from what we are observing at HTTP/TCP level, because reverse proxies like nginx or sidecars like Envoy are switching between protocols.

response

readonly

Response

serverConfig

readonly

RestServerResolvedConfig

Methods

Method Modifiers Description

setupBindings()

protected