string.prototype.matchall
Advanced tools
Package description
The string.prototype.matchall npm package is a polyfill for the `String.prototype.matchAll` method, which returns an iterator of all results matching a string against a regular expression, including capturing groups. This package is particularly useful for environments that do not yet support the `matchAll` method natively.
Matching all occurrences of a pattern
This feature allows you to find all occurrences of the pattern `/test/g` in the string `"test1test2"`. It returns an iterator that contains all matches.
"test1test2".matchAll(/test/g)Capturing groups in matches
This demonstrates how to use capturing groups with `matchAll`. The regular expression `/(te)(st\d)/g` includes two capturing groups that match parts of the string. The result is an iterator of matches, where each match includes the full matched text and the text matched by each capturing group.
"test1test2".matchAll(/(te)(st\d)/g)XRegExp provides augmented, extensible regular expressions. You can use it for more complex matching and replacing operations than what's possible with native JavaScript RegExp. It includes support for additional syntax and flags. While it offers more features overall, it doesn't specifically focus on the `matchAll` functionality but can achieve similar results with its APIs.
This package offers a polyfill for the `RegExp.prototype.exec` method to include match indices in the result objects. It's similar to `string.prototype.matchall` in that it enhances the capabilities of regular expressions in JavaScript, but it focuses on providing match position information rather than iterating over all matches.
Changelog
v4.0.5 - 2021-05-25
node/install instead of node/run; use codecov action a6a7af29532ccceslint, @ljharb/eslint-config, aud, object-inspect 8ea3e71es-abstract, has-symbols e906e75eslint, tape fcf2270ba642c5get-intrinsic directly fca987fprepublishOnly script for npm 7+ 4c5ba45es-abstract 39d34dfcall-bind, es-abstract, internal-slot, regexp.prototype.flags, side-channeleslint, @ljharb/eslint-config, aud, es5-shim, functions-have-names, object-inspect, object.entries, tapees-abstract, side-channel; use call-bind where applicable; remove function-bindeslint, @ljharb/eslint-config, aud, es5-shim, es6-shim, functions-have-names, object-inspect, object.assign, object.entries, tapepull_request_target eventnyc on all testses-shim-api in postlint; use tape runnerinternal-slotside-channel instead of "hidden" helperes-abstract, internal-slot, regexp.prototype.flags, side-channeleslint, @ljharb/eslint-config, tapees-abstract (61% bundle size decrease)es-abstract, has-symbolseslint, @ljharb/eslint-config, functions-have-names, object-inspect, evalmd, object.entries; add safe-publish-latestfunding fieldes-abstractflagsGetter is only used when there is no flags property on the regexRegExp.prototype[Symbol.matchAll]: ToString the flags propertyRegExp.prototype[Symbol.matchAll]es-abstracteslint, @ljharb/eslint-config, evalmd, functions-have-names, es5-shim, es6-shim, object.entries, tapenode v12.11, v11.15, v10.16, v8.16, v6.17functions-have-namesnpx aud instead of npm audit with hoopsdefine-propertieseslint, @ljharb/eslint-config, es5-shim, es6-shim, tapenpm audit instead of nspnode v11.4, v10.14, v8.14, v6.15es-abstracteslint, nsp, object-inspect, tapenode v10.3, v9.11, v8.11, v6.14, v4.9es-abstract, regexp.prototype.flagses5-shim, eslint, object.assignnode v9.4, v8.9, v6.12; pin included builds to LTSReadme
ES2020 spec-compliant shim for String.prototype.matchAll. Invoke its "shim" method to shim String.prototype.matchAll if it is unavailable or noncompliant.
This package implements the es-shim API interface. It works in an ES3-supported environment, and complies with the spec.
Most common usage:
const assert = require('assert');
const matchAll = require('string.prototype.matchall');
const str = 'aabc';
const nonRegexStr = 'ab';
const globalRegex = /[ac]/g;
const nonGlobalRegex = /[bc]/i;
// non-regex arguments are coerced into a global regex
assert.deepEqual(
[...matchAll(str, nonRegexStr)],
[...matchAll(str, new RegExp(nonRegexStr, 'g'))]
);
assert.deepEqual([...matchAll(str, globalRegex)], [
Object.assign(['a'], { index: 0, input: str, groups: undefined }),
Object.assign(['a'], { index: 1, input: str, groups: undefined }),
Object.assign(['c'], { index: 3, input: str, groups: undefined }),
]);
assert.throws(() => matchAll(str, nonGlobalRegex)); // non-global regexes throw
matchAll.shim(); // will be a no-op if not needed
// non-regex arguments are coerced into a global regex
assert.deepEqual(
[...str.matchAll(nonRegexStr)],
[...str.matchAll(new RegExp(nonRegexStr, 'g'))]
);
assert.deepEqual([...str.matchAll(globalRegex)], [
Object.assign(['a'], { index: 0, input: str, groups: undefined }),
Object.assign(['a'], { index: 1, input: str, groups: undefined }),
Object.assign(['c'], { index: 3, input: str, groups: undefined }),
]);
assert.throws(() => matchAll(str, nonGlobalRegex)); // non-global regexes throw
Simply clone the repo, npm install, and run npm test
FAQs
Spec-compliant polyfill for String.prototype.matchAll
The npm package string.prototype.matchall receives a total of 10,731,723 weekly downloads. As such, string.prototype.matchall popularity was classified as popular.
We found that string.prototype.matchall demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.
Security News
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.
Security News
Results from the 2023 State of JavaScript Survey highlight key trends, including Vite's dominance, rising TypeScript adoption, and the enduring popularity of React. Discover more insights on developer preferences and technology usage.