String.prototype.search()

Метод search() (шукати) значень String виконує пошук збігу між регулярним виразом та своїм рядком, повертаючи індекс першого знайденого у своєму рядку збігу.

Спробуйте його в дії

Синтаксис

search(regexp)

Параметри

regexp

Об'єкт регулярного виразу, або будь-який інший об'єкт, що має метод Symbol.search.

Якщо параметр regexp не є об'єктом RegExp і не має методу Symbol.search, то він неявно перетворюється на RegExp за допомогою new RegExp(regexp).

Повернене значення

Індекс першого збігу вмісту рядка з регулярним виразом, або -1 — якщо збігу знайдено не було.

Опис

Реалізація String.prototype.search() робить небагато, окрім виклику метода Symbol.search переданого аргументу зі своїм рядком як першим параметром. Фактична реалізація надходить з RegExp.prototype[Symbol.search]().

Позначка g виразу regexp не впливає на результат search(), і пошук завжди відбувається так, ніби властивість lastIndex регулярного виразу має значення 0. Більше інформації про логіку search() дивіться на сторінці RegExp.prototype[Symbol.search]().

Коли треба знати, чи був знайдений патерн, а також індекс збігу в рядку, слід використовувати search().

• Якщо треба знати лише те, чи збіг існує, слід використовувати метод test(), який повертає булеве значення.
• Якщо потрібен сам текст, що дає збіг, слід використовувати String.prototype.match() або RegExp.prototype.exec().

Приклади

Застосування методу search()

Наступний приклад шукає збіг з двома різними регулярними виразами для ілюстрації різниці між успішним пошуком (додатне значення) та неуспішним (-1)

const str = "hey JudE";
const re = /[A-Z]/;
const reDot = /[.]/;
console.log(str.search(re)); // повертає значення 4 — індекс першої великої літери "J"
console.log(str.search(reDot)); // повертає -1 — не може знайти розділовий знак '.'

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

Сумісність із браузерами

Дивіться також

• Поліфіл String.prototype.search у складі core-js, з виправленнями та реалізацією сучасної логіки штибу підтримки Symbol.search
• Посібник Регулярні вирази
• String.prototype.match()
• RegExp.prototype.exec()
• RegExp.prototype[Symbol.search]()