Interface ApiXRequest<QuerySchema, BodySchema>

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

interface ApiXRequest<QuerySchema, BodySchema> {
    accessLevel: ApiXAccessLevel;
    jsonBody?: BodySchema;
    queryParameters?: QuerySchema;
}

Type Parameters

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

Hierarchy

Request
- ApiXRequest

Index

Properties

accessLevel jsonBody? queryParameters?

Properties

`Readonly`accessLevel

accessLevel: ApiXAccessLevel

The access level of the requestor.

`Optional` `Readonly`jsonBody

jsonBody?: BodySchema

The HTTP JSON Body.

`Optional` `Readonly`queryParameters

queryParameters?: QuerySchema

The URL query parameters.