sticky property reflects whether or not the search is sticky (searches in strings only from the index indicated by the
lastIndex property of this regular expression).
sticky is a read-only property of an individual regular expression object.
|Property attributes of
The value of
sticky is a
Boolean and true if the "
y" flag was used; otherwise, false. The "
y" flag indicates that it matches only from the index indicated by the
lastIndex property of this regular expression in the target string (and does not attempt to match from any later indexes). A regular expression defined as both
global ignores the
You cannot change this property directly. It is read-only.
const str = '#foo#'; const regex = /foo/y; regex.lastIndex = 1; regex.test(str); // true regex.lastIndex = 5; regex.test(str); // false (lastIndex is taken into account with sticky flag) regex.lastIndex; // 0 (reset after match failure)
For several versions, Firefox's SpiderMonkey engine had a bug with regard to the
^ assertion and the sticky flag which allowed expressions starting with the
^ assertion and using the sticky flag to match when they shouldn't. The bug was introduced some time after Firefox 3.6 (which had the sticky flag but not the bug) and fixed in 2015. Perhaps because of the bug, the ES2015 specification specifically calls out the fact that:
yflag is used with a pattern, ^ always matches only at the beginning of the input, or (if
true) at the beginning of a line.
Examples of correct behavior:
const regex = /^foo/y; regex.lastIndex = 2; regex.test('..foo'); // false - index 2 is not the beginning of the string const regex2 = /^foo/my; regex2.lastIndex = 2; regex2.test('..foo'); // false - index 2 is not the beginning of the string or line regex2.lastIndex = 2; regex2.test('.\nfoo'); // true - index 2 is the beginning of a line
|ECMAScript Language Specification |
BCD tables only load in the browser