beamable-sdk / network/http/types/HttpRequest / HttpRequest
Interface: HttpRequest<TReq>¶
Defined in: src/network/http/types/HttpRequest.ts:7
Describes the configuration for an HTTP request.
Type Parameters¶
TReq¶
TReq = any
The expected type of the request body.
Properties¶
body?¶
optionalbody:TReq
Defined in: src/network/http/types/HttpRequest.ts:21
The payload to send with the request, of type TReq.
headers?¶
optionalheaders:Record<string,string>
Defined in: src/network/http/types/HttpRequest.ts:18
A collection of HTTP headers to include with the request.
method?¶
optionalmethod:HttpMethod
Defined in: src/network/http/types/HttpRequest.ts:15
The HTTP method to use for the request (e.g., 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'). If omitted, the requester will assume a default (often 'GET').
url¶
url:
string
Defined in: src/network/http/types/HttpRequest.ts:9
The URL for the request. Can be a full URL or a path relative to the base URL.
withAuth?¶
optionalwithAuth:boolean
Defined in: src/network/http/types/HttpRequest.ts:27
Whether to automatically include an authorization token (e.g., Bearer token) in the request headers. Implementations should respect this flag.