https://github.com/quicksend/transmit
An alternative to Multer for handling multipart/form-data
https://github.com/quicksend/transmit
file-upload form form-data formdata javascript multipart nodejs typescript
Last synced: 6 months ago
JSON representation
An alternative to Multer for handling multipart/form-data
- Host: GitHub
- URL: https://github.com/quicksend/transmit
- Owner: quicksend
- License: mit
- Created: 2021-03-15T20:26:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-05T01:14:16.000Z (over 1 year ago)
- Last Synced: 2024-12-20T21:12:20.521Z (6 months ago)
- Topics: file-upload, form, form-data, formdata, javascript, multipart, nodejs, typescript
- Language: TypeScript
- Homepage: https://quicksend.github.io/transmit
- Size: 13.2 MB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Transmit
[](https://github.com/quicksend/transmit/actions/workflows/test.yml)
[](https://coveralls.io/github/quicksend/transmit?branch=master)
An alternative to [Multer](https://github.com/expressjs/multer) for handling multipart/form-data
## Why?
[Multer](https://github.com/expressjs/multer) and many other multipart/form-data parsers don't remove uploaded files if the request is aborted. This can be a problem if a user uploads large files and abruptly aborts the request, leaving the partially uploaded (and potentially large) file on your system. Transmit automatically deletes uploaded files if it detects that the request has been aborted.
In addition, Transmit offers a modern API, making use of promises. It also allows you to process and transform incoming files with the use of transformer functions.
## Prerequisites
- [Node.js](https://nodejs.org/en/) >= v12.21.0
## Installation
```bash
$ npm install @quicksend/transmit
$ npm install -D @types/busboy
```
## Usage
By default, all files are saved within the [os.tmpdir()](https://nodejs.org/api/os.html#os_os_tmpdir) folder. You can change this by specifying the directory in the options of [DiskManager](https://quicksend.github.io/transmit/classes/diskmanager.html).
Example with Express using a custom upload destination:
```js
const { DiskManager, Transmit } = require("@quicksend/transmit");
const express = require("express");
const app = express();
// Implement transmit as an express middleware
const upload = (options = {}) => (req, _res, next) => {
return new Transmit(options)
.parseAsync(req)
.then((results) => {
req.fields = results.fields;
req.files = results.files;
next();
})
.catch((error) => next(error));
};
const manager = new DiskManager({
directory: "./uploads"
});
app.post("/upload", upload({ manager }), (req, res) => {
res.send({
fields: req.fields,
files: req.files
});
});
app.listen(3000, () => {
console.log("Listening on port 3000");
});
```
Example with Node.js http module:
```js
const { Transmit } = require("@quicksend/transmit");
const http = require("http");
const server = http.createServer(async (req, res) => {
if (req.url !== "/upload" || req.method.toLowerCase() !== "post") {
res.writeHead(200, { "Content-Type": "application/json" });
res.end(JSON.stringify({ error: "Not Found." }));
return;
}
try {
const results = await new Transmit().parseAsync(req);
res.writeHead(200, { "Content-Type": "application/json" });
res.end(JSON.stringify(results, null, 2));
} catch (error) {
res.writeHead(200, { "Content-Type": "application/json" });
res.end(JSON.stringify(error));
}
});
server.listen(3000, () => {
console.log("Listening on port 3000");
});
```
## NestJS
Transmit can be used with NestJS. Install [nestjs-transmit](https://github.com/quicksend/nestjs-transmit) and follow the instructions on the README.
```bash
$ npm install @quicksend/nestjs-transmit
```
## Transformers
Files can be transformed before it is written to the storage medium. A use case would be resizing uploaded images.
A transformer must be a function that returns a readable stream.
Transformers will run sequentially in the order that they were placed.
Example with [sharp](https://github.com/lovell/sharp) as a resize transformer:
```js
const { DiskManager, Transmit } = require("@quicksend/transmit");
const express = require("express");
const sharp = require("sharp");
const app = express();
// Implement transmit as an express middleware
const upload = (options = {}) => (req, _res, next) => {
return new Transmit(options)
.parseAsync(req)
.then((results) => {
req.fields = results.fields;
req.files = results.files;
next();
})
.catch((error) => next(error));
};
const manager = new DiskManager({
directory: "./uploads"
});
app.post(
"/upload",
upload({
filter: (file) => /^image/.test(file.mimetype), // ignore any files that are not images
manager,
transformers: [() => sharp().resize(128, 128).png()], // resize any incoming image to 128x128 and save it as a png
}),
(req, res) => {
res.send({
fields: req.fields,
files: req.files
});
}
);
app.listen(3000, () => {
console.log("Listening on port 3000");
});
```
## Custom transmit managers
You can create your own transmit managers. All managers must implement the [TransmitManager](https://quicksend.github.io/transmit/interfaces/transmitmanager.html) interface.
```ts
import { IncomingFile, TransmitManager } from "@quicksend/transmit";
export class CustomTransmitManager implements TransmitManager {
handleFile(file: IncomingFile): Promise | NodeJS.WritableStream {}
removeFile(file: IncomingFile): Promise | void {}
}
```
## Documentation
Detailed documentation can be found [here](https://quicksend.github.io/transmit/)
You can build the documentation by running:
```bash
$ npm run docs
```
## Tests
Run tests using the following commands:
```bash
$ npm run test
$ npm run test:watch # run jest in watch mode during development
```
Generate coverage reports by running:
```bash
$ npm run coverage
```