Add remove and download from amazon functionality

icapps · May 10, 2019 · fda1597 · fda1597
1 parent 589c012
commit fda1597
Show file tree

Hide file tree

Showing 5 changed files with 2,830 additions and 1,968 deletions.
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ const options = {
   destination: 'uploads',
   fileSize: 12000,
   allowedFileTypes: ['image/png', 'image/jpg'],
-  
+
   // Optional Joi schema validation for other body data
   validator: {
     schema: joiSchema,
@@ -127,7 +127,27 @@ const options = {
   key: 's3KeyName',
   encryption: 'AE-256', // Optional encryption (this will enable server encryption on S3)
 };
-const { location, bucket, key } = amazon.uploadFile(client, options);
+const { location, bucket, key } = await amazon.uploadFile(client, options);
+```
+
+### getFile(client, bucket, key)
+
+Retrieve a file from S3
+
+```javascript
+import { amazon } from '@icapps/tree-house-storage'
+
+const { Body } = await amazon.getFile(client, bucket, key);
+```
+
+### removeFile(client, bucket, key)
+
+Remove a file from S3
+
+```javascript
+import { amazon } from '@icapps/tree-house-storage'
+
+await amazon.removeFile(client, bucket, key);
 ```
 
 ### getPresignedUrl(client, options)
@@ -142,7 +162,7 @@ const options = {
   key: 's3KeyName',
   expires: 1600, // Optional expiration time
 };
-const { location, bucket, key } = amazon.getPresignedUrl(client, options);
+const { location, bucket, key } = await amazon.getPresignedUrl(client, options);
 ```
 
 ## Tests