# regex-easy

> simple regular expression utility for node

Latest version **1.0.19** (published 2022-11-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install regex-easy
pnpm add regex-easy
yarn add regex-easy
bun add regex-easy
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.19 |
| Published | 2022-11-07 |
| First published | 2018-08-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | sameer saini |
| Maintainers | sameersaini |
| Keywords | regex, regular expression |

## Links

- npm: https://www.npmjs.com/package/regex-easy
- Repository: https://github.com/sameersaini/easy-regex
- Homepage: https://github.com/sameersaini/easy-regex#readme
- Issues: https://github.com/sameersaini/easy-regex/issues
- npm.io page: https://npm.io/package/regex-easy

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [mocha](https://npm.io/package/mocha.md) ^10.1.0
- [eslint](https://npm.io/package/eslint.md) ^5.4.0
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.14.0
- [eslint-config-airbnb-base](https://npm.io/package/eslint-config-airbnb-base.md) ^13.1.0

## Recent versions

- 1.0.19 (latest) — 2022-11-07
- 1.0.18 — 2018-08-24
- 1.0.17 — 2018-08-23
- 1.0.16 — 2018-08-23
- 1.0.15 — 2018-08-23
- 1.0.14 — 2018-08-21
- 1.0.13 — 2018-08-21
- 1.0.12 — 2018-08-21
- 1.0.10 — 2018-08-21
- 1.0.9 — 2018-08-19
- 1.0.8 — 2018-08-19
- 1.0.7 — 2018-08-19
- 1.0.6 — 2018-08-19
- 1.0.5 — 2018-08-19
- 1.0.4 — 2018-08-19
- … 4 more at https://npm.io/package/regex-easy/versions

## README

## Simple and easy regular expression utility for node

Using npm:
```shell
$ npm i -g npm
$ npm i --save regex-easy
```
In Node.js:
```js
// Load the package
let re = require('regex-easy');
```

Usage
* Regular expression usage
```js
let r = new re.regex(pattern[string], flags[optional|string], escape[optional|boolean]);

// Methods
r.exec(string) //executes a search for a match in a string. It returns an array of information or null on a mismatch.

r.test(string) // method that tests for a match in a string. It returns true or false.
```

* Independent Methods
```js
re.escape(string); // Escaping user input that is to be treated as a literal string within a regular expression—that would otherwise be mistaken for a special character
```

### To read more about regular expressions

* [Mozilla Documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions)
* [Eloquent Javascript](https://eloquentjavascript.net/09_regexp.html)
* [Codeburst](https://codeburst.io/an-introduction-to-regular-expressions-regex-in-javascript-1d3559e7ac9a)
* [Awesome Collection of Resources](https://github.com/aloisdg/awesome-regex)

## About

<details>
<summary><strong>Contributing</strong></summary>

Pull requests are always welcome. For bugs and feature requests, [please create an issue](https://github.com/sameersaini/easy-regex/issues/new).

</details>

<details>
<summary><strong>Running Tests</strong></summary>

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

```sh
$ npm i --save regex-easy && cd node_modules/regex-easy/ && npm test && cd ../../
```

</details>

### Author

**Sameer Saini**

Let's connect

* [LinkedIn Profile](https://www.linkedin.com/in/sameer-saini-65463079/)
* [GitHub Profile](https://github.com/sameersaini)

---
_Source: https://npm.io/package/regex-easy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._