Skip to main content

AuthenticatedRequest

Api Code Documentation / Exports / httpd/lib / AuthenticatedRequest

httpd/lib.AuthenticatedRequest

Hierarchy

  • FastifyRequest

    AuthenticatedRequest

Table of contents

Properties

Methods

Properties

body

body: unknown

Inherited from

FastifyRequest.body

Defined in

node_modules/fastify/types/request.d.ts:64


cleanRequestFiles

cleanRequestFiles: () => Promise<void>

Type declaration

▸ (): Promise<void>

Returns

Promise<void>

Inherited from

FastifyRequest.cleanRequestFiles

Defined in

node_modules/@fastify/multipart/types/index.d.ts:27


connection

Readonly connection: Socket

Inherited from

FastifyRequest.connection

Defined in

node_modules/fastify/types/request.d.ts:97


context

context: FastifyRequestContext<unknown>

Inherited from

FastifyRequest.context

Defined in

node_modules/fastify/types/request.d.ts:65


cookies

cookies: Object

Request cookies

Index signature

▪ [cookieName: string]: string | undefined

Inherited from

FastifyRequest.cookies

Defined in

node_modules/@fastify/cookie/types/plugin.d.ts:30


file

file: (options?: Omit<BusboyConfig, "headers"> | FastifyMultipartBaseOptions) => Promise<undefined | MultipartFile>

Type declaration

▸ (options?): Promise<undefined | MultipartFile>

Parameters
NameType
options?Omit<BusboyConfig, "headers"> | FastifyMultipartBaseOptions
Returns

Promise<undefined | MultipartFile>

Inherited from

FastifyRequest.file

Defined in

node_modules/@fastify/multipart/types/index.d.ts:16


files

files: (options?: Omit<BusboyConfig, "headers"> | FastifyMultipartBaseOptions) => AsyncIterableIterator<MultipartFile>

Type declaration

▸ (options?): AsyncIterableIterator<MultipartFile>

Parameters
NameType
options?Omit<BusboyConfig, "headers"> | FastifyMultipartBaseOptions
Returns

AsyncIterableIterator<MultipartFile>

Inherited from

FastifyRequest.files

Defined in

node_modules/@fastify/multipart/types/index.d.ts:19


headers

headers: IncomingHttpHeaders

Inherited from

FastifyRequest.headers

Defined in

node_modules/fastify/types/request.d.ts:61


hostname

Readonly hostname: string

Inherited from

FastifyRequest.hostname

Defined in

node_modules/fastify/types/request.d.ts:78


id

id: string

Inherited from

FastifyRequest.id

Defined in

node_modules/fastify/types/request.d.ts:57


ip

Readonly ip: string

Inherited from

FastifyRequest.ip

Defined in

node_modules/fastify/types/request.d.ts:76


ips

Optional Readonly ips: string[]

Inherited from

FastifyRequest.ips

Defined in

node_modules/fastify/types/request.d.ts:77


is404

Readonly is404: boolean

Inherited from

FastifyRequest.is404

Defined in

node_modules/fastify/types/request.d.ts:86


isMultipart

isMultipart: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Inherited from

FastifyRequest.isMultipart

Defined in

node_modules/@fastify/multipart/types/index.d.ts:8


log

log: FastifyBaseLogger

Inherited from

FastifyRequest.log

Defined in

node_modules/fastify/types/request.d.ts:62


method

Readonly method: string

Inherited from

FastifyRequest.method

Defined in

node_modules/fastify/types/request.d.ts:82


originalUrl

Readonly originalUrl: string

Inherited from

FastifyRequest.originalUrl

Defined in

node_modules/fastify/types/request.d.ts:80


params

params: unknown

Inherited from

FastifyRequest.params

Defined in

node_modules/fastify/types/request.d.ts:58


parts

parts: (options?: Omit<BusboyConfig, "headers">) => AsyncIterableIterator<Multipart>

Type declaration

▸ (options?): AsyncIterableIterator<Multipart>

Parameters
NameType
options?Omit<BusboyConfig, "headers">
Returns

AsyncIterableIterator<Multipart>

Inherited from

FastifyRequest.parts

Defined in

node_modules/@fastify/multipart/types/index.d.ts:11


protocol

Readonly protocol: "http" | "https"

Inherited from

FastifyRequest.protocol

Defined in

node_modules/fastify/types/request.d.ts:81


query

query: unknown

Inherited from

FastifyRequest.query

Defined in

node_modules/fastify/types/request.d.ts:60


raw

raw: IncomingMessage

Inherited from

FastifyRequest.raw

Defined in

node_modules/fastify/types/request.d.ts:59


req

Readonly req: IncomingMessage

Deprecated

Use raw property

Inherited from

FastifyRequest.req

Defined in

node_modules/fastify/types/request.d.ts:75


routeConfig

routeConfig: FastifyContextConfig & FastifyRouteConfig

Inherited from

FastifyRequest.routeConfig

Defined in

node_modules/fastify/types/request.d.ts:66


routeOptions

Readonly routeOptions: Readonly<RequestRouteOptions<unknown, FastifySchema>>

Inherited from

FastifyRequest.routeOptions

Defined in

node_modules/fastify/types/request.d.ts:85


routeSchema

Optional routeSchema: FastifySchema

Inherited from

FastifyRequest.routeSchema

Defined in

node_modules/fastify/types/request.d.ts:67


routerMethod

Readonly routerMethod: string

Inherited from

FastifyRequest.routerMethod

Defined in

node_modules/fastify/types/request.d.ts:84


routerPath

Readonly routerPath: string

Inherited from

FastifyRequest.routerPath

Defined in

node_modules/fastify/types/request.d.ts:83


saveRequestFiles

saveRequestFiles: (options?: Omit<BusboyConfig, "headers"> & { tmpdir?: string }) => Promise<SavedMultipartFile[]>

Type declaration

▸ (options?): Promise<SavedMultipartFile[]>

Parameters
NameType
options?Omit<BusboyConfig, "headers"> & { tmpdir?: string }
Returns

Promise<SavedMultipartFile[]>

Inherited from

FastifyRequest.saveRequestFiles

Defined in

node_modules/@fastify/multipart/types/index.d.ts:24


savedRequestFiles

savedRequestFiles: null | SavedMultipartFile[]

This will get populated as soon as a call to saveRequestFiles gets resolved. Avoiding any future duplicate work

Inherited from

FastifyRequest.savedRequestFiles

Defined in

node_modules/@fastify/multipart/types/index.d.ts:30


server

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

Inherited from

FastifyRequest.server

Defined in

node_modules/fastify/types/request.d.ts:63


socket

Readonly socket: Socket

Inherited from

FastifyRequest.socket

Defined in

node_modules/fastify/types/request.d.ts:87


tmpUploads

tmpUploads: null | string[]

Inherited from

FastifyRequest.tmpUploads

Defined in

node_modules/@fastify/multipart/types/index.d.ts:28


url

Readonly url: string

Inherited from

FastifyRequest.url

Defined in

node_modules/fastify/types/request.d.ts:79


user

user: AuthToken

Overrides

FastifyRequest.user

Defined in

src/httpd/lib.ts:8


validationError

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

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

Inherited from

FastifyRequest.validationError

Defined in

node_modules/fastify/types/request.d.ts:70

Methods

compileValidationSchema

compileValidationSchema(schema, httpPart?): ValidationFunction

Parameters

NameType
schemaObject
httpPart?HTTPRequestPart

Returns

ValidationFunction

Inherited from

FastifyRequest.compileValidationSchema

Defined in

node_modules/fastify/types/request.d.ts:91


getValidationFunction

getValidationFunction(httpPart): ValidationFunction

Parameters

NameType
httpPartHTTPRequestPart

Returns

ValidationFunction

Inherited from

FastifyRequest.getValidationFunction

Defined in

node_modules/fastify/types/request.d.ts:89

getValidationFunction(schema): ValidationFunction

Parameters

NameType
schemaObject

Returns

ValidationFunction

Inherited from

FastifyRequest.getValidationFunction

Defined in

node_modules/fastify/types/request.d.ts:90


jwtDecode

jwtDecode<Decoded>(options?): Promise<Decoded>

Type parameters

NameType
Decodedextends DecodePayloadType

Parameters

NameType
options?FastifyJwtDecodeOptions

Returns

Promise<Decoded>

Inherited from

FastifyRequest.jwtDecode

Defined in

node_modules/@fastify/jwt/types/jwt.d.ts:34

jwtDecode<Decoded>(callback): void

Type parameters

NameType
Decodedextends DecodePayloadType

Parameters

NameType
callbackDecodeCallback<Decoded>

Returns

void

Inherited from

FastifyRequest.jwtDecode

Defined in

node_modules/@fastify/jwt/types/jwt.d.ts:35

jwtDecode<Decoded>(options, callback): void

Type parameters

NameType
Decodedextends DecodePayloadType

Parameters

NameType
optionsFastifyJwtDecodeOptions
callbackDecodeCallback<Decoded>

Returns

void

Inherited from

FastifyRequest.jwtDecode

Defined in

node_modules/@fastify/jwt/types/jwt.d.ts:36


jwtVerify

jwtVerify<Decoded>(options?): Promise<Decoded>

Type parameters

NameType
Decodedextends VerifyPayloadType

Parameters

NameType
options?FastifyJwtVerifyOptions

Returns

Promise<Decoded>

Inherited from

FastifyRequest.jwtVerify

Defined in

node_modules/@fastify/jwt/types/jwt.d.ts:29

jwtVerify<Decoded>(callback): void

Type parameters

NameType
Decodedextends VerifyPayloadType

Parameters

NameType
callbackVerifierCallback

Returns

void

Inherited from

FastifyRequest.jwtVerify

Defined in

node_modules/@fastify/jwt/types/jwt.d.ts:30

jwtVerify<Decoded>(options, callback): void

Type parameters

NameType
Decodedextends VerifyPayloadType

Parameters

NameType
optionsFastifyJwtVerifyOptions
callbackVerifierCallback

Returns

void

Inherited from

FastifyRequest.jwtVerify

Defined in

node_modules/@fastify/jwt/types/jwt.d.ts:31

jwtVerify<Decoded>(options?): Promise<Decoded>

Type parameters

NameType
Decodedextends VerifyPayloadType

Parameters

NameType
options?Partial<VerifyOptions>

Returns

Promise<Decoded>

Inherited from

FastifyRequest.jwtVerify

Defined in

node_modules/@fastify/jwt/types/jwt.d.ts:32

jwtVerify<Decoded>(options, callback): void

Type parameters

NameType
Decodedextends VerifyPayloadType

Parameters

NameType
optionsPartial<VerifyOptions>
callbackVerifierCallback

Returns

void

Inherited from

FastifyRequest.jwtVerify

Defined in

node_modules/@fastify/jwt/types/jwt.d.ts:33


signCookie

signCookie(value): string

Signs the specified cookie using the secret/signer provided.

Parameters

NameTypeDescription
valuestringcookie value

Returns

string

Inherited from

FastifyRequest.signCookie

Defined in

node_modules/@fastify/cookie/types/plugin.d.ts:45


unsignCookie

unsignCookie(value): UnsignResult

Unsigns the specified cookie using the secret/signer provided.

Parameters

NameTypeDescription
valuestringCookie value

Returns

UnsignResult

Inherited from

FastifyRequest.unsignCookie

Defined in

node_modules/@fastify/cookie/types/plugin.d.ts:51


validateInput

validateInput(input, schema, httpPart?): boolean

Parameters

NameType
inputany
schemaObject
httpPart?HTTPRequestPart

Returns

boolean

Inherited from

FastifyRequest.validateInput

Defined in

node_modules/fastify/types/request.d.ts:92

validateInput(input, httpPart?): boolean

Parameters

NameType
inputany
httpPart?HTTPRequestPart

Returns

boolean

Inherited from

FastifyRequest.validateInput

Defined in

node_modules/fastify/types/request.d.ts:93