jQuery утилиты

Утилиты jQuery — это вспомогательные функции для работы с данными и элементами документа. Они позволяют проверять типы значений, перебирать массивы и объекты, обрабатывать функции, HTML- и XML-строки, а также данные, связанные с DOM-элементами.

Функции вида $.each(value, handler) вызываются на самой библиотеке; методы вида collection.each(handler) — на коллекции. Не путайте $.each() с .each() и $.map() с .map(): у них различаются аргументы и возвращаемые значения.

Этот раздел помогает разбирать существующий код и плагины. Часть задач решают встроенные средства JavaScript: Array.isArray(), JSON.parse(), Date.now(), String.prototype.trim(). При замене проверяйте обработку типов и пустых значений, а не только похожее название.

Актуальные примеры используют jQuery 4.0.0. Примеры удалённых функций явно используют 3.1.1. Метка «Устарело» не всегда означает удаление: например, $.support остаётся, но его внутренние флаги не являются стабильным публичным интерфейсом.

Функция Описание
$.contains() Позволяет проверить и возвратить логическое значение, которое определяет является ли элемент DOM потомком другого элемента DOM.
$.data() Позволяет сохранить произвольные данные, связанные с указанным элементом, и/или возвращать заданное значение.
$.each() Перебирает массивоподобный объект или перечислимые свойства объекта. Обработчик получает индекс/ключ и значение; return false останавливает обход. Возвращается исходный объект.
$.extend() Копирует свойства источников в целевой объект и возвращает его. По умолчанию копирование поверхностное; первый аргумент true включает рекурсивное объединение.
$.fn.extend() Позволяет объединить содержимое объекта с прототипом jQuery, чтобы предоставить объекту методы экземпляра jQuery.
$.globalEval() Позволяет выполнить определенный код JavaScript в глобальной области видимости.
$.grep() Позволяет найти элементы массива, которые удовлетворяют фильтрующей функции, исходный массив при этом не изменяется.
$.inArray() Производит поиск переданного значения в массиве и возвращает его индекс при нахождении, или значение -1, если не найден.
$.isArray() Устарело Определяет, является ли переданное значение в параметре метода массивом JavaScript. Устарело с jQuery 3.2. Удалён в 4.0.
$.isEmptyObject() Проверяет отсутствие перечислимых строковых свойств, включая унаследованные. Символы и неперечислимые свойства не учитывает.
$.isNumeric() Устарело Проверяет конечные числа и строки, преобразуемые в конечные числа; NaN, Infinity и пустая строка дают false. Устарело с jQuery 3.3. Удалён в 4.0.
$.isPlainObject() Проверяет, является ли значение простым объектом. Принимает также объекты без прототипа; не является проверкой схемы данных.
$.isXMLDoc() Позволяет проверить находится ли узел DOM внутри XML документа, или является XML документом.
$.makeArray() Позволяет преобразовать массивоподобный объект в JavaScript массив.
$.map() Преобразует массив или объект в новый массив. Обработчик получает значение и индекс/ключ; null и undefined пропускаются, возвращённые массивы раскрываются на один уровень.
$.merge() Добавляет элементы второго массива или массивоподобного объекта в первый и возвращает изменённый первый объект. Повторы не удаляет.
$.noop() Определяет пустую функцию.
$.now() Устарело Историческая функция времени: число миллисекунд с начала эпохи Unix. Устарела с 3.3, удалена в 4.0; используйте Date.now().
$.parseHTML() Разбирает HTML в массив узлов. По умолчанию исключает исполняемые скрипты, но не очищает все опасные конструкции разметки.
$.parseXML() Позволяет преобразовать переданную XML строку в XML документ.
$.removeData() Позволяет удалить значения, которые были установлены с помощью метода $.data().
$.trim() Устарело Позволяет удалить пробелы из начала и конца строки. Устарело с jQuery 3.5. Удалён в 4.0.
$.type() Устарело Позволяет определить внутренний JavaScript класс объекта ([[Class]]). Устарело с jQuery 3.3. Удалён в 4.0.
$.uniqueSort() Производит сортировку массива элементов DOM с удалением дубликатов.
.uniqueSort() Сортирует коллекцию DOM-элементов и исключает повторные узлы. Метод коллекции с версии 3.7.

Другие функции и исторические API

Назначение и ограничения API
API Описание
$() Создаёт коллекцию по селектору, DOM-элементам или HTML-строке; при передаче функции регистрирует обработчик готовности DOM. Это сокращение для jQuery(). Документация.
$.dequeue() Запускает следующую функцию очереди указанного DOM-элемента; имя очереди по умолчанию — fx. Документация.
$.queue() Читает или меняет очередь функций отдельного DOM-элемента. Для продолжения пользовательской очереди вызывайте $.dequeue(). Документация.
$.hasData() Проверяет наличие данных jQuery у DOM-элемента, включая внутренние данные обработчиков событий. Не создаёт хранилище при проверке. Документация.
$.isFunction() Устарело Проверяет, является ли значение функцией. Для обычных современных функций используйте проверку typeof value === "function". Документация. Устарело с jQuery 3.3. Удалён в 4.0.
$.isWindow() Устарело Проверяет, представляет ли переданный объект окно браузера. Не следует путать с проверкой любого глобального объекта JavaScript. Документация. Устарело с jQuery 3.3. Удалён в 4.0.
$.noConflict() Возвращает прежнее значение глобального $ и возвращает сам объект jQuery для сохранения под другим именем. Аргумент true освобождает также имя jQuery. Документация.
$.parseJSON() Устарело Разбирает JSON-строку. Устарел с jQuery 3.0; используйте JSON.parse(), который выбрасывает исключение при неверном JSON. Документация. Удалён в 4.0.
$.unique() Устарело Старое имя сортировки DOM-элементов в порядке документа с удалением повторов. Устарело с jQuery 3.0; используйте $.uniqueSort(). Документация. Удалён в 4.0.
$.support Устарело Внутренние результаты проверок возможностей браузера. Состав свойств не является стабильным публичным контрактом; собственные проверки поддержки выполняйте отдельно. Документация. Устарело с jQuery 1.9.
$.error() Выбрасывает исключение Error с указанным сообщением. Может использоваться плагинами; обычная альтернатива — throw new Error(message). Документация.
$.readyException() Обрабатывает исключения из функций готовности DOM. По умолчанию повторно выбрасывает ошибку асинхронно, чтобы остальные обработчики могли выполниться. Документация.