Request

The Request class represents an HTTP request with various properties such as URL, parameters, method, headers, body, and body type. This object is passed to an endpoint when a request is made.

Properties

url

• Type - string (readonly)
• Description - The URL of the HTTP request.

params

• Type - { path: Parameters, query: Parameters } (readonly)
• Description - An object containing path and query parameters represented by instances of the Parameters class.

method

• Type - keyof typeof Method (readonly)
• Description - The HTTP method of the request, represented as one of the keys of the Method enum.

headers

• Type - Headers (readonly)
• Description - The headers of the request, represented by an instance of the Headers class.

body

• Type - Body (readonly)
• Description - The body of the request, which can be undefined, a string, or a JSON object. The body will be automatically parsed from the request.

bodyType

• Type - keyof typeof BodyType (readonly)
• Description: The type of the request body, represented as one of the keys of the BodyType enum.

Enums

BodyType

An enum representing the possible types of the request body:

• JSON - The body is in JSON format.
• Text - The body is in plain text format.
• HTML - The body is in HTML format.
• None - There is no body associated with the request.

Method

An enum representing the HTTP method type.

• GET - HTTP GET method request
• PUT - HTTP PUT method request
• POST - HTTP POST method request
• PATCH - HTTP PATCH method request
• DELETE - HTTP DELETE method request

Examples

The following examples, illustrate how the Request object will be passed to an endpoint.

Basic GET Request

GET /regular
GET /regular?foo=1&foo=true,example

{
    "url": "/regular",
    "params": {
        "path": {},
        "query": {
            "foo": [
                1,
                true,
                "example"
            ]
        }
    },
    "method": "GET",
    "headers": {
        "content-type": "application/json",
        "user-agent": "PostmanRuntime/7.37.3",
        "accept": "*/*",
        "postman-token": "62c2eb4b-8e06-4bbe-9c21-ed7755f08aeb",
        "host": "localhost:3000",
        "accept-encoding": "gzip, deflate, br",
        "connection": "keep-alive",
        "content-length": "18"
    },
    "bodyType": "None"
}

Dynamic POST Request

POST /user/[userID]
POST /user/bob

{
    "url": "/regular",
    "params": {
        "path": {
            "userID": "bob"
        },
        "query": {}
    },
    "method": "POST",
    "headers": {
        "content-type": "application/json",
        "user-agent": "PostmanRuntime/7.37.3",
        "accept": "*/*",
        "postman-token": "62c2eb4b-8e06-4bbe-9c21-ed7755f08aeb",
        "host": "localhost:3000",
        "accept-encoding": "gzip, deflate, br",
        "connection": "keep-alive",
        "content-length": "18"
    },
    "bodyType": "JSON",
    "body": {
        "example": "hello world"
    }
}