Installation

npm install --save @types/validate-npm-package-name

Summary

This package contains type definitions for validate-npm-package-name (https://github.com/npm/validate-npm-package-name).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/validate-npm-package-name.

index.d.ts

1declare namespace validate {
2    interface Results {
3        validForNewPackages: boolean;
4        validForOldPackages: boolean;
5        errors?: string[] | undefined;
6        warnings?: string[] | undefined;
7    }
8
9    interface ValidNames extends Results {
10        validForNewPackages: true;
11        validForOldPackages: true;
12    }
13
14    interface InvalidNames extends Results {
15        validForNewPackages: false;
16        validForOldPackages: false;
17        errors: string[];
18    }
19
20    interface LegacyNames extends Results {
21        validForNewPackages: false;
22        validForOldPackages: true;
23        warnings: string[];
24    }
25}
26
27declare function validate(name: string): validate.ValidNames | validate.InvalidNames | validate.LegacyNames;
28
29export = validate;
30

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: none

Credits

These definitions were written by Florian Keller, and Piotr Błażejewicz.