Skip to main content

Class: FastifyHttpRequest

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.

Implements​

Constructors​

Constructor​

new FastifyHttpRequest(request): FastifyHttpRequest

Parameters​

request​

FastifyRequest

Returns​

FastifyHttpRequest

Accessors​

body​

Get Signature​

get body(): unknown

Returns​

unknown

Implementation of​

HttpRequest.body

cookies​

Get Signature​

get cookies(): object & Record<string, string>

Returns​

object & Record<string, string>

Implementation of​

HttpRequest.cookies

files​

Get Signature​

get files(): readonly UploadedFile[] | undefined

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

Returns​

readonly UploadedFile[] | undefined

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

Implementation of​

HttpRequest.files

headers​

Get Signature​

get headers(): IncomingHttpHeaders

Returns​

IncomingHttpHeaders

Implementation of​

HttpRequest.headers

ip​

Get Signature​

get ip(): string

Returns​

string

Implementation of​

HttpRequest.ip

method​

Get Signature​

get method(): string

Returns​

string

Implementation of​

HttpRequest.method

params​

Get Signature​

get params(): Record<string, string>

Returns​

Record<string, string>

Implementation of​

HttpRequest.params

path​

Get Signature​

get path(): string

Returns​

string

Implementation of​

HttpRequest.path

query​

Get Signature​

get query(): Record<string, string | string[]>

Returns​

Record<string, string | string[]>

Implementation of​

HttpRequest.query

session​

Get Signature​

get session(): FastifySessionObject

Returns​

FastifySessionObject

url​

Get Signature​

get url(): string

Returns​

string

Implementation of​

HttpRequest.url

Methods​

getCookie()​

getCookie(name): string | undefined

Parameters​

name​

string

Returns​

string | undefined

Implementation of​

HttpRequest.getCookie

getHeader()​

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

Parameters​

name​

string

Returns​

string | string[] | undefined

Implementation of​

HttpRequest.getHeader

parseMultipart()​

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.

Implementation of​

HttpRequest.parseMultipart