@offirmo/simple-querystring-parser
v1.1.0
Published
A trivial, low footprint, no dependency, url querystring parser for the browser including typescript typings
Downloads
30
Readme
simple-querystring-parser
A trivial, low footprint, no dependency, UMD-compatible url querystring parser for the browser including typescript typings
This version departs from the venerable https://github.com/sindresorhus/query-string on those points:
- only 75 lines, no dependencies, ES5
- parses only (lighter)
- attempts to do a light type inference from the values (number, boolean)
- interprets "no value" as true (boolean) XXX this is non-standard but we consider it better (i.e. interpreting it as a flag)
- typescript compatible
- UMD compatible, but also exposes itself as a global var, even when loaded by a module loader. Reason: this lib may be needed by low-level code, for ex. a "verbose" option activating logs should be detected very early, maybe from inline code without a loader.
Tested in latest Chrome, FF and Safari and PhantomJS versions.
Usage
yarn add @offirmo/simple-querystring-parser
npm install --save @offirmo/simple-querystring-parser
Base, 99% of the time:
import * as SimpleQuerystringParser from '@offirmo/simple-querystring-parser'
const options = SimpleQuerystringParser.parse(window.location.search)
The type inference covers only the most useful cases:
- trivial positive integers will be converted to numbers
- true/false will be converted to boolean (case SENSITIVE)
- nothing "" will be converted to true (boolean)
This lib DOES NOT parse arrays, for the same reasons exposed by @sindresorhus you should better use json directly.
Rare stuff:
If you don't like the type inference or want to extend it / write your own:
import * as SimpleQuerystringParser from '@offirmo/simple-querystring-parser'
SimpleQuerystringParser.parse(location.params, {
valueDecoder: value => value
})
// just in case, the value decoder is exposed:
SimpleQuerystringParser.lightQuerystringValueDecoder('foo')
hat tips
- UMD block inspired from https://github.com/umdjs/umd/blob/master/templates/returnExportsGlobal.js
- borrowed some ideas from https://github.com/sindresorhus/query-string
- borrowed some ideas from colleagues
License
The UNLICENSE
CONTRIBUTING
Very simple. Some crappy unit tests. Try to keep the design principles.