Class S3MultipartUpload

A handle to a multipart upload of a specific object.

Created via S3Client#createMultipartUpload (starts a new upload) or S3Client#multipartUpload (re-attaches to an existing upload).

Example

const upload = await client.createMultipartUpload("large-file.bin");
try {
  const parts = [
    await upload.uploadPart(1, chunk1),
    await upload.uploadPart(2, chunk2),
  ];
  await upload.complete(parts);
} catch (err) {
  await upload.abort();
  throw err;
}

Index

Accessors

bucket key uploadId

Methods

[custom] abort complete parts partsIterating toString uploadPart

Accessors

bucket

get bucket(): string
Name of the bucket this multipart upload was created in.

Returns string
- Defined in src/S3MultipartUpload.ts:67

key

get key(): string
Key of the object this multipart upload was initiated for.

Returns string
- Defined in src/S3MultipartUpload.ts:57

uploadId

get uploadId(): string
Upload ID identifying this multipart upload.

Returns string
- Defined in src/S3MultipartUpload.ts:62

Methods

[custom]

"[custom]"(_depth?: number, options?: InspectOptions): string
Parameters
- Optional_depth: number
- options: InspectOptions = {}
Returns string
- Defined in src/S3MultipartUpload.ts:308

abort

abort(options?: AbortMultipartUploadOptions): Promise<void>
Parameters
- options: AbortMultipartUploadOptions = {}
Returns Promise<void>

Remarks
Uses AbortMultipartUpload.
- Defined in src/S3MultipartUpload.ts:279

complete

complete(
parts: readonly MultipartUploadPart[],
options?: CompleteMultipartUploadOptions,
): Promise<CompleteMultipartUploadResult>
Parameters
- parts: readonly MultipartUploadPart[]
- options: CompleteMultipartUploadOptions = {}
Returns Promise<CompleteMultipartUploadResult>

Remarks
Uses CompleteMultipartUpload.
- Defined in src/S3MultipartUpload.ts:218

parts

parts(options?: ListPartsOptions): Promise<ListPartsResult>
Parameters
- options: ListPartsOptions = {}
Returns Promise<ListPartsResult>

Remarks
Uses ListParts.

Throws
If options.maxParts is not a number.

Throws
If options.maxParts is <= 0.

Throws
If options.partNumberMarker is not a string.
- Defined in src/S3MultipartUpload.ts:127

partsIterating

partsIterating(options?: ListPartsIteratingOptions): AsyncGenerator<ListedPart>
Uses ListParts to iterate over all parts. Pagination and continuation is handled internally.
Parameters
- options: ListPartsIteratingOptions = {}
Returns AsyncGenerator<ListedPart>
- Defined in src/S3MultipartUpload.ts:195

toString

toString(): string
Returns string
- Defined in src/S3MultipartUpload.ts:304

uploadPart

uploadPart(
    partNumber: number,
    data:
        | string
        | Uint8Array<ArrayBufferLike>
        | Readable
        | Buffer<ArrayBufferLike>,
    options?: UploadPartOptions,
): Promise<UploadPartResult>
Parameters
- partNumber: number
- data: string | Uint8Array<ArrayBufferLike> | Readable | Buffer<ArrayBufferLike>
- options: UploadPartOptions = {}
Returns Promise<UploadPartResult>

Remarks
Uses UploadPart.

Throws
If partNumber is not a number which is >= 1.
- Defined in src/S3MultipartUpload.ts:75

Class S3MultipartUpload

Example

Index

Accessors

Methods

Accessors

bucket

Returns string

key

Returns string

uploadId

Returns string

Methods

[custom]

Parameters

Returns string

abort

Parameters

Returns Promise<void>

Remarks

complete

Parameters

Returns Promise<CompleteMultipartUploadResult>

Remarks

parts

Parameters

Returns Promise<ListPartsResult>

Remarks

Throws

Throws

Throws

partsIterating

Parameters

Returns AsyncGenerator<ListedPart>

toString

Returns string

uploadPart

Parameters

Returns Promise<UploadPartResult>

Remarks

Throws

Settings

On This Page