pick | /mod.js | querystring@v1.0.2

function pick

import { pick } from "https://deno.land/x/querystring@v1.0.2/mod.js";

pick(

url: string,

keys: readonly string[],

options?: ParseOptions & StringifyOptions,

): string

Pick query parameters from a URL.

pick(

url: string,

filter: (key: string, value: string | boolean | number) => boolean,

options?: { parseBooleans: true; parseNumbers: true; } & ParseOptions & StringifyOptions,

): string

pick(

url: string,

filter: (key: string, value: string | boolean) => boolean,

options?: { parseBooleans: true; } & ParseOptions & StringifyOptions,

): string

pick(

url: string,

filter: (key: string, value: string | number) => boolean,

options?: { parseNumbers: true; } & ParseOptions & StringifyOptions,

): string

Pick query parameters from a URL.

Examples

Example 1

queryString.pick('https://foo.bar?foo=1&bar=2#hello', ['foo']);
//=> 'https://foo.bar?foo=1#hello'

queryString.pick('https://foo.bar?foo=1&bar=2#hello', (name, value) => value === 2, {parseNumbers: true});
//=> 'https://foo.bar?bar=2#hello'

Parameters

url: string

The URL containing the query parameters to pick.

keys: readonly string[]

The names of the query parameters to keep. All other query parameters will be removed from the URL.

optional

options: ParseOptions & StringifyOptions

A filter predicate that will be provided the name of each query parameter and its value. The parseNumbers and parseBooleans options also affect value.