# word-regex

> Regular expression for matching words in a string. Support for english, CJK and Cyrillic.

Latest version **0.1.2** (published 2017-03-10) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2017-03-10 |
| First published | 2015-09-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 18 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert, tunnckocore |
| Keywords | count, detect, exec, expression, find, match, regex, regexp, regular, split, test, word, words |

## Links

- npm: https://www.npmjs.com/package/word-regex
- Repository: https://github.com/regexps/word-regex
- Issues: https://github.com/regexps/word-regex/issues
- npm.io page: https://npm.io/package/word-regex

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2017-03-10
- 0.1.1 — 2016-12-07
- 0.1.0 — 2015-09-22

## README

# word-regex [![NPM version](https://img.shields.io/npm/v/word-regex.svg?style=flat)](https://www.npmjs.com/package/word-regex) [![NPM monthly downloads](https://img.shields.io/npm/dm/word-regex.svg?style=flat)](https://npmjs.org/package/word-regex)  [![NPM total downloads](https://img.shields.io/npm/dt/word-regex.svg?style=flat)](https://npmjs.org/package/word-regex) [![Linux Build Status](https://img.shields.io/travis/regexps/word-regex.svg?style=flat&label=Travis)](https://travis-ci.org/regexps/word-regex)

> Regular expression for matching words in a string. Support for english, CJK and Cyrillic.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save word-regex
```

## Usage

```js
var regex = require('word-regex')();

regex.match('match words.');
//=> ['match', 'words']
regex.match('match words, again.');
//=> ['match', 'words', 'again']
```

## About

### Related projects

* [copyright-regex](https://www.npmjs.com/package/copyright-regex): Regex for matching and parsing copyright statements. | [homepage](https://github.com/regexps/copyright-regex "Regex for matching and parsing copyright statements.")
* [is-equal-regex](https://www.npmjs.com/package/is-equal-regex): Returns true if regular expression A is equal to regex B. Compares the expression and… [more](https://github.com/jonschlinkert/is-equal-regex) | [homepage](https://github.com/jonschlinkert/is-equal-regex "Returns true if regular expression A is equal to regex B. Compares the expression and flags.")
* [todo-regex](https://www.npmjs.com/package/todo-regex): Regular expression for matching TODO statements in a string. | [homepage](https://github.com/regexps/todo-regex "Regular expression for matching TODO statements in a string.")
* [whitespace-regex](https://www.npmjs.com/package/whitespace-regex): Regular expression for matching the whitespace in a string. | [homepage](https://github.com/regexps/whitespace-regex "Regular expression for matching the whitespace in a string.")

### Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

### Building docs

_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_

To generate the readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm install -g verb verb-generate-readme && verb
```

### Running tests

Install dev dependencies:

```sh
$ npm install -d && npm test
```

### Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

### License

Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/regexps/word-regex/blob/master/LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on December 07, 2016._

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