diff options
Diffstat (limited to 'assets/node_modules/execall/readme.md')
-rw-r--r-- | assets/node_modules/execall/readme.md | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/assets/node_modules/execall/readme.md b/assets/node_modules/execall/readme.md new file mode 100644 index 0000000..55c3613 --- /dev/null +++ b/assets/node_modules/execall/readme.md @@ -0,0 +1,62 @@ +# execall [![Build Status](https://travis-ci.org/sindresorhus/execall.svg?branch=master)](https://travis-ci.org/sindresorhus/execall) + +> Find multiple RegExp matches in a string + +Instead of having to iterate over `RegExp#exec`, immutable, and with a nicer result format. + + +## Install + +``` +$ npm install execall +``` + + +## Usage + +```js +const execall = require('execall'); + +execall(/(\d+)/g, '$200 and $400'); +/* +[ + { + match: '200', + subMatches: ['200'], + index: 1 + }, + { + match: '400', + subMatches: ['400'], + index: 10 + } +] +*/ +``` + + +## API + +### execall(regexp, string) + +Returns an `object[]` with a match, sub-matches, and index. + +#### regexp + +Type: `RegExp` + +Regular expression to match against the `string`. + +#### string + +Type: `string` + + +## Related + +- [replace-string](https://github.com/sindresorhus/replace-string) - Replace all substring matches in a string + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) |