search string side menu

Advanced request parameters

Hierarchy

  • HttpApiRequest

Properties

Optional Readonly body

body: string | FormData | ArrayBuffer

Body of the request.

Optional Readonly bodyType

bodyType: "string" | "formdata" | "bytes"

Type of data stored in body.

Helps to understand what exactly is stored in the body property:

  • string: a simple string (type string).
  • formdata: data of a form ( type FormData).
  • bytes: binary data (type ArrayBuffer).

Optional Readonly fragment

fragment: undefined | string

Additional part of the URL path to the API method.

Optional Readonly headers

headers: Readonly<Record<string, string>>

Headers.

Readonly host

host: string

Domain or IP address of the request.

Optional Readonly method

method: "GET" | "POST" | "PUT" | "DELETE" | "HEAD" | "OPTIONS" | string

HTTP request method.

Readonly path

path: string

Relative path to the URL API method.

Optional Readonly port

port: undefined | number

Request port.

Optional Readonly query

query: Readonly<URLSearchParams>

Parameters of the URL string for a query.

Readonly scheme

scheme: string

Request protocol.