MultipartUploadPoolOptions

Defined in: src/providers/web/multipartUploadPool.ts:139

Options for runMultipartUploadPool.

Type Parameters

Type Parameter
TResult

Properties

Property	Type	Description	Defined in
firstPartNumber?	number	Part number of the first part the reader will produce (the reader’s startPartNumber). Anchors contiguous-prefix commit tracking. Defaults to 1.	src/providers/web/multipartUploadPool.ts:152
partConcurrency	number	Number of parts uploaded concurrently. 1 reproduces sequential behavior. Memory bound: (partConcurrency + 1) x partSizeBytes.	src/providers/web/multipartUploadPool.ts:146
reader	MultipartPartReader	Sequential part source (see createSequentialPartReader).	src/providers/web/multipartUploadPool.ts:141
throwIfAborted?	() => void	Abort check invoked before each part upload.	src/providers/web/multipartUploadPool.ts:164

Methods

onCommitted()?

optional onCommitted(part: MultipartUploadedPart<TResult>, committedBytes: number): void | Promise<void>;

Defined in: src/providers/web/multipartUploadPool.ts:162

Observes the contiguous prefix of completed parts advancing. Called once per part in strict part-number order; committedBytes is the byte end of the contiguous prefix. Parts completed beyond a still-uploading gap are not reported until the gap closes, so the value is monotonic and safe to checkpoint. Awaited before further notifications fire.

Parameters

Parameter	Type
part	MultipartUploadedPart<TResult>
committedBytes	number

Returns

void | Promise<void>

---

uploadPart()

uploadPart(part: MultipartPart): Promise<TResult>;

Defined in: src/providers/web/multipartUploadPool.ts:154

Uploads one part and returns its provider token (ETag, block id, …).

Parameters

Parameter	Type
part	MultipartPart

Returns

Promise<TResult>