AuthenticatedRequest
Api Code Documentation / Exports / httpd/lib / AuthenticatedRequest
httpd/lib.AuthenticatedRequest
Hierarchy#
FastifyRequest↳
AuthenticatedRequest
Table of contents#
Properties#
- body
- connection
- context
- headers
- hostname
- id
- ip
- ips
- is404
- log
- method
- metrics
- params
- protocol
- query
- raw
- req
- routerMethod
- routerPath
- server
- socket
- url
- user
- validationError
Properties#
body#
• body: unknown
Inherited from#
FastifyRequest.body
Defined in#
node_modules/fastify/types/request.d.ts:32
connection#
• Readonly connection: Socket
Inherited from#
FastifyRequest.connection
Defined in#
node_modules/fastify/types/request.d.ts:55
context#
• context: FastifyContext<unknown>
Inherited from#
FastifyRequest.context
Defined in#
node_modules/fastify/types/request.d.ts:33
headers#
• headers: IncomingHttpHeaders
Inherited from#
FastifyRequest.headers
Defined in#
node_modules/fastify/types/request.d.ts:29
hostname#
• Readonly hostname: string
Inherited from#
FastifyRequest.hostname
Defined in#
node_modules/fastify/types/request.d.ts:44
id#
• id: any
Inherited from#
FastifyRequest.id
Defined in#
node_modules/fastify/types/request.d.ts:25
ip#
• Readonly ip: string
Inherited from#
FastifyRequest.ip
Defined in#
node_modules/fastify/types/request.d.ts:42
ips#
• Optional Readonly ips: string[]
Inherited from#
FastifyRequest.ips
Defined in#
node_modules/fastify/types/request.d.ts:43
is404#
• Readonly is404: boolean
Inherited from#
FastifyRequest.is404
Defined in#
node_modules/fastify/types/request.d.ts:50
log#
• log: FastifyLoggerInstance
Inherited from#
FastifyRequest.log
Defined in#
node_modules/fastify/types/request.d.ts:30
method#
• Readonly method: string
Inherited from#
FastifyRequest.method
Defined in#
node_modules/fastify/types/request.d.ts:47
metrics#
• Optional metrics: Object
Type declaration#
| Name | Type |
|---|---|
hist | (labels?: Partial<Record<string, string | number>>) => void |
sum | (labels?: Partial<Record<string, string | number>>) => void |
Inherited from#
FastifyRequest.metrics
Defined in#
node_modules/fastify-metrics/dist/index.d.ts:18
params#
• params: unknown
Inherited from#
FastifyRequest.params
Defined in#
node_modules/fastify/types/request.d.ts:26
protocol#
• Readonly protocol: "http" | "https"
Inherited from#
FastifyRequest.protocol
Defined in#
node_modules/fastify/types/request.d.ts:46
query#
• query: unknown
Inherited from#
FastifyRequest.query
Defined in#
node_modules/fastify/types/request.d.ts:28
raw#
• raw: IncomingMessage
Inherited from#
FastifyRequest.raw
Defined in#
node_modules/fastify/types/request.d.ts:27
req#
• Readonly req: IncomingMessage
deprecated Use raw property
Inherited from#
FastifyRequest.req
Defined in#
node_modules/fastify/types/request.d.ts:41
routerMethod#
• Readonly routerMethod: string
Inherited from#
FastifyRequest.routerMethod
Defined in#
node_modules/fastify/types/request.d.ts:49
routerPath#
• Readonly routerPath: string
Inherited from#
FastifyRequest.routerPath
Defined in#
node_modules/fastify/types/request.d.ts:48
server#
• server: FastifyInstance<Server, IncomingMessage, ServerResponse, FastifyLoggerInstance>
Inherited from#
FastifyRequest.server
Defined in#
node_modules/fastify/types/request.d.ts:31
socket#
• Readonly socket: Socket
Inherited from#
FastifyRequest.socket
Defined in#
node_modules/fastify/types/request.d.ts:51
url#
• Readonly url: string
Inherited from#
FastifyRequest.url
Defined in#
node_modules/fastify/types/request.d.ts:45
user#
• user: AuthToken
Defined in#
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:36