Match-all NPM | npm.io

match-all

Get all the matches for a regular expression in a string.

:cloud: Installation

# Using npm
npm install --save match-all

# Using yarn
yarn add match-all

:clipboard: Example

const matchAll = require("match-all");

let s = "Hello _World_ and _Mars_";
console.log(matchAll(s, /_([a-z]+)_/gi).toArray());
// => [ "World", "Mars" ]

// Get matches one by one
let m = matchAll(s, /_([a-z]+)_/gi);
console.log(m.next());
// => "World"

console.log(m.next());
// => "Mars"

console.log(m.next());
// => null

let multipleGroup = "Hello _World001_ and _World002_";
console.log(matchAll(multipleGroup, /_([a-z]+([0-9]+))_/gi).toArray());
// => [ "World", "Mars" ]

// Get matches one by one
let multipleMatch = matchAll(multipleGroup, /_([a-z]+([0-9]+))_/gi);
console.log(multipleMatch.nextRaw());
// => [..., "World001", "001"]

console.log(multipleMatch.nextRaw());
// => [..., "World002", "002"]

let m2 = matchAll("Hello _World_, _Mars_, _Pluto_ and _Moon_!", /_([a-z]+)_/gi);
console.log(m2.next());
// => "World"

// Reset the match index
m2.reset();

console.log(m2.next());
// => "World"

console.log(m2.next());
// => "Mars"

// Set the match index to 20
m2.reset(20);

console.log(m2.next());
// => "Pluto"

:question: Get Help

There are few ways to get help:

Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
For bug reports and feature requests, open issues. :bug:
For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

`matchAll(s, r)`

Get all the matches for a regular expression in a string.

Params

String s: The input string.
RegExp r: The regular expression.

Return

Object An object containing the following fields:
input (String): The input string.
regex (RegExp): The regular expression.
next (Function): Get the next match.
toArray (Function): Get all the matches.
reset (Function): Reset the index.

`next()`

Get the next match in single group match.

Return

String The matched snippet.

`nextRaw()`

Get the next match in raw regex output. Usefull to get another group match.

Return

Array The matched snippet

`toArray()`

Get all the matches.

Return

Array The matched snippets.

`reset(i)`

Reset the index.

Params

Number i: The new index (default: 0).

Return

Number The new index.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

Starring and sharing the projects you like :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6