Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

form-urlencoded

iambumblehead692.6kMIT6.1.5TypeScript support: included

Return an object as an 'x-www-form-urlencoded' string

querystring, x-www-form-urlencoded, www-form-urlencoded, form-urlencoded, urlencoded, urlencode, encoding, encoded, encode, form, json encode

readme

form-urlencoded

(c)Bumblehead, JBlashill

npm version Build Status

Returns 'x-www-form-urlencoded' string data, an encoding often used when an HTML form is submitted. Form data is serialised in this format and sent to a server.

import formurlencoded from 'form-urlencoded'
// or:
// var formurlencoded = require('form-urlencoded')

const obj = {
  str: 'val',
  num: 0,
  arr: [3, {prop: false}, 1, null, 6],
  obj: {prop1: null, prop2: ['elem']}
}

console.log(formurlencoded(obj))
// str=val&num=0&arr%5B0%5D=3&arr%5B1%5D%5Bprop%5D=false
// &arr%5B2%5D=1&arr%5B3%5D=null&arr%5B4%5D=6&obj%5Bprop
// 1%5D=null&obj%5Bprop2%5D%5B0%5D=elem

console.log(formurlencoded(obj, {
  ignorenull: true,
  skipIndex: true,
  sorted: true
}))
// arr%5B%5D=3&arr%5B%5D%5Bprop%5D=false&arr%5B%5D=1&arr
// %5B%5D=6&num=0&obj%5Bprop2%5D%5B%5D=elem&str=val

console.log(formurlencoded(obj, {
  ignoreEmptyArray: true,
  ignorenull: true,
  useDot: true,
  skipIndex: true,
  skipBracket: true
}))
// str=val&num=0&arr=3&arr.prop=false&arr=1&arr=6&obj.pr
// op2=elem

scrounge

(The MIT License)

Copyright (c) Bumblehead chris@bumblehead.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

changelog

Changelog

6.1.5 - 2024-04-29

6.1.4 - 2023-09-24

6.1.3 - 2023-09-11

6.1.2 - 2023-09-10

6.1.1 - 2023-09-10

6.1.0 - 2022-07-29

6.0.7 - 2022-07-23

  • use prepublishOnly rather than prepare

6.0.6 - 2022-02-03

  • update typescript definition

6.0.5 - 2021-10-20

  • version bump
  • remove package-lock.json, no depedencies so make bot and install warnings go away

6.0.4 - 2021-05-14

  • remove un-used babel devDependencies

6.0.3 - 2021-04-21

  • add README.md to published files list

6.0.2 - 2021-04-20

  • Use node 15 for build and publish pipeline

6.0.1 - 2021-04-20

  • Added github actions files for testing and publishing,
  • Added changelog from @Vestride

6.0.0 - 2021-04-13

  • Add exports field to the package.json to support native esm.

5.0.0 - 2021-04-13 (unpublished)

  • Add exports field to the package.json to support native esm.

4.4.0 - 2021-03-21

  • Add Typescript definition file.

4.0.0 - 2019-07-23

  • Add browser field to package.json.

3.0.0 - 2018-06-05

  • Use ES6 default export.

2.0.0 - 2017-07-04

  • Update source files to use ES2016 syntax (const, let, arrow functions).