Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
83 lines
1.7 KiB
Plaintext
83 lines
1.7 KiB
Plaintext
# object-to-formdata
|
|
|
|
> Convenient JavaScript function that serializes Objects to FormData instances.
|
|
|
|
[](https://www.npmjs.com/package/object-to-formdata)
|
|
[](https://www.npmjs.com/package/object-to-formdata)
|
|
|
|
## Install
|
|
|
|
```sh
|
|
npm install object-to-formdata
|
|
```
|
|
|
|
## Usage
|
|
|
|
**NOTE: STARTING WITH VERSION 4.0.0, THE NAMED EXPORT HAS CHANGED!**
|
|
|
|
**NOTE: STARTING WITH VERSION 3.0.0, THERE IS NO DEFAULT EXPORT!**
|
|
|
|
```js
|
|
import { serialize } from 'object-to-formdata';
|
|
|
|
const object = {
|
|
/**
|
|
* key-value mapping
|
|
* values can be primitives or objects
|
|
*/
|
|
};
|
|
|
|
const options = {
|
|
/**
|
|
* include array indices in FormData keys
|
|
* defaults to false
|
|
*/
|
|
indices: false,
|
|
|
|
/**
|
|
* treat null values like undefined values and ignore them
|
|
* defaults to false
|
|
*/
|
|
nullsAsUndefineds: false,
|
|
|
|
/**
|
|
* convert true or false to 1 or 0 respectively
|
|
* defaults to false
|
|
*/
|
|
booleansAsIntegers: false,
|
|
|
|
/**
|
|
* store arrays even if they're empty
|
|
* defaults to false
|
|
*/
|
|
allowEmptyArrays: false,
|
|
|
|
/**
|
|
* don't include array notation in FormData keys for any Attributes excepted Files in arrays
|
|
* defaults to false
|
|
*/
|
|
noAttributesWithArrayNotation: false,
|
|
|
|
/**
|
|
* don't include array notation in FormData keys for Files in arrays
|
|
* defaults to false
|
|
*/
|
|
noFilesWithArrayNotation: false,
|
|
|
|
/**
|
|
* use dots instead of brackets for object notation in FormData keys
|
|
* defaults to false
|
|
*/
|
|
dotsForObjectNotation: false,
|
|
};
|
|
|
|
const formData = serialize(
|
|
object,
|
|
options, // optional
|
|
existingFormData, // optional
|
|
keyPrefix, // optional
|
|
);
|
|
|
|
console.log(formData);
|
|
```
|