Class S3Object

Convenience wrapper for working with a single S3 object reference.

Index

Constructors

Properties

Methods

stat exists read stream bytes text json write writeBytes writeString writeJSON delete presign createAccessURL createAccessUrl

Constructors

constructor

new S3Object(client: S3, ref: ObjectRef): S3Object
Parameters
- client: S3
- ref: ObjectRef
Returns S3Object
- Defined in ../../src/s3.ts:733

Properties

`Readonly`ref

Methods

stat

stat(): Promise<ObjectMeta>
Loads object metadata without downloading the object body.

Returns Promise<ObjectMeta>
- Defined in ../../src/s3.ts:741

exists

exists(): Promise<boolean>
Returns true when the referenced object exists.

Returns Promise<boolean>
- Defined in ../../src/s3.ts:748

read

read(options?: ReadOptions): Promise<ReadResult>
Reads an object and returns its metadata and byte stream.
Parameters
- Optionaloptions: ReadOptions
Returns Promise<ReadResult>
- Defined in ../../src/s3.ts:763

stream

stream(
options?: ReadOptions,
): Promise<AsyncIterable<Uint8Array<ArrayBufferLike>, any, any>>
Reads only the object byte stream.
Parameters
- Optionaloptions: ReadOptions
Returns Promise<AsyncIterable<Uint8Array<ArrayBufferLike>, any, any>>
- Defined in ../../src/s3.ts:770

bytes

bytes(options?: ReadOptions): Promise<Uint8Array<ArrayBufferLike>>
Reads an object into memory as bytes.
Parameters
- Optionaloptions: ReadOptions
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in ../../src/s3.ts:778

text

text(options?: ReadOptions, encoding?: string): Promise<string>
Reads an object into memory as a string.
Parameters
- Optionaloptions: ReadOptions
- encoding: string = "utf-8"
Returns Promise<string>
- Defined in ../../src/s3.ts:786

json

json<T = unknown>(options?: ReadOptions): Promise<T>
Reads and parses an object as JSON.
Type Parameters
- T = unknown
Parameters
- Optionaloptions: ReadOptions
Returns Promise<T>
- Defined in ../../src/s3.ts:793

write

write(body?: S3BodySource, options?: WriteOptions): Promise<ObjectMeta>
Writes an object body to storage.
Parameters
- Optionalbody: S3BodySource
- Optionaloptions: WriteOptions
Returns Promise<ObjectMeta>
- Defined in ../../src/s3.ts:800

writeBytes

writeBytes(
    body:
        | ArrayBuffer
        | Uint8Array<ArrayBufferLike>
        | ArrayBufferView<ArrayBufferLike>,
): Promise<ObjectMeta>
Writes binary content to storage.
Parameters
- body: ArrayBuffer | Uint8Array<ArrayBufferLike> | ArrayBufferView<ArrayBufferLike>
Returns Promise<ObjectMeta>
- Defined in ../../src/s3.ts:807

writeString

writeString(body: string, options?: WriteOptions): Promise<ObjectMeta>
Writes string content to storage.
Parameters
- body: string
- Optionaloptions: WriteOptions
Returns Promise<ObjectMeta>
- Defined in ../../src/s3.ts:814

writeJSON

writeJSON(value: unknown, options?: WriteOptions): Promise<ObjectMeta>
Writes JSON content using application/json by default.
Parameters
- value: unknown
- options: WriteOptions = {}
Returns Promise<ObjectMeta>
- Defined in ../../src/s3.ts:821

delete

delete(): Promise<void>
Deletes the referenced object.

Returns Promise<void>
- Defined in ../../src/s3.ts:831

presign

presign(options?: PresignOptions): Promise<PresignResult>
Generates a presigned URL for the referenced object.
Parameters
- Optionaloptions: PresignOptions
Returns Promise<PresignResult>
- Defined in ../../src/s3.ts:838

createAccessURL

createAccessURL(options?: PresignOptions): Promise<PresignResult>
Creates a host-mediated object-access URL for the referenced object.
Parameters
- Optionaloptions: PresignOptions
Returns Promise<PresignResult>
- Defined in ../../src/s3.ts:845

createAccessUrl

createAccessUrl(options?: PresignOptions): Promise<PresignResult>
Parameters
- Optionaloptions: PresignOptions
Returns Promise<PresignResult>
- Defined in ../../src/s3.ts:849