query

Pool

Modern, tree-shakeable URL query string parser/stringifier with TypeScript support

$ lpm install @lpm.dev/neo.query

README API Skills3 Dependencies Versions1

36 exportsTypeScript

dist/compat

Functions

toSearchParams

function toSearchParams(query: StringifiableQuery, options?: StringifyOptions): URLSearchParams

Parameter	Type	Description
`query`	`StringifiableQuery`
`options`optional	`StringifyOptions`

fromSearchParams

function fromSearchParams(params: URLSearchParams, options?: ParseOptions): ParsedQuery

Parameter	Type	Description
`params`	`URLSearchParams`
`options`optional	`ParseOptions`

dist/compat

Functions

toSearchParams

function toSearchParams(query: StringifiableQuery, options?: StringifyOptions): URLSearchParams

Parameter	Type	Description
`query`	`StringifiableQuery`
`options`optional	`StringifyOptions`

fromSearchParams

function fromSearchParams(params: URLSearchParams, options?: ParseOptions): ParsedQuery

Parameter	Type	Description
`params`	`URLSearchParams`
`options`optional	`ParseOptions`

dist/exclude-DT7gACgB

Functions

pick

function pick(query: ParsedQuery, keys: string[]): ParsedQuery

Parameter	Type	Description
`query`	`ParsedQuery`
`keys`	`string[]`

exclude

function exclude(query: ParsedQuery, keys: string[]): ParsedQuery

Parameter	Type	Description
`query`	`ParsedQuery`
`keys`	`string[]`

dist/exclude-xxhyyy4q

Functions

pick

function pick(query: ParsedQuery, keys: string[]): ParsedQuery

Parameter	Type	Description
`query`	`ParsedQuery`
`keys`	`string[]`

exclude

function exclude(query: ParsedQuery, keys: string[]): ParsedQuery

Parameter	Type	Description
`query`	`ParsedQuery`
`keys`	`string[]`

dist/parse-CQvkKEiu

Functions

parse

function parse(query: string, options?: ParseOptions): ParsedQuery

Parameter	Type	Description
`query`	`string`
`options`optional	`ParseOptions`

dist/parse-Dt0rWFJV

Functions

parse

function parse(query: string, options?: ParseOptions): ParsedQuery

Parameter	Type	Description
`query`	`string`
`options`optional	`ParseOptions`

dist/parse

Functions

defaultDecoder

function defaultDecoder(str: string): string

Parameter	Type	Description
`str`	`string`

decodeValue

function decodeValue(value: string, decoder?: (value: string, defaultDecoder: (str: string) => string) => string): string

Parameter	Type	Description
`value`	`string`
`decoder`optional	`(value: string, defaultDecoder: (str: string) => string) => string`

parseType

function parseType(value: string, options: ParseOptions): QueryValue

Parameter	Type	Description
`value`	`string`
`options`	`ParseOptions`

dist/parse

Functions

defaultDecoder

function defaultDecoder(str: string): string

Parameter	Type	Description
`str`	`string`

decodeValue

function decodeValue(value: string, decoder?: (value: string, defaultDecoder: (str: string) => string) => string): string

Parameter	Type	Description
`value`	`string`
`decoder`optional	`(value: string, defaultDecoder: (str: string) => string) => string`

parseType

function parseType(value: string, options: ParseOptions): QueryValue

Parameter	Type	Description
`value`	`string`
`options`	`ParseOptions`

dist/stringify-Br43TfYj

Functions

stringify

function stringify(obj: StringifiableQuery, options?: StringifyOptions): string

Parameter	Type	Description
`obj`	`StringifiableQuery`
`options`optional	`StringifyOptions`

dist/stringify-CSqxrjnN

Functions

stringify

function stringify(obj: StringifiableQuery, options?: StringifyOptions): string

Parameter	Type	Description
`obj`	`StringifiableQuery`
`options`optional	`StringifyOptions`

dist/stringify

Functions

strictEncoder

function strictEncoder(str: string): string

Parameter	Type	Description
`str`	`string`

defaultEncoder

function defaultEncoder(str: string): string

Parameter	Type	Description
`str`	`string`

encodeValue

function encodeValue(value: string, strict: boolean, encoder?: (value: string, defaultEncoder: (str: string) => string) => string): string

Parameter	Type	Description
`value`	`string`
`strict`	`boolean`
`encoder`optional	`(value: string, defaultEncoder: (str: string) => string) => string`

encodeKey

function encodeKey(key: string, strict: boolean, encoder?: (value: string, defaultEncoder: (str: string) => string) => string): string

Parameter	Type	Description
`key`	`string`
`strict`	`boolean`
`encoder`optional	`(value: string, defaultEncoder: (str: string) => string) => string`

dist/stringify

Functions

strictEncoder

function strictEncoder(str: string): string

Parameter	Type	Description
`str`	`string`

defaultEncoder

function defaultEncoder(str: string): string

Parameter	Type	Description
`str`	`string`

encodeValue

function encodeValue(value: string, strict: boolean, encoder?: (value: string, defaultEncoder: (str: string) => string) => string): string

Parameter	Type	Description
`value`	`string`
`strict`	`boolean`
`encoder`optional	`(value: string, defaultEncoder: (str: string) => string) => string`

encodeKey

function encodeKey(key: string, strict: boolean, encoder?: (value: string, defaultEncoder: (str: string) => string) => string): string

Parameter	Type	Description
`key`	`string`
`strict`	`boolean`
`encoder`optional	`(value: string, defaultEncoder: (str: string) => string) => string`

dist/url

Functions

extract

function extract(url: string): string

Parameter	Type	Description
`url`	`string`

parseUrl

function parseUrl(url: string, options?: ParseOptions): ParsedUrl

Parameter	Type	Description
`url`	`string`
`options`optional	`ParseOptions`

stringifyUrl

function stringifyUrl(components: UrlComponents, options?: StringifyOptions): string

Parameter	Type	Description
`components`	`UrlComponents`
`options`optional	`StringifyOptions`

dist/url

Functions

extract

function extract(url: string): string

Parameter	Type	Description
`url`	`string`

parseUrl

function parseUrl(url: string, options?: ParseOptions): ParsedUrl

Parameter	Type	Description
`url`	`string`
`options`optional	`ParseOptions`

stringifyUrl

function stringifyUrl(components: UrlComponents, options?: StringifyOptions): string

Parameter	Type	Description
`components`	`UrlComponents`
`options`optional	`StringifyOptions`

dist/utils

Functions

splitQuery

function splitQuery(query: string): string[]

Parameter	Type	Description
`query`	`string`

splitPair

function splitPair(pair: string): [string, string]

Parameter	Type	Description
`pair`	`string`

dist/utils

Functions

splitQuery

function splitQuery(query: string): string[]

Parameter	Type	Description
`query`	`string`

splitPair

function splitPair(pair: string): [string, string]

Parameter	Type	Description
`pair`	`string`

Unlimited AccessInstall as many Pool packages as you need.

Fund Real WorkEvery install you run sends revenue directly to the developer who built it.

Taxes calculated at checkout based on your location.

Insights

95/100Excellent

Weekly Installs

Version

1.0.0

Published

Repository

github.com(opens in new tab)

Website

neo-demos.vercel.app(opens in new tab)

LicenseMIT

Size583.11 KB

Files51

Node version>= 18

TypeScriptYes