Class Download

A Download is the result of calling parcel.downloadDocument or document.download().

The downloaded data can be read using async iterable for await (const chunk of download), or by calling await download.pipeTo(sink).

The download may be aborted by calling download.destroy(), as with any Readable.

Hierarchy

Download

Implements

AsyncIterable<Uint8Array>

Index

Constructors

constructor

Properties

Accessors

aborted

Methods

Constructors

constructor

new Download(client: KyInstance, endpoint: string): Download

- Defined in src/http.ts:287
Parameters
- client: KyInstance
- endpoint: string
Returns Download

Properties

Private Readonly abortController

abortController: AbortController

Private Optional res

res: Promise<Response>

Accessors

aborted

get aborted(): boolean

- Defined in src/http.ts:314
Returns boolean

Methods

[asyncIterator]

[asyncIterator](): AsyncIterator<Uint8Array, any, undefined>

Implementation of AsyncIterable.__@asyncIterator@21774
- Defined in src/http.ts:291
Returns AsyncIterator<Uint8Array, any, undefined>

abort

abort(): void

- Defined in src/http.ts:310
Returns void

Private makeRequest

makeRequest(): Promise<Response>

- Defined in src/http.ts:350
Lazily make the request. Helps avoid unhandled promise rejections when the request fails before a pipe or iterator handler is attached.

Returns Promise<Response>

pipeTo

pipeTo(sink: Writable | WriteStream | WritableStream<any>): Promise<void>

- Defined in src/http.ts:322
Convenience method for piping to a sink and waiting for writing to finish. This method must not be used alongside getStream or AsyncIterable.

Parameters
- sink: Writable | WriteStream | WritableStream<any>
Returns Promise<void>

Generated using TypeDoc