mithril-vndb/docs/parseQueryString.md
Isiah Meadows 85bfd0f77d
Clarify pathname docs, follow spec with fragments (#2448)
* Clarify pathname docs, follow spec with fragments

- Valid URLs must not contain a `#` within its fragment.
  https://github.com/MithrilJS/mithril.js/issues/2445
- Our docs were a little confusing and misleading - `m.pathname` isn't
  aware of URLs, just path names.
- Removed the relevant extension to `m.parseQueryString` required to
  support the hash parsing extension. Now we just shave it off and
  ignore it.
- Fix support for arbitrary prefixes, so prefixes like `?#` are
  handled correctly.
- Add a bunch of tests to cover various areas of confusion and unusual
  edge cases.

* Update with PR [skip ci]
2019-07-03 06:22:25 -04:00

1.6 KiB

parseQueryString(string)


Description

Turns a string of the form ?a=1&b=2 to an object

var object = m.parseQueryString("a=1&b=2")
// {a: "1", b: "2"}

Signature

object = m.parseQueryString(string)

Argument Type Required Description
string String Yes A querystring
returns Object A key-value map

How to read signatures


How it works

The m.parseQueryString method creates an object from a querystring. It is useful for handling data from URL

var data = m.parseQueryString("a=hello&b=world")

// data is {a: "hello", b: "world"}

Boolean type casting

This method attempts to cast boolean values if possible. This helps prevents bugs related to loose truthiness and unintended type casts.

var data = m.parseQueryString("a=true&b=false")

// data is {a: true, b: false}

Leading question mark tolerance

For convenience, the m.parseQueryString method ignores a leading question mark, if present:

var data = m.parseQueryString("?a=hello&b=world")

// data is {a: "hello", b: "world"}

Deep data structures

Querystrings that contain bracket notation are correctly parsed into deep data structures

m.parseQueryString("a[0]=hello&a[1]=world")

// data is {a: ["hello", "world"]}