Interface FastifyRequest<RouteGeneric, RawServer, RawRequest, SchemaCompiler, TypeProvider, ContextConfig, Logger, RequestType>

FastifyRequest is an instance of the standard http or http2 request objects. It defaults to http.IncomingMessage, and it also extends the relative request object.

interface FastifyRequest<RouteGeneric, RawServer, RawRequest, SchemaCompiler, TypeProvider, ContextConfig, Logger, RequestType> {
    body: RequestType["body"];
    connection: RawRequest["socket"];
    context: FastifyRequestContext<ContextConfig>;
    headers: RawRequest["headers"] & RequestType["headers"];
    hostname: string;
    id: string;
    ip: string;
    ips?: string[];
    is404: boolean;
    log: Logger;
    method: string;
    originalUrl: string;
    params: RequestType["params"];
    protocol: "https" | "http";
    query: RequestType["query"];
    raw: RawRequest;
    req: RawRequest & RouteGeneric["Headers"];
    routeConfig: FastifyContextConfig & FastifyRouteConfig & ContextConfig;
    routeOptions: Readonly<RequestRouteOptions<ContextConfig, SchemaCompiler>>;
    routeSchema?: FastifySchema;
    routerMethod: string;
    routerPath: string;
    server: FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>;
    socket: RawRequest["socket"];
    url: string;
    validationError?: Error & {
        validation: any;
        validationContext: string;
    };
    compileValidationSchema(schema, httpPart?): ValidationFunction;
    getValidationFunction(httpPart): ValidationFunction;
    getValidationFunction(schema): ValidationFunction;
    validateInput(input, schema, httpPart?): boolean;
    validateInput(input, httpPart?): boolean;
}

Type Parameters

Properties

body connection context headers hostname id ip ips? is404 log method originalUrl params protocol query raw req routeConfig routeOptions routeSchema? routerMethod routerPath server socket url validationError?

Methods

compileValidationSchema getValidationFunction validateInput

Properties

body

body: RequestType["body"]

Readonly connection

connection: RawRequest["socket"]

context

context: FastifyRequestContext<ContextConfig>

headers

headers: RawRequest["headers"] & RequestType["headers"]

Readonly hostname

hostname: string

id

id: string

Readonly ip

ip: string

Optional Readonly ips

ips?: string[]

Readonly is404

is404: boolean

log

log: Logger

Readonly method

method: string

Readonly originalUrl

originalUrl: string

params

params: RequestType["params"]

Readonly protocol

protocol: "https" | "http"

query

query: RequestType["query"]

raw

raw: RawRequest

Readonly req

req: RawRequest & RouteGeneric["Headers"]

Deprecated

Use raw property

routeConfig

routeConfig: FastifyContextConfig & FastifyRouteConfig & ContextConfig

Readonly routeOptions

routeOptions: Readonly<RequestRouteOptions<ContextConfig, SchemaCompiler>>

Optional routeSchema

routeSchema?: FastifySchema

Readonly routerMethod

routerMethod: string

Readonly routerPath

routerPath: string

server

server: FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>

Readonly socket

socket: RawRequest["socket"]

Readonly url

url: string

Optional validationError

validationError?: Error & {
    validation: any;
    validationContext: string;
}

in order for this to be used the user should ensure they have set the attachValidation option.

Type declaration

  • validation: any
  • validationContext: string

Methods

compileValidationSchema

getValidationFunction

validateInput

  • validateInput(input, schema, httpPart?): boolean

  • Parameters

    • input: any
    • schema: {
          [key: string]: any;
      }
      • [key: string]: any
    • Optional httpPart: HTTPRequestPart

    Returns boolean

  • validateInput(input, httpPart?): boolean

  • Parameters

    Returns boolean

Settings

Member Visibility

Theme

On This Page

bodyconnectioncontextheadershostnameidipipsis404logmethodoriginalUrlparamsprotocolqueryrawreqrouteConfigrouteOptionsrouteSchemarouterMethodrouterPathserversocketurlvalidationErrorcompileValidationSchemagetValidationFunctionvalidateInput