Interface HttpService

Central service for sending HTTP requests.

Use the interface "http.HttpService" to obtain an instance of this service.

interface HttpService {
    fetch(
        resource: string | URL,
        init?: HttpServiceRequestInit,
    ): Promise<Response>;
}

Hierarchy (View Summary)

DeclaredService<"http.HttpService">
- HttpService

Index

Methods

Methods

fetch

fetch(resource: string | URL, init?: HttpServiceRequestInit): Promise<Response>
Requests the given resource via HTTP and returns the response.

This method works almost exactly the same as the browser's native fetch function. However, certain Open Pioneer Trails extensions (such as interceptors) are implemented on top of fetch to enable new features.

For example, access tokens or other header / query parameters can be added automatically using an interceptor if a package uses the HttpService.

See also fetch documentation for reference.
Parameters
- resource: string | URL
- Optionalinit: HttpServiceRequestInit
Returns Promise<Response>
- Defined in http/api.ts:24