Class: ObjectsService
Constructors​
constructor​
• new ObjectsService(client, prefixService)
Parameters​
| Name | Type |
|---|---|
client | S3Client |
prefixService | PrefixService |
Defined in​
services/objects.service.ts:37
Methods​
copyObject​
â–¸ copyObject(sourceBucket, sourceKey, destinationBucket, destinationKey, options?): Promise<CopyObjectOutput>
Parameters​
| Name | Type |
|---|---|
sourceBucket | string |
sourceKey | string |
destinationBucket | string |
destinationKey | string |
options? | Object |
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​
| Name | Type |
|---|---|
bucket | string |
remote | string |
options? | DeleteObjectOptions |
Returns​
Promise<DeleteObjectOutput>
Defined in​
services/objects.service.ts:71
deleteObjects​
â–¸ deleteObjects(bucket, remotes, options?): Promise<DeleteObjectsOutput>
Parameters​
| Name | Type |
|---|---|
bucket | string |
remotes | string[] |
options? | DeleteObjectsOptions |
Returns​
Promise<DeleteObjectsOutput>
Defined in​
services/objects.service.ts:87
getObject​
â–¸ getObject(bucket, remote, options?): Promise<GetObjectOutput>
Parameters​
| Name | Type |
|---|---|
bucket | string |
remote | string |
options? | GetObjectOptions |
Returns​
Promise<GetObjectOutput>
Defined in​
services/objects.service.ts:107
listObjects​
â–¸ listObjects(bucket, options?): Promise<ListObjectsOutput>
Parameters​
| Name | Type |
|---|---|
bucket | string |
options? | ListObjectsOptions |
Returns​
Promise<ListObjectsOutput>
Defined in​
services/objects.service.ts:156
listObjectsV2​
â–¸ listObjectsV2(bucket, options?): Promise<ListObjectsV2Output>
Parameters​
| Name | Type |
|---|---|
bucket | string |
options? | ListObjectsV2Options |
Returns​
Promise<ListObjectsV2Output>
Defined in​
services/objects.service.ts:165
putObject​
â–¸ putObject(bucket, body, remote, options?): Promise<PutObjectOutput>
Parameters​
| Name | Type |
|---|---|
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​
| Name | Type |
|---|---|
bucket | string |
path | string |
remote | string |
options? | PutObjectOptions |
Returns​
Promise<PutObjectOutput>