1 | # Installation
|
2 | > `npm install --save @types/validate-npm-package-name`
|
3 |
|
4 | # Summary
|
5 | This package contains type definitions for validate-npm-package-name (https://github.com/npm/validate-npm-package-name).
|
6 |
|
7 | # Details
|
8 | Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/validate-npm-package-name.
|
9 | ## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/validate-npm-package-name/index.d.ts)
|
10 | ````ts
|
11 | declare namespace validate {
|
12 | interface Results {
|
13 | validForNewPackages: boolean;
|
14 | validForOldPackages: boolean;
|
15 | errors?: string[] | undefined;
|
16 | warnings?: string[] | undefined;
|
17 | }
|
18 |
|
19 | interface ValidNames extends Results {
|
20 | validForNewPackages: true;
|
21 | validForOldPackages: true;
|
22 | }
|
23 |
|
24 | interface InvalidNames extends Results {
|
25 | validForNewPackages: false;
|
26 | validForOldPackages: false;
|
27 | errors: string[];
|
28 | }
|
29 |
|
30 | interface LegacyNames extends Results {
|
31 | validForNewPackages: false;
|
32 | validForOldPackages: true;
|
33 | warnings: string[];
|
34 | }
|
35 | }
|
36 |
|
37 | declare function validate(name: string): validate.ValidNames | validate.InvalidNames | validate.LegacyNames;
|
38 |
|
39 | export = validate;
|
40 |
|
41 | ````
|
42 |
|
43 | ### Additional Details
|
44 | * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
|
45 | * Dependencies: none
|
46 |
|
47 | # Credits
|
48 | These definitions were written by [Florian Keller](https://github.com/ffflorian), and [Piotr Błażejewicz](https://github.com/peterblazejewicz).
|
49 |
|
\ | No newline at end of file |