Class S3StorageProvider

S3 Storage Provider Implements storage operations using AWS SDK for S3-compatible storage Works with AWS S3, Cloudflare R2, MinIO, and other S3-compatible services

Implements IS3MultipartProvider for multipart upload support needed by TUS

Implements

IS3MultipartProvider

Index

Constructors

constructor

Methods

abortMultipartUpload chunkedUpload completeMultipartUpload createMultipartUpload delete deleteObjects download exists getBucket getPresignedUrl headObject listMultipartUploads listParts upload uploadPart

Constructors

constructor

new S3StorageProvider(config: StorageEntry): S3StorageProvider
Parameters
- config: StorageEntry
Returns S3StorageProvider
- Defined in packages/core/src/storage/providers/s3-storage.provider.ts:46

Methods

abortMultipartUpload

abortMultipartUpload(key: string, uploadId: string): Promise<void>
Abort a multipart upload
Parameters
- key: string
  Object key
- uploadId: string
  Upload ID
Returns Promise<void>
Implementation of IS3MultipartProvider.abortMultipartUpload
- Defined in packages/core/src/storage/providers/s3-storage.provider.ts:359

chunkedUpload

chunkedUpload(
    body: StreamingBlobPayloadInputTypes | undefined,
    path: string,
    options: Omit<UploadOptions, "size"> & { size?: number },
): Promise<
    {
        disk: string;
        fullPath: string;
        mimeType: string;
        path: string;
        size: number;
        uploadedAt: Date;
    },
>
Chunked upload for streaming data without known size Uses @aws-sdk/lib-storage for multipart upload handling

Benefits:
- Handles unknown Content-Length automatically
- Automatic retry on transient failures
- Cleanup of partial uploads on error
- Works with S3-compatible storage (R2, MinIO, RustFS)
Parameters
- body: StreamingBlobPayloadInputTypes | undefined
  Content to upload (stream or buffer)
- path: string
  Full path including disk root
- options: Omit<UploadOptions, "size"> & { size?: number }
  Upload options (mimeType required, size optional)
Returns Promise<
    {
        disk: string;
        fullPath: string;
        mimeType: string;
        path: string;
        size: number;
        uploadedAt: Date;
    },
>
Upload result with metadata
Implementation of IS3MultipartProvider.chunkedUpload
- Defined in packages/core/src/storage/providers/s3-storage.provider.ts:182

completeMultipartUpload

completeMultipartUpload(
    key: string,
    uploadId: string,
    parts: CompletedPart[],
): Promise<CompleteMultipartResult>
Complete a multipart upload
Parameters
- key: string
- uploadId: string
- parts: CompletedPart[]
Returns Promise<CompleteMultipartResult>
Implementation of IS3MultipartProvider.completeMultipartUpload
- Defined in packages/core/src/storage/providers/s3-storage.provider.ts:331

createMultipartUpload

createMultipartUpload(
key: string,
options?: CreateMultipartOptions,
): Promise<CreateMultipartResult>
Create a multipart upload
Parameters
- key: string
- Optionaloptions: CreateMultipartOptions
Returns Promise<CreateMultipartResult>
Implementation of IS3MultipartProvider.createMultipartUpload
- Defined in packages/core/src/storage/providers/s3-storage.provider.ts:281

delete

delete(path: string): Promise<void>
Delete a file from storage
Parameters
- path: string
  Full path to the file
Returns Promise<void>
Implementation of IS3MultipartProvider.delete
- Defined in packages/core/src/storage/providers/s3-storage.provider.ts:111

deleteObjects

deleteObjects(keys: string[]): Promise<DeleteObjectsResult>
Delete multiple objects in a single request
Parameters
- keys: string[]
Returns Promise<DeleteObjectsResult>
Implementation of IS3MultipartProvider.deleteObjects
- Defined in packages/core/src/storage/providers/s3-storage.provider.ts:254

download

download(path: string): Promise<DownloadResult>
Download a file from storage
Parameters
- path: string
  Full path to the file
Returns Promise<DownloadResult>
Download result with stream and metadata
Implementation of IS3MultipartProvider.download
- Defined in packages/core/src/storage/providers/s3-storage.provider.ts:89

exists

exists(path: string): Promise<boolean>
Check if a file exists in storage
Parameters
- path: string
  Full path to the file
Returns Promise<boolean>
True if file exists, false otherwise
Implementation of IS3MultipartProvider.exists
- Defined in packages/core/src/storage/providers/s3-storage.provider.ts:120

getBucket

getBucket(): string
Get the bucket name

Returns string
Implementation of IS3MultipartProvider.getBucket
- Defined in packages/core/src/storage/providers/s3-storage.provider.ts:230

getPresignedUrl

getPresignedUrl(
    path: string,
    method: "GET" | "PUT" | "DELETE" | "HEAD",
    expiresIn: number,
): Promise<
    {
        expiresAt: Date;
        expiresIn: number;
        method: "GET"
        | "PUT"
        | "DELETE"
        | "HEAD";
        url: string;
    },
>
Generate a presigned URL for temporary access
Parameters
- path: string
  Full path to the file
- method: "GET" | "PUT" | "DELETE" | "HEAD"
  HTTP method (GET, PUT, DELETE, HEAD)
- expiresIn: number
  Expiry time in seconds (1-604800)
Returns Promise<
    {
        expiresAt: Date;
        expiresIn: number;
        method: "GET"
        | "PUT"
        | "DELETE"
        | "HEAD";
        url: string;
    },
>
Presigned URL result
Implementation of IS3MultipartProvider.getPresignedUrl
- Defined in packages/core/src/storage/providers/s3-storage.provider.ts:135

headObject

headObject(key: string): Promise<HeadObjectResult | null>
Get object metadata without downloading the body
Parameters
- key: string
Returns Promise<HeadObjectResult | null>
Implementation of IS3MultipartProvider.headObject
- Defined in packages/core/src/storage/providers/s3-storage.provider.ts:237

listMultipartUploads

listMultipartUploads(
keyMarker?: string,
uploadIdMarker?: string,
): Promise<ListMultipartUploadsResult>
List all in-progress multipart uploads
Parameters
- OptionalkeyMarker: string
- OptionaluploadIdMarker: string
Returns Promise<ListMultipartUploadsResult>
Implementation of IS3MultipartProvider.listMultipartUploads
- Defined in packages/core/src/storage/providers/s3-storage.provider.ts:400

listParts

listParts(
    key: string,
    uploadId: string,
    partNumberMarker?: string,
): Promise<ListPartsResult>
List parts of a multipart upload
Parameters
- key: string
- uploadId: string
- OptionalpartNumberMarker: string
Returns Promise<ListPartsResult>
Implementation of IS3MultipartProvider.listParts
- Defined in packages/core/src/storage/providers/s3-storage.provider.ts:372

upload

upload(
    body: StreamingBlobPayloadInputTypes | undefined,
    path: string,
    options: UploadOptions,
): Promise<
    {
        disk: string;
        fullPath: string;
        mimeType: string;
        path: string;
        size: number;
        uploadedAt: Date;
    },
>
Upload content to storage
Parameters
- body: StreamingBlobPayloadInputTypes | undefined
  Content to upload (stream, buffer, or string)
- path: string
  Full path including disk root
- options: UploadOptions
  Upload options including size and mime type
Returns Promise<
    {
        disk: string;
        fullPath: string;
        mimeType: string;
        path: string;
        size: number;
        uploadedAt: Date;
    },
>
Upload result with metadata
Implementation of IS3MultipartProvider.upload
- Defined in packages/core/src/storage/providers/s3-storage.provider.ts:62

uploadPart

uploadPart(
    key: string,
    uploadId: string,
    partNumber: number,
    body: Uint8Array,
): Promise<UploadPartResult>
Upload a part to an existing multipart upload
Parameters
- key: string
- uploadId: string
- partNumber: number
- body: Uint8Array
Returns Promise<UploadPartResult>
Implementation of IS3MultipartProvider.uploadPart
- Defined in packages/core/src/storage/providers/s3-storage.provider.ts:305

Class S3StorageProvider

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns S3StorageProvider

Methods

abortMultipartUpload

Parameters

Returns Promise<void>

chunkedUpload

Parameters

Returns Promise< { disk: string; fullPath: string; mimeType: string; path: string; size: number; uploadedAt: Date; },>

completeMultipartUpload

Parameters

Returns Promise<CompleteMultipartResult>

createMultipartUpload

Parameters

Returns Promise<CreateMultipartResult>

delete

Parameters

Returns Promise<void>

deleteObjects

Parameters

Returns Promise<DeleteObjectsResult>

download

Parameters

Returns Promise<DownloadResult>

exists

Parameters

Returns Promise<boolean>

getBucket

Returns string

getPresignedUrl

Parameters

Returns Promise< { expiresAt: Date; expiresIn: number; method: "GET" | "PUT" | "DELETE" | "HEAD"; url: string; },>

headObject

Parameters

Returns Promise<HeadObjectResult | null>

listMultipartUploads

Parameters

Returns Promise<ListMultipartUploadsResult>

listParts

Parameters

Returns Promise<ListPartsResult>

upload

Parameters

Returns Promise< { disk: string; fullPath: string; mimeType: string; path: string; size: number; uploadedAt: Date; },>

uploadPart

Parameters

Returns Promise<UploadPartResult>

Settings

On This Page

Returns Promise<
{
disk: string;
fullPath: string;
mimeType: string;
path: string;
size: number;
uploadedAt: Date;
},
>

Returns Promise<
{
expiresAt: Date;
expiresIn: number;
method: "GET"
| "PUT"
| "DELETE"
| "HEAD";
url: string;
},
>

Returns Promise<
{
disk: string;
fullPath: string;
mimeType: string;
path: string;
size: number;
uploadedAt: Date;
},
>