Class S3Provider

AWS S3 storage provider.

Supports native streaming via the facade's getStream method.

Since

0.1.0

Implements

StorageProvider

Index

Constructors

Methods

connect delete disconnect exists get getSignedUrl getStream isHealthy isReady put

Constructors

constructor

new S3Provider(options?: S3ProviderOptions): S3Provider
Parameters
- Optionaloptions: S3ProviderOptions
  S3 connection/injection options
Returns S3Provider
- Defined in packages/storage-plugin/src/providers/s3-provider.ts:287

Methods

connect

connect(): Promise<void>
Establishes the S3 client — injects the SDK lazily or uses injected client.

Returns Promise<void>
Implementation of StorageProvider.connect
- Defined in packages/storage-plugin/src/providers/s3-provider.ts:294

delete

delete(path: string): Promise<boolean>
Deletes an object from S3.
Parameters
- path: string
  Object key
Returns Promise<boolean>
true if deleted
Implementation of StorageProvider.delete
- Defined in packages/storage-plugin/src/providers/s3-provider.ts:383

disconnect

disconnect(): Promise<void>
Disconnect is a no-op for S3 (connectionless HTTP client).

Returns Promise<void>
Implementation of StorageProvider.disconnect
- Defined in packages/storage-plugin/src/providers/s3-provider.ts:310

exists

exists(path: string): Promise<boolean>
Reports whether an object exists in S3.
Parameters
- path: string
  Object key
Returns Promise<boolean>
true if present
Implementation of StorageProvider.exists
- Defined in packages/storage-plugin/src/providers/s3-provider.ts:395

get

get(path: string): Promise<Uint8Array<ArrayBufferLike> | null>
Retrieves an object from S3; null when absent.
Parameters
- path: string
  Object key
Returns Promise<Uint8Array<ArrayBufferLike> | null>
The object bytes, or null
Implementation of StorageProvider.get
- Defined in packages/storage-plugin/src/providers/s3-provider.ts:371

getSignedUrl

getSignedUrl(path: string, options: { expiresIn: number }): Promise<string>
Creates a presigned GET URL for an S3 object.
Parameters
- path: string
  Object key
- options: { expiresIn: number }
  Expiry in seconds
Returns Promise<string>
The presigned URL
Implementation of StorageProvider.getSignedUrl
- Defined in packages/storage-plugin/src/providers/s3-provider.ts:408

getStream

getStream(
path: string,
): Promise<ReadableStream<Uint8Array<ArrayBufferLike>> | null>
Native stream download — zero-copy from S3.
Parameters
- path: string
  Object key
Returns Promise<ReadableStream<Uint8Array<ArrayBufferLike>> | null>
A ReadableStream, or null if absent
Implementation of StorageProvider.getStream
- Defined in packages/storage-plugin/src/providers/s3-provider.ts:420

isHealthy

isHealthy(): Promise<boolean>
M70c: a client.head('')-shaped bucket probe using the existing head member. Resolves true when the bucket answers, false when it does not (or the provider is not connected).

Returns Promise<boolean>
true when the bucket is reachable

Since
0.1.0
Implementation of StorageProvider.isHealthy
- Defined in packages/storage-plugin/src/providers/s3-provider.ts:328

isReady

isReady(): boolean
Reports readiness.

Returns boolean
Implementation of StorageProvider.isReady
- Defined in packages/storage-plugin/src/providers/s3-provider.ts:316

put

put(path: string, data: Uint8Array, options?: PutObjectOptions): Promise<void>
Stores an object in S3, recording any content type and user metadata on the object itself — which is what makes a presigned URL render in a browser instead of downloading as application/octet-stream.
Parameters
- path: string
  Object key
- data: Uint8Array
  Object bytes
- Optionaloptions: PutObjectOptions
  Object attributes to record with the bytes
Returns Promise<void>
Implementation of StorageProvider.put
- Defined in packages/storage-plugin/src/providers/s3-provider.ts:355