Namespace: xhr

Interfaces

Union type for all XHR load results, including success and error types.

Union type for all successful XHR load result types.

Ƭ ProgressCallback: (bytes: number) => void

Callback function that receives progress updates for bytes received.

▸ (bytes): void

Name	Type
`bytes`	`number`

void

▸ loadXhr(url, responseType, onProgress?): Promise<LoadSuccessJson | LoadError>

Perform an XHR request to load data in json format.

Name	Type	Description
`url`	`string`	The URL to request the data from
`responseType`	`"json"`	Format for the response
`onProgress?`	`ProgressCallback`	Callback to receive byte progress

▸ loadXhr(url, responseType, onProgress?): Promise<LoadSuccessText | LoadError>

Perform an XHR request to load data in text format.

Name	Type	Description
`url`	`string`	The URL to request the data from
`responseType`	`"text"`	Format for the response
`onProgress?`	`ProgressCallback`	Callback to receive byte progress

▸ loadXhr(url, responseType, onProgress?): Promise<LoadSuccessArrayBuffer | LoadError>

Perform an XHR request to load data in arraybuffer format.

Name	Type	Description
`url`	`string`	The URL to request the data from
`responseType`	`"arraybuffer"`	Format for the response
`onProgress?`	`ProgressCallback`	Callback to receive byte progress

▸ loadXhr(url, responseType, onProgress?): Promise<LoadSuccessBlob | LoadError>

Perform an XHR request to load data in blob format.

Name	Type	Description
`url`	`string`	The URL to request the data from
`responseType`	`"blob"`	Format for the response
`onProgress?`	`ProgressCallback`	Callback to receive byte progress