Skip to main content

Interface: HttpRequest

Represents an HTTP request, including method, path, URL, headers, query parameters, route parameters, body, IP address, and cookies. Provides methods to retrieve specific cookies and headers.

Properties​

body​

body: unknown

cookies​

cookies: Readonly<Record<string, string | undefined>>

files?​

optional files?: readonly UploadedFile[]

The files received in a multipart/form-data request. Undefined until the request has been parsed with parseMultipart.

headers​

headers: Readonly<Record<string, string | string[] | undefined>>

ip​

ip: string | undefined

method​

method: string

params​

params: Readonly<Record<string, string | string[]>>

path​

path: string

query​

query: Readonly<Record<string, string | string[]>>

url​

url: string

Methods​

getCookie()​

getCookie(name): string | undefined

Parameters​

name​

string

Returns​

string | undefined

getHeader()​

getHeader(name): string | string[] | undefined

Parameters​

name​

string

Returns​

string | string[] | undefined

parseMultipart()?​

optional parseMultipart(definition): Promise<void>

Parses a multipart/form-data request applying the given limits. Files are exposed in files and text fields in body.

Parameters​

definition​

FileUploadDefinition

Returns​

Promise<void>

Throws​

FileUploadLimitError when a limit is exceeded.