URLSearchParams

class URLSearchParams {

constructor(init?: 

 | string[][]


 | Record<string, string>


 | string


 | URLSearchParams

);


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

delete(name: string): void;

entries(): IterableIterator<[string, string]>;

forEach(callbackfn: (
value: string,

key: string,

parent: this,
) => void, thisArg?: any): void;

get(name: string): string | null;

getAll(name: string): string[];

has(name: string): boolean;

keys(): IterableIterator<string>;

set(name: string, value: string): void;

sort(): void;

toString(): string;

values(): IterableIterator<string>;

[Symbol.iterator](): IterableIterator<[string, string]>;


static toString(): string;

}

Конструкторы

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

Методы

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

Добавляет указанную пару ключ/значение в качестве нового параметра поиска.

let searchParams = new URLSearchParams();
searchParams.append('name', 'first');
searchParams.append('name', 'second');

delete(name: string): void

Удаляет указанный параметр поиска и его связанное значение из списка всех параметров поиска.

let searchParams = new URLSearchParams([['name', 'value']]);
searchParams.delete('name');

entries(): IterableIterator<[string, string]>

Возвращает итератор, позволяющий пройтись по всем парам ключ/значение, содержащимся в этом объекте.

const params = new URLSearchParams([["a", "b"], ["c", "d"]]);
for (const [key, value] of params.entries()) {
  console.log(key, value);
}

forEach(callbackfn: (value: string, key: string, parent: this) => void, thisArg?: any): void

Вызывает функцию для каждого элемента, содержащегося в этом объекте на месте и возвращает неопределённое значение. Дополнительно принимает объект, который нужно использовать в качестве this при выполнении обратного вызова, как второй аргумент.

const params = new URLSearchParams([["a", "b"], ["c", "d"]]);
params.forEach((value, key, parent) => {
  console.log(value, key, parent);
});

get(name: string): string | null

Возвращает первое значение, связанное с данным параметром поиска.

searchParams.get('name');

getAll(name: string): string[]

Возвращает все значения, связанные с заданным параметром поиска, в виде массива.

searchParams.getAll('name');

has(name: string): boolean

Возвращает логическое значение, указывающее, существует ли параметр с указанным именем.

searchParams.has('name');

keys(): IterableIterator<string>

Возвращает итератор, позволяющий пройтись по всем ключам, содержащимся в этом объекте.

const params = new URLSearchParams([["a", "b"], ["c", "d"]]);
for (const key of params.keys()) {
  console.log(key);
}

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

Устанавливает значение, связанное с заданным параметром поиска, на указанное значение. Если было несколько совпадающих значений, этот метод удаляет остальные. Если параметр поиска не существует, этот метод создает его.

searchParams.set('name', 'value');

sort(): void

Сортирует все пары ключ/значение, содержащиеся в этом объекте на месте и возвращает неопределённое значение. Порядок сортировки соответствует кодовым точкам Юникода ключей.

searchParams.sort();

toString(): string

Возвращает строку запроса, подходящую для использования в URL.

searchParams.toString();

values(): IterableIterator<string>

Возвращает итератор, позволяющий пройтись по всем значениям, содержащимся в этом объекте.

const params = new URLSearchParams([["a", "b"], ["c", "d"]]);
for (const value of params.values()) {
  console.log(value);
}

[Symbol.iterator](): IterableIterator<[string, string]>

Возвращает итератор, позволяющий пройтись по всем парам ключ/значение, содержащимся в этом объекте.

const params = new URLSearchParams([["a", "b"], ["c", "d"]]);
for (const [key, value] of params) {
  console.log(key, value);
}

Статические методы

toString(): string