Logo for jsDocs.io

@types/validate-npm-package-name

  • Version 4.0.2
  • Published
  • 4.45 kB
  • No dependencies
  • MIT license

Install

npm i @types/validate-npm-package-name
yarn add @types/validate-npm-package-name
pnpm add @types/validate-npm-package-name

Overview

TypeScript definitions for validate-npm-package-name

Index

Functions

Interfaces

Functions

function validate

validate: (
    name: string
) => validate.ValidNames | validate.InvalidNames | validate.LegacyNames;

    Interfaces

    interface InvalidNames

    interface InvalidNames extends Results {}

      property errors

      errors: string[];

        property validForNewPackages

        validForNewPackages: false;

          property validForOldPackages

          validForOldPackages: false;

            interface LegacyNames

            interface LegacyNames extends Results {}

              property validForNewPackages

              validForNewPackages: false;

                property validForOldPackages

                validForOldPackages: true;

                  property warnings

                  warnings: string[];

                    interface Results

                    interface Results {}

                      property errors

                      errors?: string[] | undefined;

                        property validForNewPackages

                        validForNewPackages: boolean;

                          property validForOldPackages

                          validForOldPackages: boolean;

                            property warnings

                            warnings?: string[] | undefined;

                              interface ValidNames

                              interface ValidNames extends Results {}

                                property validForNewPackages

                                validForNewPackages: true;

                                  property validForOldPackages

                                  validForOldPackages: true;

                                    Package Files (1)

                                    Dependencies (0)

                                    No dependencies.

                                    Dev Dependencies (0)

                                    No dev dependencies.

                                    Peer Dependencies (0)

                                    No peer dependencies.

                                    Badge

                                    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/validate-npm-package-name.

                                    • Markdown
                                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/validate-npm-package-name)
                                    • HTML
                                      <a href="https://www.jsdocs.io/package/@types/validate-npm-package-name"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>