Skip to content

Commit c2b58f8

Browse files
committed
new Update
1 parent cbd9eba commit c2b58f8

File tree

4 files changed

+54
-4
lines changed

4 files changed

+54
-4
lines changed

packages/next-s3-uploader/CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# next-s3-uploader
22

3+
## 0.1.3
4+
5+
### Patch Changes
6+
7+
- Better Docs with reset option
8+
39
## 0.1.2
410

511
### Patch Changes
Loading

packages/next-s3-uploader/README.md

Lines changed: 47 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,47 @@
1-
# Next S3 Uploader
1+
# Next.js S3 Uploader
2+
3+
![Next.js S3 File Uploader](Next.js-S3-Uploader.png)
4+
5+
![npm](https://img.shields.io/npm/dm/next-s3-uploader)
6+
![npm](https://img.shields.io/npm/v/next-s3-uploader)
7+
![GitHub](https://img.shields.io/github/license/abhay-ramesh/next-s3-uploader)
8+
![example workflow](https://github.com/abhay-ramesh/next-s3-uploader/actions/workflows/release.yml/badge.svg)
9+
<!-- ![GitHub last commit](https://img.shields.io/github/last-commit/abhay-ramesh/next-s3-uploader) -->
10+
<!-- ![GitHub stars](https://img.shields.io/github/stars/abhay-ramesh/next-s3-uploader) -->
211

312
**Next S3 Uploader** is a utility package for handling file uploads to Amazon S3 or compatible services like MinIO in a Next.js application. It simplifies the process of integrating secure and scalable cloud storage for your Next.js projects.
413

14+
## Table of Contents
15+
16+
- [Next.js S3 Uploader](#nextjs-s3-uploader)
17+
- [Table of Contents](#table-of-contents)
18+
- [Features](#features)
19+
- [Installation](#installation)
20+
- [Usage](#usage)
21+
- [Frontend (Nextjs App Directory)](#frontend-nextjs-app-directory)
22+
- [API Route](#api-route)
23+
- [API](#api)
24+
- [`useS3FileUpload` Hook Options](#uses3fileupload-hook-options)
25+
- [`uploadFiles` Function Options](#uploadfiles-function-options)
26+
- [`uploadedFiles` Array Properties](#uploadedfiles-array-properties)
27+
- [`reset` Function](#reset-function)
28+
- [`createS3Client(config)`](#creates3clientconfig)
29+
- [`generatePresignedUrls(s3Client, keys, bucket, prefix?)`](#generatepresignedurlss3client-keys-bucket-prefix)
30+
- [Example Usage](#example-usage)
31+
- [Allow Multiple File Uploads](#allow-multiple-file-uploads)
32+
- [Limit Number of Uploaded Files](#limit-number-of-uploaded-files)
33+
- [Set Maximum File Size](#set-maximum-file-size)
34+
- [Custom Keys](#custom-keys)
35+
- [Custom API Endpoint](#custom-api-endpoint)
36+
- [AWS S3 Client](#aws-s3-client)
37+
- [Non-AWS S3 Compatible Client (MinIO/Non-AWS)](#non-aws-s3-compatible-client-minionon-aws)
38+
- [Basic File Upload](#basic-file-upload)
39+
- [Authenticated Upload](#authenticated-upload)
40+
- [Project-Specific Upload](#project-specific-upload)
41+
- [Organization/Company File Storage](#organizationcompany-file-storage)
42+
- [Contributing](#contributing)
43+
- [License](#license)
44+
545
## Features
646

747
- **Easy Integration**: Seamlessly integrate file upload functionality into your Next.js applications.
@@ -148,6 +188,8 @@ The `uploadFiles` function initiates file uploads to Amazon S3 and supports cust
148188

149189
- `endpoint` (optional): API endpoint for generating pre-signed URLs. Default is `/api/s3upload`.
150190

191+
- `requestOptions` (optional): Additional options to pass to the `fetch` function.
192+
151193
#### `uploadedFiles` Array Properties
152194

153195
The `uploadedFiles` array contains information about each uploaded file:
@@ -162,9 +204,11 @@ The `uploadedFiles` array contains information about each uploaded file:
162204

163205
- `timeLeft` (string): Estimate of remaining time for the upload to complete.
164206

165-
---
207+
#### `reset` Function
208+
209+
The `reset` function resets the `uploadedFiles` array to its initial state. (Sets `uploadedFiles` to an empty array.)
166210

167-
Sure, here's the updated description for the `createS3Client` function in the API reference:
211+
---
168212

169213
### `createS3Client(config)`
170214

packages/next-s3-uploader/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "next-s3-uploader",
3-
"version": "0.1.2",
3+
"version": "0.1.3",
44
"author": "Abhay Ramesh",
55
"license": "MIT",
66
"description": "A simple way to upload files to S3 from a Next.js app directory (aws s3, minio, or any s3 compatible service)",

0 commit comments

Comments
 (0)