логотип PurpleSchool
Иконка входа
Вход
  • Обучение
  • Войти
логотип PurpleSchool

URLSearchParams в JavaScript

Автор

Дмитрий Фандорин

URLSearchParams - это встроенный в браузер API, который позволяет получить или отформатировать поисковые параметры из URL. Это удобный инструмент для работы с URL-адресами, который может быть использован для получения, добавления, удаления и изменения параметров поиска в URL.

URLSearchParams может быть использован для получения параметров поиска из текущего URL-адреса, используя свойство window.location.search.

Пример:

const searchParams = new URLSearchParams(window.location.search);
console.log(searchParams.get('query')); // выводит значение параметра "query" из текущего URL

Форма записи

Создание экземпляра класса

Для создания экземпляра класса URLSearchParams необходимо вызвать конструктор класса с параметром, содержащим строку запроса.

Пример:

const searchParams = new URLSearchParams('param1=value1&param2=value2');

Добавление параметров

Добавление параметров поиска в URL осуществляется с помощью метода append(name, value). Он добавляет параметр с указанным именем и значением в конец строки запроса.

Пример:

searchParams.append('param3', 'value3');

Запись параметров

Запись параметров поиска в URL осуществляется с помощью метода set(name, value). Он устанавливает значение для параметра с указанным именем.

Пример:

searchParams.set('param1', 'newvalue');

Получение значения параметра

Получение значения параметра поиска из URL осуществляется с помощью метода get(name). Он возвращает значение параметра с указанным именем.

Пример:

console.log(searchParams.get('param1')); // выводит "newvalue"

Проверка наличия параметра

Проверка наличия параметра поиска в URL осуществляется с помощью метода has(name). Он возвращает true, если параметр с указанным именем присутствует в URL, и false в противном случае.

Пример:

console.log(searchParams.has('param1')); // выводит true
console.log(searchParams.has('param4')); // выводит false

Получение имён всех параметров

Получение списка имен всех параметров поиска в URL осуществляется с помощью метода keys(). Он возвращает итератор, который перебирает имена всех параметров.

Пример:

for (const paramName of searchParams.keys()) {
  console.log(paramName);
}

Получение всех значений параметров

Получение списка всех значений параметров поиска в URL осуществляется с помощью метода values(). Он возвращает итератор, который перебирает все значения параметров.

Пример:

for (const paramValue of searchParams.values()) {
  console.log(paramValue);
}

Получение всех параметров

Получение списка всех параметров поиска в URL осуществляется с помощью метода entries(). Он возвращает итератор, который перебирает все параметры и их значения в формате [name, value].

Пример:

for (const [paramName, paramValue] of searchParams.entries()) {
  console.log(paramName + ': ' + paramValue);
}

Удаление параметра

Удаление параметра поиска из URL осуществляется с помощью метода delete(name). Он удаляет параметр с указанным именем из строки запроса.

Пример:

searchParams.delete('param1');

Сортировка параметров

Сортировка параметров поиска в URL осуществляется с помощью методаsort(). Он упорядочивает параметры по их именам в алфавитном порядке.

Пример:

searchParams.sort();

Перебор параметров

Перебор параметров поиска в URL осуществляется с помощью итератора, который возвращает метод Symbol.iterator.

Пример:

for (const param of searchParams) {
  console.log(param);
}

Приведение параметров к строке

Приведение параметров поиска в URL к строке осуществляется с помощью метода toString(). Он возвращает строку, содержащую параметры поиска в URL.

Пример:

const searchParamsString = searchParams.toString();
console.log(searchParamsString);

Заключение

URLSearchParams - это удобный инструмент для работы с параметрами поиска в URL. Он предоставляет множество методов для получения, добавления, удаления и изменения параметров поиска в URL. При использовании URLSearchParams необходимо учитывать, что он доступен только в браузере и не поддерживается в Node.js.

изображение курса

Основы разработки

Антон Ларичев
иконка часов36 уроков
иконка звёздочки рейтинга5.0
Frontend
Backend
Mobile
бесплатноПодробнее
Основы разработки