Skip to main content

Class: ObjectsService

Constructors

new ObjectsService()

new ObjectsService(client, prefixService): ObjectsService

Parameters

client: S3Client

prefixService: PrefixService

Returns

ObjectsService

Defined in

services/objects.service.ts:37

Methods

copyObject()

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

Parameters

sourceBucket: string

sourceKey: string

destinationBucket: string

destinationKey: string

options?

options.destinationOptions?: CopyObjectOptions

options.sourceOptions?: DisableAutoPrefix & PrefixContext

Returns

Promise<CopyObjectOutput>

Defined in

services/objects.service.ts:119


deleteObject()

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

Parameters

bucket: string

remote: string

options?: DeleteObjectOptions

Returns

Promise<DeleteObjectOutput>

Defined in

services/objects.service.ts:71


deleteObjects()

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

Parameters

bucket: string

remotes: string[]

options?: DeleteObjectsOptions

Returns

Promise<DeleteObjectsOutput>

Defined in

services/objects.service.ts:87


getObject()

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

Parameters

bucket: string

remote: string

options?: GetObjectOptions

Returns

Promise<GetObjectOutput>

Defined in

services/objects.service.ts:107


listObjects()

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

Parameters

bucket: string

options?: ListObjectsOptions

Returns

Promise<ListObjectsOutput>

Defined in

services/objects.service.ts:156


listObjectsV2()

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

Parameters

bucket: string

options?: ListObjectsV2Options

Returns

Promise<ListObjectsV2Output>

Defined in

services/objects.service.ts:165


putObject()

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

Parameters

bucket: string

body: Buffer

remote: string

options?: PutObjectOptions

Returns

Promise<PutObjectOutput>

Defined in

services/objects.service.ts:42


putObjectFromPath()

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

Parameters

bucket: string

path: string

remote: string

options?: PutObjectOptions

Returns

Promise<PutObjectOutput>

Defined in

services/objects.service.ts:60