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

api: Client

An instance of the API client for blog.

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.

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.

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: Description["Body"]

All blog configuration values

connection: Socket
connections: AppConnections

A map of connection name to instantiated connection objects for blog

context: FastifyContext<unknown>
gadgetContext: Record<string, any>

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

headers: IncomingHttpHeaders & Description["Headers"]
hostname: string
id: any
ip: string
ips?: string[]
is404: boolean
log: FastifyLoggerInstance
logger: FastifyLoggerInstance

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

method: string
params: Description["Params"]
protocol: "http" | "https"
query: Description["Querystring"]
raw: IncomingMessage
req: IncomingMessage
deprecated

Use raw property

routerMethod: string
routerPath: string
server: FastifyInstance<Server, IncomingMessage, ServerResponse, FastifyLoggerInstance>
socket: Socket
url: string
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