URLSearchParams

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

Примечание: Эта возможность доступна в Web Workers.

URLSearchParams интерфейс определяет служебные методы для работы со строкой запроса URL.

Объект, реализующий URLSearchParams, может непосредственно использоваться в структуре for...of, например, следующие две строки идентичны:

for (var p of mySearchParams);
for (var p of mySearchParams.entries());

Примечание: Эта возможность доступна в Web Workers.

Конструктор

URLSearchParams()

Конструктор возвращает объект URLSearchParams.

Свойства

Наследование свойств отсутствует.

Методы

Отсутствует наследование методов.

URLSearchParams.append()

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

URLSearchParams.delete()

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

URLSearchParams.entries()

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

URLSearchParams.get()

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

URLSearchParams.getAll()

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

URLSearchParams.has()

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

URLSearchParams.keys()

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

URLSearchParams.set()

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

URLSearchParams.toString()

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

URLSearchParams.values()

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

Пример

js
var paramsString = "q=URLUtils.searchParams&topic=api";
var searchParams = new URLSearchParams(paramsString);

// Итерируем параметры поиска.
for (let p of searchParams) {
  console.log(p);
}

searchParams.has("topic") === true; // true
searchParams.get("topic") === "api"; // true
searchParams.getAll("topic"); // ["api"]
searchParams.get("foo") === null; // true
searchParams.append("topic", "webdev");
searchParams.toString(); // "q=URLUtils.searchParams&topic=api&topic=webdev"
searchParams.set("topic", "More webdev");
searchParams.toString(); // "q=URLUtils.searchParams&topic=More+webdev"
searchParams.delete("topic");
searchParams.toString(); // "q=URLUtils.searchParams"

Спецификации

Specification
URL Standard
# urlsearchparams

Совместимость с браузерами

BCD tables only load in the browser

Смотрите также