https://github.com/yesarib/node-streams
This project demonstrates the use of Node.js streams to handle file uploads and processing in an efficient and memory-optimized way.
https://github.com/yesarib/node-streams
filehandling nodejs nodejsstreamapi streams
Last synced: 11 months ago
JSON representation
This project demonstrates the use of Node.js streams to handle file uploads and processing in an efficient and memory-optimized way.
- Host: GitHub
- URL: https://github.com/yesarib/node-streams
- Owner: Yesarib
- Created: 2024-11-03T10:24:14.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-03T15:44:18.000Z (about 1 year ago)
- Last Synced: 2025-01-08T07:25:21.532Z (about 1 year ago)
- Topics: filehandling, nodejs, nodejsstreamapi, streams
- Language: TypeScript
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node.js Streams
This project demonstrates the use of Node.js streams to handle file uploads and processing in an efficient and memory-optimized way. By processing files in chunks rather than loading them entirely into memory, streams provide a significant performance boost, especially for large files. Here, we build an API that accepts file uploads and processes them using streams, showcasing how to read, write, and transform data in real-time.
## Installation
1. Clone the repository:
```
git clone https://github.com/Yesarib/node-streams.git
```
2. Install dependencies:
```
npm install
```
3. Start the Server:
```
npm start
```
The server will run on ```http://localhost:5000.```
### Example Endpoints
- /upload: Uploads a file to the server and saves it to the uploads folder using streams for efficient handling.
- /upload/chunk: Processes each chunk of the file using a transform stream, modifying data before saving it. In this example, data is converted to uppercase.
### Benefits of Streams
- Memory Efficiency: Streams handle data in chunks, reducing memory usage.
- Performance Optimization: Operations start as soon as data begins flowing, without waiting for the complete file.
- Real-Time Data Processing: Transformations and modifications can occur on-the-fly.
This project is a foundation for more complex applications involving real-time data handling, such as video/audio streaming, large file transfers, or real-time transformations.