# org-regex

> Regular expression for matching npm organization names

Latest version **1.0.0** (published 2019-06-30) · MIT license · 0 weekly downloads

## Install

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

## 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.0 |
| Published | 2019-06-30 |
| First published | 2019-06-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 0 |
| Unpacked size | 3.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Siddharth Doshi |
| Maintainers | sidoshi |
| Keywords | scoped, npm, package, organization, name, regex, regexp, regular, expression |

## Links

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

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2019-06-30

## README

# org-regex [![Build Status](https://travis-ci.org/sidoshi/org-regex.svg?branch=master)](https://travis-ci.org/sidoshi/org-regex)

> Regular expression for matching [npm organizations](https://docs.npmjs.com/orgs/)


## Install

```
$ npm install org-regex
```


## Usage

```js
const orgRegex = require('org-regex');

orgRegex({exact: true}).test('@ava');
//=> true

'foo @ava bar @ava/init'.match(orgRegex());
//=> ['@ava']
```


## API

### orgRegex([options])

Returns a `RegExp` for matching npm organization names.

#### options

Type: `Object`

##### exact

Type: `boolean`<br>
Default: `false` *(Matches any organization package names in a string)*

Only match an exact string. Useful with `RegExp#test()` to check if a string is a scoped package name.


## Related

- [scoped-regex](https://github.com/sindresorhus/scoped-regex) - Check if a string is a scoped npm package name


## License

MIT © [Siddharth Doshi](https://sid.sh)

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