# @f/serialize-form

> Serialize a form to JSON

Latest version **1.0.0** (published 2016-02-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @f/serialize-form
pnpm add @f/serialize-form
yarn add @f/serialize-form
bun add @f/serialize-form
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-02-10 |
| First published | 2016-02-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | f |

## Links

- npm: https://www.npmjs.com/package/@f/serialize-form
- Repository: https://github.com/micro-js/serialize-form
- Homepage: https://github.com/micro-js/serialize-form#readme
- Issues: https://github.com/micro-js/serialize-form/issues
- npm.io page: https://npm.io/package/@f/serialize-form

## Dependencies (5)

- [@f/brackets](https://npm.io/package/@f/brackets.md) ^1.0.0
- [@f/get-value](https://npm.io/package/@f/get-value.md) ^1.0.0
- [@f/reduce-array](https://npm.io/package/@f/reduce-array.md) ^0.2.1
- [@f/form-controls](https://npm.io/package/@f/form-controls.md) ^1.0.0
- [@f/is-element-submittable](https://npm.io/package/@f/is-element-submittable.md) ^1.0.0

## Recent versions

- 1.0.0 (latest) — 2016-02-10

## README

# serialize-form

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Serialize a form to JSON

## Installation

    $ npm install @f/serialize-form

## Usage

serialize-form takes a form element and turns it into a JSON object based on the names of the form controls. The naming conventions are defined by [brackets](https://github.com/micro-js/brackets).

**Form syntax example:**

```js
serialize($(`
  <form>
    <input type='text' name='name[first]' value='micro' />
    <input type='text' name='name[last]' value='js' />
    <input type='checkbox' name='accepted_terms' checked />
  </form>
`)) // -> {
  name: {
    first: 'micro',
    last: 'js'
  },
  accepted_terms: true
}
```

**Submit example:**

```js
var serialize = require('@f/serialize-form')

function onSubmit (e) {
  var json = serialize(e.target)

  return fetch('/user', {
    method: 'post',
    body: serialize(e.target)
  })
}
```

## API

### serialize(form)

- `form` - The form element who's controls you want to serialize

**Returns:** The JSON serialization of `form`

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/serialize-form.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/serialize-form
[git-image]: https://img.shields.io/github/tag/micro-js/serialize-form.svg
[git-url]: https://github.com/micro-js/serialize-form
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@f/serialize-form.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@f/serialize-form

---
_Source: https://npm.io/package/@f/serialize-form · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._