Class S3File

Index

Methods

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

Methods

arrayBuffer

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

blob

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

bytes

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

copyTo

copyTo(destination: string, options?: CopyObjectOptions): Promise<void>
Copies this file to a new destination.
Parameters
- destination: string
  The destination path.
- options: CopyObjectOptions = {}
  Options for the copy operation.
Returns Promise<void>
- Defined in src/S3File.ts:337

delete

delete(options?: S3FileDeleteOptions): Promise<void>
Delete a file from the bucket.
Parameters
- Optionaloptions: 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:203

exists

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

json

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

slice

slice(start?: number, end?: number): S3File
Creates and returns a new S3File containing a subset of this S3File data.
Parameters
- Optionalstart: number
  The starting index.
- Optionalend: number
  The ending index, exclusive.
Returns S3File
- Defined in src/S3File.ts:63
slice(start?: number, end?: number, contentType?: string): S3File
Creates and returns a new S3File containing a subset of this S3File data.
Parameters
- Optionalstart: number
  The starting index.
- Optionalend: number
  The ending index, exclusive.
- OptionalcontentType: string
  The content-type for the new S3File.
Returns S3File
- Defined in src/S3File.ts:70

stat

stat(options?: S3StatOptions): Promise<S3Stat>
Get the stat of a file in the bucket. Uses HEAD request to check existence.
Parameters
- options: 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:98

stream

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

text

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

toString

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

write

write(data: ByteSource, options?: S3FileWriteOptions): Promise<void>
Parameters
- data: ByteSource
- options: S3FileWriteOptions = {}
  - Optionalsignal?: AbortSignal
    Signal to abort the request.
  - Optionaltype?: string
    Content-Type of the file.
Returns Promise<void>
- Defined in src/S3File.ts:313

Class S3File

Index

Methods

Methods

arrayBuffer

Returns Promise<ArrayBuffer>

blob

Returns Promise<Blob>

bytes

Returns Promise<Uint8Array<ArrayBufferLike>>

copyTo

Parameters

Returns Promise<void>

delete

Parameters

Returns Promise<void>

Remarks

Example

exists

Parameters

Returns Promise<boolean>

Remarks

json

Returns Promise<unknown>

slice

Parameters

Returns S3File

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

Optionalsignal?: AbortSignal

Optionaltype?: string

Returns Promise<void>

Settings

On This Page

`Optional`signal?: AbortSignal

`Optional`type?: string