@1k/qs v0.0.1

@1k/qs

First off, see if the built-in URLSearchParams is suitable for your needs.

This query string parser is dumb, don't expect to much from it as it only wants to parse simple query strings. If you want to parse complex, multi level and deeply nested query strings then you should rethink your approach, due to the lack of spec and numerous edge cases.

Installation

This module is released in npm as @1k/qs. It's also compatible with browserify so it can be used on the server as well as on the client. To install it simply run the following command from your CLI:

npm install --save @1k/qs

Usage

In the following examples we assume that you've already required the library as:

import * as qs from '@1k/qs'

qs.parse()

The parse method transforms a given query string in to an object. Parameters without values are set to empty strings. It does not care if your query string is prefixed with a ?, a #, or not prefixed. It just extracts the parts between the = and &:

import { parse } from '@1k/qs'

parse('?foo=bar')         // { foo: 'bar' }
parse('#foo=bar')         // { foo: 'bar' }
parse('foo=bar')          // { foo: 'bar' }
parse('foo=bar&bar=foo')  // { foo: 'bar', bar: 'foo' }
parse('foo&bar=foo')      // { foo: '', bar: 'foo' }

qs.stringify()

This transforms a given object in to a query string. By default we return the query string without a ? prefix. If you want to prefix it by default simply supply true as second argument. If it should be prefixed by something else simply supply a string with the prefix value as second argument:

import { stringify } from '@1k/qs'

stringify({ foo: bar })       // foo=bar

// with prefix
stringify({ foo: bar }, true) // ?foo=bar
stringify({ foo: bar }, '#')  // #foo=bar
stringify({ foo: '' }, '&')   // &foo=

License

MIT