Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
url-search-utils
Advanced tools
Readme
A simple set of utils for manipulate search params in query string. Supports the hash and browser histories.
npm install url-search-utils --save
import {parseSearchParams, parseHashParams, parseHashLocationQuery} from 'url-search-utils';
...
// parse get arguments
// e.g. http://127.0.0.1:8080/page/?foo=5&bar=baz
parseSearchParams(config)
// parse get-like arguments in hash
// e.g. http://127.0.0.1:8080/page/#foo=5&bar=baz
parseHashParams(config)
// parse location-query-like arguments in hash
// e.g. http://127.0.0.1:8080/#/page/?foo=5&bar=baz
parseHashLocationQuery(config)
config
is an object with keys is get-params names and values is one of:
'number'
for numeric params.'array-of-strings'
for arrays of strings.'array-of-numbers'
for arrays of numbers.'exclude'
for exclude param from result.function(value, accumulator = initialValue) {...}
where value is current value of found get-param and accumulator is value from previous function call if param with current name occurs several times (undefined
by default).For example:
// current query is '?param1=value1&numberparam=2&strarray=str1&strarray=str2&strarray=str3&date=2017-09-06'
const parsed = parseSearchParams({
numberparam: 'number',
strarray: 'array-of-strings',
date: (dateStr) => moment(dateStr, 'YYYY-MM-DD'),
})
// returns
// {
// param1: 'value1',
// numberparam: 2,
// strarray: ['str1', 'str2', 'str3'],
// date: moment('2017-09-06', 'YYYY-MM-DD'),
// }
import {setSearchParams, setHashParams, setHashLocationQuery} from 'url-search-utils';
...
// set get arguments
// e.g. http://127.0.0.1:8080/page/?foo=5&bar=baz
setSearchParams(values, mapParamsNames, config)
// set get-like arguments in hash
// e.g. http://127.0.0.1:8080/page/#foo=5&bar=baz
setHashParams(values, mapParamsNames, config)
// set location-query-like arguments in hash
// e.g. http://127.0.0.1:8080/#/page/?foo=5&bar=baz
setHashLocationQuery(values, mapParamsNames, config)
values
is an object that should be setted to query.
mapParamsNames
is an object with keys is specific keys from values
and values is params names for set to query.
config
is an object with keys is specific keys from values
(or values from mapParamsNames
) and values:
'include-if-falsy'
for include params with falsy values as empty strings to query.'exclude'
for exclude param from result.function(value) {...}
where value is value for serialize. If returns null
, param won't included to search.For example:
setSearchParams({
page: 3,
perPage: 20,
date: moment(),
filters: [1, 2, 3],
}, {
perPage: 'page_size',
}, {
date: (value) => value.format('YYYY-MM-DD'),
})
// sets query
// '?page=3&page_size=20&date=2017-09-06&filters=1&filters=2&filters=3'
FAQs
Utils for manipulate search params in query string.
The npm package url-search-utils receives a total of 18 weekly downloads. As such, url-search-utils popularity was classified as not popular.
We found that url-search-utils demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.