pf
parse-form
npm i parse-form
pf

parse-form

📃 Utility to easily parse forms in the browser.

by Dylan Piercey

4.0.5 (see all)License:MITTypeScript:Built-In
npm i parse-form
Readme


Parse-Form
API Stability TypeScript Styled with prettier Build status Test Coverage NPM Version Downloads Browser Bundle Size

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

Installation

npm install parse-form

Example

<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>
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!

No alternatives found
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

100
No reviews found
Be the first to rate