S3Uploader Documentation

The S3Uploader class is a Node.js module designed to simplify the process of uploading files to Amazon S3. It utilizes the AWS SDK, crypto, fs, and multer libraries to provide a convenient interface for handling file uploads to an S3 bucket.

Installation

To use the S3Uploader class, you need to install the required dependencies. Use the following command:

1npm install aws-sdk crypto fs multer
2
3
4
5**License**
6This project is licensed under the MIT License - see the LICENSE file for details.
7
8
9const { S3Uploader } = require('s3-upload-file');
10
11// Initialize S3Uploader with your AWS credentials and S3 bucket information
12const s3Uploader = new S3Uploader('*your-access-key-id*', '*your-secret-access-key*', '*your-region*', '*your-bucket-name*');
13
14// Middleware for handling file uploads (use with Express or similar frameworks)
15const uploadMiddleware = s3Uploader.uploadMiddleware();
16
17// Example route for handling file uploads
18app.post('/upload', uploadMiddleware, (req, res) => {
19  s3Uploader.uploadFile(req)
20    .then((url) => {
21      res.json({ success: true, url });
22    })
23    .catch((error) => {
24      console.error('File upload error:', error);
25      res.status(500).json({ success: false, error: 'File upload failed' });
26    });
27});
28
29API Reference
30
31
32S3Uploader
33
34new S3Uploader(accessKeyId, secretAccessKey, region, bucketName)
35
36Creates an instance of the S3Uploader class.
37
38accessKeyId: AWS access key ID.
39`secretAccessKey**: AWS secret access key.
40`region**: AWS region.
41`bucketName**: The name of the S3 bucket.
42
43uploadMiddleware()
44
45
46uploadMiddleware(): Function
47
48
49
50uploadFile(req: Object): Promise<string>
51
52
53
54Uploads a file to the specified S3 bucket.
55
56req: The request object containing the file information.
57Returns a Promise that resolves with the S3 file URL.
58
59
60Examples
61For more examples and detailed usage, check out the examples directory.