@raydeck/s3-manager - v2.3.1

Globals

Index

Variables

• __checkedBuckets
• s3

Functions

• bucketExists
• copyObject
• deleteObject
• getFile
• getObject
• getS3
• makeDownloadUrl
• makeUploadUrl
• objectExists
• putFile
• putObject
• setS3
• withRecords
• withRecordsSerial

Variables

__checkedBuckets

• Const __checkedBuckets: object

Defined in index.ts:5

s3

• Let s3: S3 | undefined

Defined in index.ts:6

Functions

bucketExists

▸ ConstbucketExists(Bucket: string, skipCache: boolean): Promise<boolean>

Defined in index.ts:16

Parameters:

Name | Type | Default value | ------ | ------ | ------ | Bucket | string | - | skipCache | boolean | false |

Returns: Promise<boolean>

copyObject

▸ ConstcopyObject(__namedParameters: { destBucket: undefined | string ; destKey: undefined | string ; sourceBucket: string ; sourceKey: string }): Promise<PromiseResult<CopyObjectOutput, AWSError>>

Defined in index.ts:147

Parameters:

Name | Type | ------ | ------ | __namedParameters | { destBucket: undefined | string ; destKey: undefined | string ; sourceBucket: string ; sourceKey: string } |

Returns: Promise<PromiseResult<CopyObjectOutput, AWSError>>

deleteObject

▸ ConstdeleteObject(Key: any, Bucket: any): Promise<boolean>

Defined in index.ts:83

Parameters:

Name | Type | ------ | ------ | Key | any | Bucket | any |

Returns: Promise<boolean>

getFile

▸ ConstgetFile(Key: string, Bucket: string, targetPath: string): Promise<void>

Defined in index.ts:192

Parameters:

Name | Type | ------ | ------ | Key | string | Bucket | string | targetPath | string |

Returns: Promise<void>

getObject

▸ ConstgetObject(Key: any, Bucket: any): Promise<PromiseResult<GetObjectOutput, AWSError>>

Defined in index.ts:101

Parameters:

Name | Type | ------ | ------ | Key | any | Bucket | any |

Returns: Promise<PromiseResult<GetObjectOutput, AWSError>>

getS3

▸ ConstgetS3(): S3

Defined in index.ts:10

Returns: S3

makeDownloadUrl

▸ ConstmakeDownloadUrl(__namedParameters: { Bucket: string ; Key: string ; ResponseContentType: undefined | string ; detectContentType: boolean = true; ttlMs: number = 60 * 1000 }): Promise<string>

Defined in index.ts:52

Parameters:

Name | Type | ------ | ------ | __namedParameters | { Bucket: string ; Key: string ; ResponseContentType: undefined | string ; detectContentType: boolean = true; ttlMs: number = 60 * 1000 } |

Returns: Promise<string>

makeUploadUrl

▸ ConstmakeUploadUrl(Key: any, Bucket: any): Promise<string>

Defined in index.ts:36

Parameters:

Name | Type | ------ | ------ | Key | any | Bucket | any |

Returns: Promise<string>

objectExists

▸ ConstobjectExists(Key: any, Bucket: any): Promise<boolean>

Defined in index.ts:28

Parameters:

Name | Type | ------ | ------ | Key | any | Bucket | any |

Returns: Promise<boolean>

putFile

▸ ConstputFile(sourcePath: string, Key: string, Bucket: string, options: Partial<PutObjectRequest>): Promise<void>

Defined in index.ts:217

Parameters:

Name | Type | Default value | ------ | ------ | ------ | sourcePath | string | - | Key | string | - | Bucket | string | - | options | Partial<PutObjectRequest> | {} |

Returns: Promise<void>

putObject

▸ ConstputObject(Key: any, Bucket: any, Body: any, options: Partial<PutObjectRequest>): Promise<PromiseResult<PutObjectOutput, AWSError>>

Defined in index.ts:120

Parameters:

Name | Type | Default value | ------ | ------ | ------ | Key | any | - | Bucket | any | - | Body | any | - | options | Partial<PutObjectRequest> | {} |

Returns: Promise<PromiseResult<PutObjectOutput, AWSError>>

setS3

▸ ConstsetS3(newS3: any): void

Defined in index.ts:7

Parameters:

Name | Type | ------ | ------ | newS3 | any |

Returns: void

withRecords

▸ ConstwithRecords(f: any): (Anonymous function)

Defined in index.ts:188

Parameters:

Name | Type | ------ | ------ | f | any |

Returns: (Anonymous function)

withRecordsSerial

▸ ConstwithRecordsSerial(f: any, allowErrors: boolean): (Anonymous function)

Defined in index.ts:178

Parameters:

Name | Type | Default value | ------ | ------ | ------ | f | any | - | allowErrors | boolean | false |

Returns: (Anonymous function)