百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
O

object-to-formdata

> 编程语言
开源

方便的 JavaScript 函数,可将对象序列化为 FormData 实例。

384 stars0 点赞2 次浏览
访问官网GitHub

工具介绍

方便的 JavaScript 函数,可将对象序列化为 FormData 实例。

object-to-formdata

Serialize JavaScript objects into FormData. Supports nested objects, arrays, dates, files, blobs, and configurable key formatting with no runtime dependencies.

Installation

bash
npm install object-to-formdata

Other package managers:

bash
yarn add object-to-formdata
pnpm add object-to-formdata
bun add object-to-formdata

Usage

javascript
import { serialize } from "object-to-formdata";

const formData = serialize({
  name: "Ada",
  active: true,
  tags: ["admin", "editor"],
  profile: {
    age: 36,
  },
});

formData.get("name"); // "Ada"
formData.getAll("tags[]"); // ["admin", "editor"]
formData.get("profile[age]"); // "36"

CommonJS is also supported:

javascript
const { serialize } = require("object-to-formdata");

TypeScript declarations are included with the package.

API

serialize(object?, options?, existingFormData?, keyPrefix?)

Serializes a value and returns a FormData instance.

object

The value to serialize. Objects and arrays are traversed recursively. Dates are converted to ISO strings, while File and Blob values are appended directly. undefined and symbol values are ignored.

Circular structures throw a TypeError.

options

Option Default Description
indices false Include array indices, such as items[0].
nullsAsUndefineds false Ignore null values instead of appending an empty string.
booleansAsIntegers false Serialize booleans as 1 or 0.
allowEmptyArrays false Append an empty string for empty arrays.
noAttributesWithArrayNotation false Omit array notation from non-file array keys.
noFilesWithArrayNotation false Omit array notation from file array keys.
dotsForObjectNotation false Use dots instead of brackets for nested object keys.
javascript
const formData = serialize(
  {
    users: [{ name: "Ada" }, { name: "Grace" }],
  },
  {
    indices: true,
    dotsForObjectNotation: true,
  },
);

formData.get("users[0].name"); // "Ada"

existingFormData

An existing FormData instance to append to. The same instance is returned.

javascript
const formData = new FormData();
formData.append("token", "abc123");

serialize({ name: "Ada" }, undefined, formData);

keyPrefix

An optional prefix for generated keys.

javascript
const formData = serialize({ name: "Ada" }, undefined, undefined, "user");

formData.get("user[name]"); // "Ada"

Runtime requirements

The runtime must provide FormData, either globally or through the existingFormData argument. Modern browsers and supported Node.js releases provide a global implementation.

Development

Run the test suite:

bash
bun run test

Inspect the package contents before publishing:

bash
bun pm pack --dry-run

License

MIT

Issues· 0 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

JavaScript

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月17日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言