Skip to main content

Class: Request

Defined in: packages/core/src/router/Request.ts:9

Wrapper for the ExpressJS request, exposing only the necessary minimum.

Constructors​

Constructor​

new Request(): Request

Returns​

Request

Properties​

_request?​

protected optional _request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

Defined in: packages/core/src/router/Request.ts:14

The current ExpressJS request object, or null if running at the client side.

Accessors​

$dependencies​

Get Signature​

get static $dependencies(): never[]

Defined in: packages/core/src/router/Request.ts:16

Returns​

never[]

Methods​

getBody()​

getBody(): any

Defined in: packages/core/src/router/Request.ts:68

Returns body of request.

Returns​

any

getCookieHeader()​

getCookieHeader(): string | undefined

Defined in: packages/core/src/router/Request.ts:45

Returns the Cookie HTTP header value.

Returns​

string | undefined

The value of the Cookie header.

getFile()​

getFile(): any

Defined in: packages/core/src/router/Request.ts:52

Returns uploaded file to server and meta information.

Returns​

any

getFiles()​

getFiles(): any

Defined in: packages/core/src/router/Request.ts:60

Returns uploaded files to server with their meta information.

Returns​

any

getHeader()​

getHeader(header): string | null

Defined in: packages/core/src/router/Request.ts:75

Returns the specified HTTP request header.

Parameters​

string

Returns​

string | null

getIP()​

getIP(): string | null

Defined in: packages/core/src/router/Request.ts:82

Returns the remote IP address of the request.

Returns​

string | null

getIPs()​

getIPs(): string[]

Defined in: packages/core/src/router/Request.ts:90

Returns array of IP addresses specified in the “X-Forwarded-For” request header.

Returns​

string[]

getMethod()​

getMethod(): string

Defined in: packages/core/src/router/Request.ts:97

Returns the HTTP method of the request.

Returns​

string

getPath()​

getPath(): string

Defined in: packages/core/src/router/Request.ts:36

Returns the path part of the URL to which the request was made.

Returns​

string

The path to which the request was made.

getRequest()​

getRequest(): Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>> | undefined

Defined in: packages/core/src/router/Request.ts:104

Returns the raw request.

Returns​

Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>> | undefined

init()​

init(request): void

Defined in: packages/core/src/router/Request.ts:27

Initializes the request using the provided ExpressJS request object.

Parameters​

request​

Request

The ExpressJS request object representing the current request. Use null at the client side.

Returns​

void