is-name-taken

2.0.0 • Public • Published

is-name-taken

npm typescript Coverage Status GitHub stars Twitter Follow

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.

Installation

yarn add is-name-taken
npm install is-name-taken

API

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:

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<string | boolean>;


Dependenciesdependencies


Dev DependenciesDavid


License license

MIT


Related Packages

Package Sidebar

Install

npm i is-name-taken

Weekly Downloads

6,337

Version

2.0.0

License

MIT

Unpacked Size

8.18 kB

Total Files

7

Last publish

Collaborators

  • bconnorwhite