Skip to content

beamable-sdk / network/http/types/HttpRequester / HttpRequester

Interface: HttpRequester

Defined in: src/network/http/types/HttpRequester.ts:5

A pluggable HTTP client abstraction that can send requests and receive typed responses.

Accessors

baseUrl

Set Signature

set baseUrl(url): void

Defined in: src/network/http/types/HttpRequester.ts:18

Overrides the base URL used for all subsequent requests.

Parameters
url

string

Returns

void


defaultHeaders

Set Signature

set defaultHeaders(header): void

Defined in: src/network/http/types/HttpRequester.ts:21

Sets the default headers to include on every request.

Parameters

Record<string, string>

Returns

void

Methods

request()

request<TRes, TReq>(req): Promise<HttpResponse<TRes>>

Defined in: src/network/http/types/HttpRequester.ts:13

Sends an HTTP request and returns a typed response.

Type Parameters

TRes

TRes = any

The expected type of the response body.

TReq

TReq = any

The type of the request payload.

Parameters

req

HttpRequest<TReq>

Configuration for the HTTP request, including URL, method, headers, optional body, etc.

Returns

Promise<HttpResponse<TRes>>

A promise that resolves with an HttpResponse containing status, headers, and the parsed body as TRes.