Skip to content

Documentation / base / HttpRequest

Class: HttpRequest

Defined in: libs/base/src/utils.ts:338

Wrapper of a http get request

Constructors

Constructor

new HttpRequest(urlResolver?): HttpRequest

Defined in: libs/base/src/utils.ts:347

Parameters

urlResolver?

(url) => string

Returns

HttpRequest

Accessors

urlResolver

Get Signature

get urlResolver(): (url) => string

Defined in: libs/base/src/utils.ts:353

Get the custom URL resolver

Returns

(url) => string

Set Signature

set urlResolver(resolver): void

Defined in: libs/base/src/utils.ts:356

Parameters
resolver

(url) => string

Returns

void


crossOrigin

Get Signature

get crossOrigin(): string

Defined in: libs/base/src/utils.ts:360

Get the cross origin property

Returns

string

Set Signature

set crossOrigin(val): void

Defined in: libs/base/src/utils.ts:363

Parameters
val

string

Returns

void


headers

Get Signature

get headers(): Record<string, string>

Defined in: libs/base/src/utils.ts:367

Get the request headers

Returns

Record<string, string>

Set Signature

set headers(val): void

Defined in: libs/base/src/utils.ts:370

Parameters
val

Record<string, string>

Returns

void

Methods

resolveURL()

resolveURL(url): string

Defined in: libs/base/src/utils.ts:378

Resolves a URL string.

Parameters

url

string

The input url string,

Returns

string

The resolved URL string.


request()

request(url): Promise<Response>

Defined in: libs/base/src/utils.ts:390

Send a GET request.

Parameters

url

string

The remote URL to fetch.

Returns

Promise<Response>

The fetch result.


requestText()

requestText(url): Promise<string>

Defined in: libs/base/src/utils.ts:404

Fetch a text string from remote.

Parameters

url

string

The remote URL to fetch.

Returns

Promise<string>

The fetch result.


requestJson()

requestJson(url): Promise<any>

Defined in: libs/base/src/utils.ts:416

Fetch a json object from remote.

Parameters

url

string

The remote URL to fetch.

Returns

Promise<any>

The fetch result.


requestArrayBuffer()

requestArrayBuffer(url): Promise<ArrayBuffer>

Defined in: libs/base/src/utils.ts:428

Fetch an array buffer from remote.

Parameters

url

string

The remote URL to fetch.

Returns

Promise<ArrayBuffer>

The fetch result.


requestBlob()

requestBlob(url): Promise<Blob>

Defined in: libs/base/src/utils.ts:440

Fetch a blob object from remote.

Parameters

url

string

The remote URL to fetch.

Returns

Promise<Blob>

The fetch result.

Released under the MIT License.