QueryParamUtil

• Written in TypeScript with ES6
• No dependencies
• TypeScript typings for public methods
• Supports arrays (ex. thing[]=one&thing[]=two)

Install

$ npm i QueryParamUtil

Tests

$ cd __path_to_project__ && mocha

Usage

const qp = require('QueryParamUtil').QueryParamUtil;

Public Methods

find(name, default_val, query_string?)

Finds a specific key and returns it's value If not set, will return a default value

Parameters

name: string If not set, will return a default value

default_val: any defaults to null if not specified

query_string?: string defaults to window.location.search if not specified

Returns: string[]|string

// uses window.location.search
const myJob = qp.find('job');

// use your own query string
const myJob = qp.find('job', null, 'name=chris&job=developer');

all(query_string)

Fills an object with all key/val pairs from a query string defaults to window.location.search if not specified

Parameters

query_string: string defaults to window.location.search if not specified

Returns: Object

// uses window.location.search
const params = qp.all();

// use your own query string
const params = qp.all('name=chris&job=developer&skills[]=js&skills[]=php');

/*
    {
        name: 'chris',
        job: 'developer',
        skills: ['js', 'php']
    }
*/

set(values)

Takes an object of key/vals and returns an encoded url param string

Parameters

values: Object

Returns: string

window.location.search = qp.set({name:'chris',job:'developer',skills:['js','php']);

/*
    returns 'name=chris&job=developer&skills[]=js&skills[]=php&skills[]=functional'
*/