Class HTTPToolkit

Hierarchy (View Summary)

DataToolkit
- HTTPToolkit

Constructors

constructor

new HTTPToolkit(runtime?: HTTPRuntime): HTTPToolkit
Parameters
- runtime: HTTPRuntime = defaultHTTPRuntime
Returns HTTPToolkit
Overrides DataToolkit.constructor
- Defined in HTTPRequest.ts:125

Properties

rawRequest

rawRequest: (__namedParameters: Request) => RequestResult = ...

runtime

runtime: HTTPRuntime = defaultHTTPRuntime

Methods

emitStreamProgress

emitStreamProgress(
 stream: ReadableStream<Uint8Array<ArrayBufferLike>>,
 total: number,
 eventTarget: ProgressEventTarget,
): AsyncGenerator<Uint8Array<ArrayBufferLike>>
Parameters
- stream: ReadableStream<Uint8Array<ArrayBufferLike>>
- total: number
- eventTarget: ProgressEventTarget
Returns AsyncGenerator<Uint8Array<ArrayBufferLike>>
Inherited from DataToolkit.emitStreamProgress
- Defined in utility.ts:288

encodeBase64

encodeBase64(raw: string | Blob): Promise<string>
Parameters
- raw: string | Blob
 Binary data
Returns Promise<string>
Base64 encoded data
Inherited from DataToolkit.encodeBase64
- Defined in utility.ts:335

makeFormData

makeFormData(data: Record<string, any>): FormData
Parameters
- data: Record<string, any>
Returns FormData
Inherited from DataToolkit.makeFormData
- Defined in utility.ts:101

makeStream

makeStream(...chunks: BlobPart[]): ReadableStream<Uint8Array<ArrayBufferLike>>
Parameters
- ...chunks: BlobPart[]
Returns ReadableStream<Uint8Array<ArrayBufferLike>>
Inherited from DataToolkit.makeStream
- Defined in utility.ts:262

parseDocument

parseDocument(text: string, contentType?: string): Promise<Document>
Parameters
- text: string
- contentType: string = ''
Returns Promise<Document>
Inherited from DataToolkit.parseDocument
- Defined in utility.ts:90

parseFetchBody

parseFetchBody(
 stream: ReadableStream<Uint8Array<ArrayBufferLike>>,
 contentType: string,
 responseType: XMLHttpRequestResponseType,
): Promise
Type Parameters
- B
Parameters
- stream: ReadableStream<Uint8Array<ArrayBufferLike>>
- contentType: string
- responseType: XMLHttpRequestResponseType
Returns Promise
- Defined in HTTPRequest.ts:302

parseResponse

parseResponse(
 __namedParameters: Response,
 responseType: XMLHttpRequestResponseType,
 downloadProgress: ProgressEventTarget,
): Promise<Response>
Type Parameters
- B
Parameters
- __namedParameters: Response
- responseType: XMLHttpRequestResponseType
- downloadProgress: ProgressEventTarget
Returns Promise<Response>
- Defined in HTTPRequest.ts:273

polyfillProgressEvent

polyfillProgressEvent(): | (
new (type: string, eventInitDict?: ProgressEventInit) => ProgressEvent
)
| typeof ProgressEvent
Returns
    | (
        new (type: string, eventInitDict?: ProgressEventInit) => ProgressEvent
    )
    | typeof ProgressEvent
Inherited from DataToolkit.polyfillProgressEvent
- Defined in utility.ts:63

readAs

readAs(
 file: Blob,
 method: "text" | "dataURL" | "binaryString" | "arrayBuffer",
 encoding?: string,
): {
 progress: AsyncGenerator<ProgressData, void, unknown>;
 result: Promise<string | ArrayBuffer>;
}
Parameters
- file: Blob
- method: "text" | "dataURL" | "binaryString" | "arrayBuffer"
- Optionalencoding: string
Returns {
progress: AsyncGenerator<ProgressData, void, unknown>;
result: Promise<string | ArrayBuffer>;
}
Inherited from DataToolkit.readAs
- Defined in utility.ts:313

readBytes

readBytes(
stream: AsyncIterable<Uint8Array<ArrayBufferLike>>,
limit?: number,
): Promise<ArrayBuffer>
Parameters
- stream: AsyncIterable<Uint8Array<ArrayBufferLike>>
- limit: number = Infinity
Returns Promise<ArrayBuffer>
Inherited from DataToolkit.readBytes
- Defined in utility.ts:254

request

request(option: Request): RequestResult
Sends a Request, with automatic HEAD-simulation fallback for servers that do not support the HEAD method.
Type Parameters
- B
Parameters
- option: Request
Returns RequestResult
- Defined in HTTPRequest.ts:414

requestFetch

requestFetch(__namedParameters: Request): RequestResult
Type Parameters
- B
Parameters
- __namedParameters: Request
Returns RequestResult
- Defined in HTTPRequest.ts:205

requestHead

requestHead(__namedParameters: Request): Promise<HeadResponse>
Sends a HEAD request, falling back to simulation when the server does not support HEAD. Tries, in order:
1. A standard HEAD request via fetch().
2. A Range GET to retrieve the first FILE_TYPE_MAGIC_NUMBER_SIZE bytes (magic-number file header).
3. A plain GET that reads the first FILE_TYPE_MAGIC_NUMBER_SIZE bytes then cancels the body stream.
Parameters
- __namedParameters: Request
Returns Promise<HeadResponse>
- Defined in HTTPRequest.ts:338

requestXHR

requestXHR(__namedParameters: Request): RequestResult
Type Parameters
- B
Parameters
- __namedParameters: Request
Returns RequestResult
- Defined in HTTPRequest.ts:129

serialize

serialize<T>(
data: T,
contentType?: string,
): { contentType?: string; data: BodyInit | T }
Type Parameters
- T
Parameters
- data: T
- OptionalcontentType: string
Returns { contentType?: string; data: BodyInit | T }
Inherited from DataToolkit.serialize
- Defined in utility.ts:168

serializeNode

serializeNode(
root: Node,
): { contentType: string; data: string | URLSearchParams | FormData }
Parameters
- root: Node
Returns { contentType: string; data: string | URLSearchParams | FormData }
Inherited from DataToolkit.serializeNode
- Defined in utility.ts:120

streamFromProgress

streamFromProgress<T extends ProgressEventTarget>(
target: T,
): AsyncGenerator<ProgressData, void, unknown>
Type Parameters
- T extends ProgressEventTarget
Parameters
- target: T
Returns AsyncGenerator<ProgressData, void, unknown>
Inherited from DataToolkit.streamFromProgress
- Defined in utility.ts:270

takeBytes

takeBytes(
stream: AsyncIterable<Uint8Array<ArrayBufferLike>>,
limit?: number,
): AsyncGenerator<Uint8Array<ArrayBuffer>, void, unknown>
Parameters
- stream: AsyncIterable<Uint8Array<ArrayBufferLike>>
- limit: number = Infinity
Returns AsyncGenerator<Uint8Array<ArrayBuffer>, void, unknown>
Inherited from DataToolkit.takeBytes
- Defined in utility.ts:237

Class HTTPToolkit

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HTTPToolkit

Properties

rawRequest

runtime

Methods

emitStreamProgress

Parameters

Returns AsyncGenerator<Uint8Array<ArrayBufferLike>>

encodeBase64

Parameters

Returns Promise<string>

makeFormData

Parameters

Returns FormData

makeStream

Parameters

Returns ReadableStream<Uint8Array<ArrayBufferLike>>

parseDocument

Parameters

Returns Promise<Document>

parseFetchBody

Type Parameters

Parameters

Returns Promise<B>

parseResponse

Type Parameters

Parameters

Returns Promise<Response<B>>

polyfillProgressEvent

Returns | ( new (type: string, eventInitDict?: ProgressEventInit) => ProgressEvent ) | typeof ProgressEvent

readAs

Parameters

Returns { progress: AsyncGenerator<ProgressData, void, unknown>; result: Promise<string | ArrayBuffer>;}

readBytes

Parameters

Returns Promise<ArrayBuffer>

request

Type Parameters

Parameters

Returns RequestResult<B>

requestFetch

Type Parameters

Parameters

Returns RequestResult<B>

requestHead

Parameters

Returns Promise<HeadResponse>

requestXHR

Type Parameters

Parameters

Returns RequestResult<B>

serialize

Type Parameters

Parameters

Returns { contentType?: string; data: BodyInit | T }

serializeNode

Parameters

Returns { contentType: string; data: string | URLSearchParams | FormData }

streamFromProgress

Type Parameters

Parameters

Returns AsyncGenerator<ProgressData, void, unknown>

takeBytes

Parameters

Returns AsyncGenerator<Uint8Array<ArrayBuffer>, void, unknown>

Settings

On This Page

Returns
| (
new (type: string, eventInitDict?: ProgressEventInit) => ProgressEvent
)
| typeof ProgressEvent

Returns {
progress: AsyncGenerator<ProgressData, void, unknown>;
result: Promise<string | ArrayBuffer>;
}