Skip to main content

Class: ObjectsService

Defined in: services/objects.service.ts:36

Constructors

Constructor

new ObjectsService(client, prefixService): ObjectsService

Defined in: services/objects.service.ts:37

Parameters

client

S3Client

prefixService

PrefixService

Returns

ObjectsService

Methods

copyObject()

copyObject(sourceBucket, sourceKey, destinationBucket, destinationKey, options?): Promise<CopyObjectOutput>

Defined in: services/objects.service.ts:119

Parameters

sourceBucket

string

sourceKey

string

destinationBucket

string

destinationKey

string

options?
destinationOptions?

CopyObjectOptions

sourceOptions?

DisableAutoPrefix & PrefixContext

Returns

Promise<CopyObjectOutput>


deleteObject()

deleteObject(bucket, remote, options?): Promise<DeleteObjectOutput>

Defined in: services/objects.service.ts:71

Parameters

bucket

string

remote

string

options?

DeleteObjectOptions

Returns

Promise<DeleteObjectOutput>


deleteObjects()

deleteObjects(bucket, remotes, options?): Promise<DeleteObjectsOutput>

Defined in: services/objects.service.ts:87

Parameters

bucket

string

remotes

string[]

options?

DeleteObjectsOptions

Returns

Promise<DeleteObjectsOutput>


getObject()

getObject(bucket, remote, options?): Promise<GetObjectOutput>

Defined in: services/objects.service.ts:107

Parameters

bucket

string

remote

string

options?

GetObjectOptions

Returns

Promise<GetObjectOutput>


listObjects()

listObjects(bucket, options?): Promise<ListObjectsOutput>

Defined in: services/objects.service.ts:156

Parameters

bucket

string

options?

ListObjectsOptions

Returns

Promise<ListObjectsOutput>


listObjectsV2()

listObjectsV2(bucket, options?): Promise<ListObjectsV2Output>

Defined in: services/objects.service.ts:165

Parameters

bucket

string

options?

ListObjectsV2Options

Returns

Promise<ListObjectsV2Output>


putObject()

putObject(bucket, body, remote, options?): Promise<PutObjectOutput>

Defined in: services/objects.service.ts:42

Parameters

bucket

string

body

Buffer

remote

string

options?

PutObjectOptions

Returns

Promise<PutObjectOutput>


putObjectFromPath()

putObjectFromPath(bucket, path, remote, options?): Promise<PutObjectOutput>

Defined in: services/objects.service.ts:60

Parameters

bucket

string

path

string

remote

string

options?

PutObjectOptions

Returns

Promise<PutObjectOutput>