Treehouse storage
NodeJS storage utility module written in Typescript
Installation
Install via npm
npm install tree-house-storage
or via yarn
yarn add tree-house-storage
Usage
Middleware functions
multipartUpload(options)
Express middleware function to upload a local file using multer.
const options = destination: 'uploads' fileSize: 12000 allowedFileTypes: 'image/png' 'image/jpg' // Optional Joi schema validation for other body data validator: schema: joiSchema options: joiOptions ;; app;
Local filesystem
Local file functions enabling the use of Promises for fs
methods.
createFile(path, name, content)
Creates a new local file. This will also create a folder when it does not exist already. (Synchronous)
local;
readFile(path)
Read an existing local file via filepath. (Asynchronous)
await local;
deleteFile(path)
Delete an existing local file via filepath (Synchronous)
await local;
Amazon
Amazon S3 libs
createClient(clientOptions)
Create an S3 client
const options = region: 'eu-west-1' accessKeyId: 'myAccesKey' secretAccessKey: 'mySecret';const client = amazon;
uploadFile(client, options)
Upload a file to S3
const options = path: 'localPath/localFile.png' name: uuid contentType: 'image/png' bucket: 's3bucketName' key: 's3KeyName' encryption: 'AE-256' // Optional encryption (this will enable server encryption on S3);const location bucket key = amazon;
getPresignedUrl(client, options)
Gets a pre-signed url for an S3 resource
const options = bucket: 's3bucketName' key: 's3KeyName' expires: 1600 // Optional expiration time;const location bucket key = amazon;
Tests
All tests are written using Jest. Check out the documentation here for more information.
You can run npm run test
to run all tests
You can run npm run test:coverage
to run all tests with coverage report
Bugs
When you find issues, please report them:
Be sure to include all of the output from the npm command that didn't work as expected. The npm-debug.log file is also helpful to provide.
Authors
See the list of contributors who participated in this project.
License
This project is licensed under the ISC License - see the LICENSE.md file for details