Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Request<Description>

A request instance, to query data on an incoming HTTP request.

Type Parameters

Hierarchy

  • FastifyRequest<Description>
    • Request

Index

Properties

Properties

api

api: Client

An instance of the API client for alida-quiz-app-2.

Note: This client is authorized using a superuser internal api token and has permission to invoke any action in the system using normal API mutations or the Internal API.

Optional applicationSession

applicationSession?: Session

The current request's session, if it has one. Requests made by browsers are given sessions, but requests made using Gadget API Keys are not.

Optional applicationSessionID

applicationSessionID?: string

The current request's session ID, if it has one. Requests made by browsers are given sessions, but requests made using Gadget API Keys are not.

body

body: Description["Body"]

config

config: AppConfiguration

All alida-quiz-app-2 configuration values

Readonly connection

connection: Socket

connections

connections: AppConnections

A map of connection name to instantiated connection objects for alida-quiz-app-2

context

context: FastifyContext<unknown>

gadgetContext

gadgetContext: Record<string, any>

An context object used by Gadget to store request information that it is responsible for managing.

headers

headers: IncomingHttpHeaders & Description["Headers"]

Readonly hostname

hostname: string

id

id: any

Readonly ip

ip: string

Optional Readonly ips

ips?: string[]

Readonly is404

is404: boolean

log

log: FastifyLoggerInstance

logger

logger: FastifyLoggerInstance

A high performance structured logger which writes logs to the Logs Viewer in the Gadget Editor.

Readonly method

method: string

params

params: Description["Params"]

Readonly protocol

protocol: "http" | "https"

query

query: Description["Querystring"]

raw

raw: IncomingMessage

Readonly req

req: IncomingMessage
deprecated

Use raw property

Readonly routerMethod

routerMethod: string

Readonly routerPath

routerPath: string

server

server: FastifyInstance<Server, IncomingMessage, ServerResponse, FastifyLoggerInstance>

Readonly socket

socket: 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.

Generated using TypeDoc