Skip to main content
Module

x/deno/js/url_search_params.ts>URLSearchParams

A modern runtime for JavaScript and TypeScript.
Go to Latest
class URLSearchParams
import { URLSearchParams } from "https://deno.land/x/deno@v0.1.12/js/url_search_params.ts";

Constructors

new
URLSearchParams(init?: string | string[][] | Record<string, string>)

Properties

private
params: Array<[string, string]>

Methods

append(name: string, value: string): void

Appends a specified key/value pair as a new search parameter.

  searchParams.append('name', 'first');
  searchParams.append('name', 'second');
delete(name: string): void

Deletes the given search parameter and its associated value, from the list of all search parameters.

  searchParams.delete('name');
entries(): Iterable<[string, string]>

Returns an iterator allowing to go through all key/value pairs contained in this object.

  for (const [key, value] of searchParams.entries()) {
    console.log(key, value);
  }
forEach(callbackfn: (
value: string,
key: string,
) => void
, thisArg?: any
)

Calls a function for each element contained in this object in place and return undefined. Optionally accepts an object to use as this when executing callback as second argument.

  searchParams.forEach((value, key, parent) => {
    console.log(value, key, parent);
  });
get(name: string): string | null

Returns the first value associated to the given search parameter.

  searchParams.get('name');
getAll(name: string): string[]

Returns all the values associated with a given search parameter as an array.

  searchParams.getAll('name');
has(name: string): boolean

Returns a Boolean that indicates whether a parameter with the specified name exists.

  searchParams.has('name');
keys(): Iterable<string>

Returns an iterator allowing to go through all keys contained in this object.

  for (const key of searchParams.keys()) {
    console.log(key);
  }
set(name: string, value: string): void

Sets the value associated with a given search parameter to the given value. If there were several matching values, this method deletes the others. If the search parameter doesn't exist, this method creates it.

  searchParams.set('name', 'value');
sort(): void

Sort all key/value pairs contained in this object in place and return undefined. The sort order is according to Unicode code points of the keys.

  searchParams.sort();
toString(): string

Returns a query string suitable for use in a URL.

   searchParams.toString();
values(): Iterable<string>

Returns an iterator allowing to go through all values contained in this object.

  for (const value of searchParams.values()) {
    console.log(value);
  }
[Symbol.iterator](): Iterable<[string, string]>

Returns an iterator allowing to go through all key/value pairs contained in this object.

  for (const [key, value] of searchParams[Symbol.iterator]()) {
    console.log(key, value);
  }