https://github.com/artdecocode/mismatch
A JavaScript package to return captured groups of a regular expression as objects in an array.
https://github.com/artdecocode/mismatch
Last synced: 11 months ago
JSON representation
A JavaScript package to return captured groups of a regular expression as objects in an array.
- Host: GitHub
- URL: https://github.com/artdecocode/mismatch
- Owner: artdecocode
- License: mit
- Created: 2018-07-21T03:20:57.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-23T15:08:44.000Z (over 6 years ago)
- Last Synced: 2025-02-08T13:45:40.389Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 55.7 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# mismatch
[](https://npmjs.org/package/mismatch)
`mismatch` is a JavaScript package to return captured groups of a regular expression as objects in an array.
```sh
yarn add mismatch
```
## Table Of Contents
- [Table Of Contents](#table-of-contents)
- [API](#api)
* [`mismatch(re: RegExp, string: string, keys: string[], addPosition?: boolean)`](#mismatchre-regexpstring-stringkeys-stringaddposition-boolean-void)
- [Copyright](#copyright)
## API
The package is available by importing its default function:
```js
import mismatch from 'mismatch'
```
### `mismatch(`
`re: RegExp,`
`string: string,`
`keys: string[],`
`addPosition?: boolean,`
`): void`
The function will attempt to find all matches for a given regular expression in a string using `.replace()` method, construct an object consisting of captured groups based on supplied keys, and return those objects as an array. It has an advantage over iterating over `while(RegExp.exec(string))` pattern because it does not modify the regular expression's `lastIndex` property.
```js
/* yarn example/ */
import mismatch from 'mismatch'
const re = /(\w+)="(.+?)"/g
const string = `
`
const keys = ['attribute', 'value']
const res = mismatch(re, string, keys)
console.log(JSON.stringify(res, null, 2))
```
```json
[
{
"attribute": "crossorigin",
"value": "anonymous"
},
{
"attribute": "src",
"value": "https://static.npmjs.com/commons.js"
},
{
"attribute": "integrity",
"value": "sha512-example/rhb92Zdom+ix+AYtqZ7C1DlLKEA=="
}
]
```
If an optional capturing group was not found, its key will not be included as part of the object. Also, if there are more captured groups than keys, they will also not be included.
```js
/* yarn example/extra.js */
import mismatch from 'mismatch'
const re = /(?: type="(.+?)")?\s+crossorigin="(.+?)"\s+src="(.+?)"/g
const string = `
`
const keys = ['type', 'crossorigin']
const res = mismatch(re, string, keys)
console.log(JSON.stringify(res, null, 2))
```
```json
[
{
"crossorigin": "anonymous"
}
]
```
To additionally add the positions at which the matches was found, the last argument, `addPositions` should be set to _true_.
```js
/* yarn example/ */
import mismatch from 'mismatch'
const re = /(\w+)="(.+?)"/g
const string = `
`
const keys = ['attribute', 'value']
const res = mismatch(re, string, keys, true)
console.log(JSON.stringify(res, null, 2))
```
```json
[
{
"position": 11,
"attribute": "crossorigin",
"value": "anonymous"
},
{
"position": 37,
"attribute": "src",
"value": "https://static.npmjs.com/commons.js"
},
{
"position": 81,
"attribute": "integrity",
"value": "sha512-example/rhb92Zdom+ix+AYtqZ7C1DlLKEA=="
}
]
```
## Copyright
© Art Deco 2019
Tech Nation Visa Sucks
