Interface ExtendedFastifyRequest

interface ExtendedFastifyRequest {
    body: unknown;
    connection: Socket;
    context: FastifyRequestContext<unknown>;
    cookies?: {
        [key: string]: string;
    };
    files?: any;
    headers: IncomingHttpHeaders;
    hostname: string;
    id: string;
    ip: string;
    ips?: string[];
    is404: boolean;
    log: FastifyBaseLogger;
    method: string;
    originalUrl: string;
    params: unknown;
    protocol: "http" | "https";
    query: unknown;
    raw: IncomingMessage;
    req: IncomingMessage;
    routeConfig: FastifyContextConfig & FastifyRouteConfig;
    routeOptions: Readonly<RequestRouteOptions<unknown, FastifySchema>>;
    routeSchema?: FastifySchema;
    routerMethod: string;
    routerPath: string;
    server: FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>;
    socket: Socket;
    url: string;
    user?: any;
    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;
}

Hierarchy

  • FastifyRequest
    • ExtendedFastifyRequest

Properties

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

Methods

compileValidationSchema getValidationFunction validateInput

Properties

body

body: unknown

Readonly connection

connection: Socket

context

context: FastifyRequestContext<unknown>

Optional cookies

cookies?: {
    [key: string]: string;
}

Type declaration

  • [key: string]: string

Optional files

files?: any

headers

headers: IncomingHttpHeaders

Readonly hostname

hostname: string

id

id: string

Readonly ip

ip: string

Optional Readonly ips

ips?: string[]

Readonly is404

is404: boolean

log

log: FastifyBaseLogger

Readonly method

method: string

Readonly originalUrl

originalUrl: string

params

params: unknown

Readonly protocol

protocol: "http" | "https"

query

query: unknown

raw

raw: IncomingMessage

Readonly req

req: IncomingMessage

Deprecated

Use raw property

routeConfig

routeConfig: FastifyContextConfig & FastifyRouteConfig

Readonly routeOptions

routeOptions: Readonly<RequestRouteOptions<unknown, FastifySchema>>

Optional routeSchema

routeSchema?: FastifySchema

Readonly routerMethod

routerMethod: string

Readonly routerPath

routerPath: string

server

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

Readonly socket

socket: Socket

Readonly url

url: string

Optional user

user?: any

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

  • compileValidationSchema(schema, httpPart?): ValidationFunction

  • Parameters

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

    Returns ValidationFunction

getValidationFunction

  • getValidationFunction(httpPart): ValidationFunction

  • Parameters

    • httpPart: HTTPRequestPart

    Returns ValidationFunction

  • getValidationFunction(schema): ValidationFunction

  • Parameters

    • schema: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns ValidationFunction

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

    • input: any
    • Optional httpPart: HTTPRequestPart

    Returns boolean

Settings

Member Visibility

Theme

On This Page

bodyconnectioncontextcookiesfilesheadershostnameidipipsis404logmethodoriginalUrlparamsprotocolqueryrawreqrouteConfigrouteOptionsrouteSchemarouterMethodrouterPathserversocketurluservalidationErrorcompileValidationSchemagetValidationFunctionvalidateInput