Class S3

Client for invoking a host-provided S3 service over the Gestalt transport.

Example

import { S3 } from "@valon-technologies/gestalt";

const s3 = new S3();
await s3.object("example-bucket", "hello.json").writeJSON({ ok: true });

Index

Constructors

constructor

Methods

object objectVersion headObject readObject writeObject deleteObject listObjects copyObject presignObject createObjectAccessURL createObjectAccessUrl createAccessURL createAccessUrl

Constructors

constructor

new S3(name?: string): S3
Parameters
- Optionalname: string
Returns S3
- Defined in ../../src/s3.ts:527

Methods

object

object(bucket: string, key: string): S3Object
Parameters
- bucket: string
- key: string
Returns S3Object
- Defined in ../../src/s3.ts:558

objectVersion

objectVersion(bucket: string, key: string, versionId: string): S3Object
Parameters
- bucket: string
- key: string
- versionId: string
Returns S3Object
- Defined in ../../src/s3.ts:562

headObject

headObject(ref: ObjectRef): Promise<ObjectMeta>
Parameters
- ref: ObjectRef
Returns Promise<ObjectMeta>
- Defined in ../../src/s3.ts:566

readObject

readObject(ref: ObjectRef, options?: ReadOptions): Promise<ReadResult>
Parameters
- ref: ObjectRef
- Optionaloptions: ReadOptions
Returns Promise<ReadResult>
- Defined in ../../src/s3.ts:575

writeObject

writeObject(
    ref: ObjectRef,
    body?: S3BodySource,
    options?: WriteOptions,
): Promise<ObjectMeta>
Parameters
- ref: ObjectRef
- Optionalbody: S3BodySource
- Optionaloptions: WriteOptions
Returns Promise<ObjectMeta>
- Defined in ../../src/s3.ts:591

deleteObject

deleteObject(ref: ObjectRef): Promise<void>
Parameters
- ref: ObjectRef
Returns Promise<void>
- Defined in ../../src/s3.ts:604

listObjects

listObjects(options: ListOptions): Promise<ListPage>
Parameters
- options: ListOptions
Returns Promise<ListPage>
- Defined in ../../src/s3.ts:612

copyObject

copyObject(
    source: ObjectRef,
    destination: ObjectRef,
    options?: CopyOptions,
): Promise<ObjectMeta>
Parameters
- source: ObjectRef
- destination: ObjectRef
- Optionaloptions: CopyOptions
Returns Promise<ObjectMeta>
- Defined in ../../src/s3.ts:631

presignObject

presignObject(ref: ObjectRef, options?: PresignOptions): Promise<PresignResult>
Parameters
- ref: ObjectRef
- Optionaloptions: PresignOptions
Returns Promise<PresignResult>
- Defined in ../../src/s3.ts:647

createObjectAccessURL

createObjectAccessURL(
ref: ObjectRef,
options?: PresignOptions,
): Promise<PresignResult>
Parameters
- ref: ObjectRef
- Optionaloptions: PresignOptions
Returns Promise<PresignResult>
- Defined in ../../src/s3.ts:672

createObjectAccessUrl

createObjectAccessUrl(
ref: ObjectRef,
options?: PresignOptions,
): Promise<PresignResult>
Parameters
- ref: ObjectRef
- Optionaloptions: PresignOptions
Returns Promise<PresignResult>
- Defined in ../../src/s3.ts:707

createAccessURL

createAccessURL(
ref: ObjectRef,
options?: PresignOptions,
): Promise<PresignResult>
Parameters
- ref: ObjectRef
- Optionaloptions: PresignOptions
Returns Promise<PresignResult>
- Defined in ../../src/s3.ts:714

createAccessUrl

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

Class S3

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns S3

Methods

object

Parameters

Returns S3Object

objectVersion

Parameters

Returns S3Object

headObject

Parameters

Returns Promise<ObjectMeta>

readObject

Parameters

Returns Promise<ReadResult>

writeObject

Parameters

Returns Promise<ObjectMeta>

deleteObject

Parameters

Returns Promise<void>

listObjects

Parameters

Returns Promise<ListPage>

copyObject

Parameters

Returns Promise<ObjectMeta>

presignObject

Parameters

Returns Promise<PresignResult>

createObjectAccessURL

Parameters

Returns Promise<PresignResult>

createObjectAccessUrl

Parameters

Returns Promise<PresignResult>

createAccessURL

Parameters

Returns Promise<PresignResult>

createAccessUrl

Parameters

Returns Promise<PresignResult>

Settings

On This Page