Class S3File

Index

Methods

arrayBuffer blob bytes delete exists json slice stat stream text toString write

Methods

arrayBuffer

arrayBuffer(): Promise<ArrayBuffer>
Returns Promise<ArrayBuffer>
- Defined in src/S3File.ts:215

blob

blob(): Promise<Blob>
Returns Promise<Blob>
- Defined in src/S3File.ts:221

bytes

bytes(): Promise<Uint8Array<ArrayBufferLike>>
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in src/S3File.ts:210

delete

delete(options?: Partial<S3FileDeleteOptions>): Promise<void>
Delete a file from the bucket.
Parameters
- Optionaloptions: Partial<S3FileDeleteOptions> = {}
Returns Promise<void>
Remarks
- Uses DeleteObject. - versionId not supported.
Example
```
// Simple delete
await client.delete("old-file.txt");

// With error handling
try {
  await client.delete("file.dat");
  console.log("File deleted");
} catch (err) {
  console.error("Delete failed:", err);
}
```
- Defined in src/S3File.ts:177

exists

exists(options?: Partial<S3FileExistsOptions>): Promise<boolean>
Check if a file exists in the bucket. Uses HEAD request to check existence.
Parameters
- options: Partial<S3FileExistsOptions> = {}
Returns Promise<boolean>
Remarks
Uses HeadObject.
- Defined in src/S3File.ts:120

json

json(): Promise<unknown>
Returns Promise<unknown>
- Defined in src/S3File.ts:205

slice

slice(start?: number, end?: number, contentType?: string): S3File
Parameters
- Optionalstart: number
- Optionalend: number
- OptionalcontentType: string
Returns S3File
- Defined in src/S3File.ts:57

stat

stat(options?: Partial<S3StatOptions>): Promise<S3Stat>
Get the stat of a file in the bucket. Uses HEAD request to check existence.
Parameters
- options: Partial<S3StatOptions> = {}
Returns Promise<S3Stat>
Remarks
Uses HeadObject.

Throws
If the file does not exist or the server has some other issues.

Throws
If the server returns an invalid response.
- Defined in src/S3File.ts:78

stream

stream(): ReadableStream<Uint8Array<ArrayBufferLike>>
Returns ReadableStream<Uint8Array<ArrayBufferLike>>
- Defined in src/S3File.ts:226

text

text(): Promise<string>
Returns Promise<string>
- Defined in src/S3File.ts:218

toString

toString(): string
Returns string
- Defined in src/S3File.ts:201

write

write(data: ByteSource): Promise<void>
Parameters
- data: ByteSource
Returns Promise<void>
- Defined in src/S3File.ts:283

Class S3File

Index

Methods

Methods

arrayBuffer

Returns Promise<ArrayBuffer>

blob

Returns Promise<Blob>

bytes

Returns Promise<Uint8Array<ArrayBufferLike>>

delete

Parameters

Returns Promise<void>

Remarks

Example

exists

Parameters

Returns Promise<boolean>

Remarks

json

Returns Promise<unknown>

slice

Parameters

Returns S3File

stat

Parameters

Returns Promise<S3Stat>

Remarks

Throws

Throws

stream

Returns ReadableStream<Uint8Array<ArrayBufferLike>>

text

Returns Promise<string>

toString

Returns string

write

Parameters

Returns Promise<void>

Settings

On This Page