Interface Request<QuerySchema, BodySchema>

A request made to an API-X endpoint. An extension of express.Request.

interface Request<
    QuerySchema extends RequestInputSchema = Record<string, never>,
    BodySchema extends RequestInputSchema = Record<string, never>,
> {
    accessLevel: AccessLevel;
    jsonBody?: BodySchema;
    queryParameters?: QuerySchema;
}

Type Parameters

QuerySchema extends RequestInputSchema = Record<string, never>
BodySchema extends RequestInputSchema = Record<string, never>

Hierarchy

Request
- Request

Index

Properties

accessLevel jsonBody? queryParameters?

Properties

`Readonly`accessLevel

accessLevel: AccessLevel

The access level of the requestor.

`Optional` `Readonly`jsonBody

jsonBody?: BodySchema

The HTTP JSON Body.

`Optional` `Readonly`queryParameters

queryParameters?: QuerySchema

The URL query parameters.