@types/formidable

What is @types/formidable?

@types/formidable provides TypeScript type definitions for the formidable package, which is used for parsing form data, especially file uploads.

What are @types/formidable's main functionalities?

Parsing Form Data

This feature allows you to parse incoming form data, including file uploads. The `form.parse` method takes a request object and a callback function that handles the parsed fields and files.

const formidable = require('formidable');
const form = new formidable.IncomingForm();
form.parse(req, (err, fields, files) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('Fields:', fields);
  console.log('Files:', files);
});

Handling File Uploads

This feature allows you to handle file uploads by specifying an upload directory. The `uploadDir` property sets the directory where uploaded files will be stored.

const formidable = require('formidable');
const form = new formidable.IncomingForm();
form.uploadDir = '/path/to/upload/directory';
form.parse(req, (err, fields, files) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('Uploaded files:', files);
});

Customizing File Uploads

This feature allows you to customize the file upload process. The `fileBegin` event is triggered when a file upload starts, allowing you to set a custom file path.

const formidable = require('formidable');
const form = new formidable.IncomingForm();
form.on('fileBegin', (name, file) => {
  file.path = '/custom/path/' + file.name;
});
form.parse(req, (err, fields, files) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('Custom file path:', files);
});

Other packages similar to @types/formidable

multer

Multer is a middleware for handling `multipart/form-data`, which is primarily used for uploading files. It is similar to formidable but is designed to work specifically with Express.js. Multer is more modern and integrates seamlessly with Express, making it a popular choice for file uploads in Express applications.

busboy

Busboy is a fast and low-level library for parsing `multipart/form-data` used for file uploads. It is similar to formidable but offers more control and is more performant. Busboy is often used in scenarios where performance is critical and fine-grained control over file uploads is required.

multiparty

Multiparty is another library for parsing `multipart/form-data`, similar to formidable. It is known for its simplicity and ease of use. Multiparty is a good alternative if you need a straightforward solution for handling file uploads without the additional features provided by formidable.

README

Installation

npm install --save @types/formidable

Summary

This package contains type definitions for formidable (https://github.com/node-formidable/formidable).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/formidable/v1.

Additional Details

• Last updated: Thu, 14 Sep 2023 15:26:41 GMT
• Dependencies: @types/node
• Global values: none

Credits

These definitions were written by Wim Looman, and Martin Badin.