> For the complete documentation index, see [llms.txt](https://regex-simplify.lacostar.fr/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://regex-simplify.lacostar.fr/installation-and-establishment.md).

# Installation and establishment

#### You can simply install the dependency to your project with Npm:

```shell
npm install regex-simplify
```

#### Or with yarn:

```shell
yarn add regex-simplify
```

#### Import the module in your code

```javascript
// ES6 (includes typings)
import regex from 'regex-simplify';

// CommonJS
const regex = require('regex-simplify');
```

:warning: **All functions returns this object:**

```typescript
{
    include: true | false, // If the string matched with the regex
    matchs: RegExpMatchArray | null, // An array of all match
    groups: Array<Object | null> | null, // An array of all groups for get parts of the matched string
}
```