npm i @cheprasov/url-query-params
URLQueryParams
The URLQueryParams class defines utility methods to work with the query string of a URL. It is a good replacement for standard URLSearchParams class.
An object implementing URLQueryParams can directly be used in a for...of
structure.
Why URLQueryParams is better than URLSearchParams?
- According to WHATWG, URLSearchParams uses
application/x-www-form-urlencoded
format. While it's suitable for decoding URL queries, for encoding it can lead to unexpected results such as spaces being encoded as +
and extra characters such as ~
being percent-encoded. - URLQueryParams is based on URLSearchParams class and implements all methods of URLSearchParams, but it uses correct encoding format for all characters via encodeURIComponentRFC3986 and conforms to newer RFC 3986 which defines more characters to escape, for example
*
.
1. How to install
> npm i @cheprasov/url-query-params
Import in .js / .ts file:
import { URLQueryParams } from '@chepraspv/url-query-params';
2. Quick examples
import { URLQueryParams } from '@chepraspv/url-query-params';
new URLQueryParams('foo=bar baz').toString();
new URLQueryParams('a=1&b=2&c=3').toObject();
3. Documentation
3.1 Constructor
new URLQueryParams(init?: string[][] | Record<string, string> | string | URLSearchParams | URLQueryParams)
3.2 Methods
URLQueryParams.append(name: string, value: string): void
URLQueryParams.delete(name: string): void
URLQueryParams.entries(): IterableIterator<[string, string]>
URLQueryParams.forEach(callbackfn: (value: string, key: string, parent: URLQueryParams) => void, thisArg?: any): void
URLQueryParams.get(name: string): string | null
URLQueryParams.getAll(name: string): string[]
URLQueryParams.has(name: string): boolean
URLQueryParams.keys(): IterableIterator<string>
URLQueryParams.set(name: string, value: string): void
URLQueryParams.sort(): void
URLQueryParams.toObject(): Record<string, string>
URLQueryParams.toString(): string
URLQueryParams.values(): IterableIterator<string>
Something does not work
Feel free to fork project, fix bugs, write tests and finally request for pull