> Check if an NPM package name is taken.
Validates an NPM package name and then checks if a conflicting package exists. Also accounts for [punctuation differences](https://blog.npmjs.org/post/168978377570/new-package-moniker-rules).
## Installation
```bash
yarn add is-name-taken
```
```bash
npm install is-name-taken
```
## API
```ts
import { isTaken, isValid } from "is-name-taken";
// Check if a package name is taken, and if so, return the conflict:
isTaken("ch-alk"); // "chalk"
// If not taken, return false
isTaken("package-that-doesnt-exist"); // false
// If invalid, return true
isTaken("INVALID_NAME"); // true
// Check if a package name is valid
isValid("chalk"); // true
isValid("INVALID_NAME"); // false
```
#### Types:
```ts
import { Options } from "is-name-taken";
type Options = {
/**
* Maximum milliseconds after a sync to avoid re-syncing
*/
maxAge?: number;
/**
* Setting optimistic to true will skip syncing latest packages from NPM.
* This is faster, but may lead to inconsistencies with recently published packages.
*/
optimistic?: boolean;
};
function isValid(name: string): boolean;
function isTaken(name: string, options?: Options): Promise;
```
##
Dependencies
- [all-package-names](https://npmjs.com/package/all-package-names): Get all NPM package names
- [package-name-conflict](https://npmjs.com/package/package-name-conflict): Check if NPM package names conflict
- [validate-npm-package-name](https://npmjs.com/package/validate-npm-package-name): Give me a string and I'll tell you if it's a valid npm package name
##
Dev Dependencies
- [@bconnorwhite/bob](https://npmjs.com/package/@bconnorwhite/bob): Bob builds and watches typescript projects.
- [@types/validate-npm-package-name](https://npmjs.com/package/@types/validate-npm-package-name): TypeScript definitions for validate-npm-package-name
##
License 
[MIT](https://mit-license.org/)
##
## Related Packages
- [package-name-conflict](https://npmjs.com/package/package-name-conflict): Check if NPM package names conflict
- [all-package-names](https://npmjs.com/package/all-package-names): Get all NPM package names.
- [npm-pd](https://npmjs.com/package/npms-pd): A CLI dashboard for NPM publishers
- [npms-io-client](https://npmjs.com/package/npms-io-client): Isomorphic typed client for npms.io
