parse-form

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 12 Open GitHub ↗

📃 Utility to easily parse forms in the browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">
  
  <br/>
  Parse-Form
	<br/>

<a href="https://nodejs.org/api/documentation.html#documentation_stability_index">
    <img src="https://img.shields.io/badge/stability-stable-brightgreen.svg" alt="API Stability"/>
  </a>
  
  <a href="http://typescriptlang.org">
    <img src="https://img.shields.io/badge/%3C%2F%3E-typescript-blue.svg" alt="TypeScript"/>
  </a>
  
  <a href="https://github.com/prettier/prettier">
    <img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg" alt="Styled with prettier"/>
  </a>
  
  <a href="https://travis-ci.org/DylanPiercey/parse-form">
  <img src="https://img.shields.io/travis/DylanPiercey/parse-form.svg" alt="Build status"/>
  </a>
  
  <a href="https://coveralls.io/github/DylanPiercey/parse-form">
    <img src="https://img.shields.io/coveralls/DylanPiercey/parse-form.svg" alt="Test Coverage"/>
  </a>
  
  <a href="https://npmjs.org/package/parse-form">
    <img src="https://img.shields.io/npm/v/parse-form.svg" alt="NPM Version"/>
  </a>
  
  <a href="https://npmjs.org/package/parse-form">
    <img src="https://img.shields.io/npm/dm/parse-form.svg" alt="Downloads"/>
  </a>
  
  <a href="https://npmjs.org/package/parse-form">
    <img src="https://img.shields.io/badge/size-1.26kb-green.svg" alt="Browser Bundle Size"/>
  </a>
</h1>

Utility convert a form to a javascript object in the way that a browser might.
Supports files, and every type of native input.

# Installation

```console
npm install parse-form
```

# Example

```html
<form id="my-form">
  <input type="text" name="a[b][c]" value="hello world"/>
  <input type="file" name="myFyle" value=.../>
  <button type="submit">Submit</button>
</form>
```

```javascript
import { parse } from "parse-form";

const form = document.getElementById("my-form");
parse(form);
/**
 * {
 *     body: { a: { b: { c: "hello world" } } },
 *     files: { myFile: [...] }
 * }
 */
```

# API

`parse(form: HTMLFormElement, shallow: boolean): { body: object, files: object }`
 * Parses a form into a javascript object.
 * If `shallow` is true then nested keys such as a[b][c] won't be expanded.

### Contributions

* Use `npm test` to build and run tests.

Please feel free to create a PR!

parse-form

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README