1 | import { PackageManifest } from '../types/package-manifest';
|
2 | /**
|
3 | * `getPackageManifest` returns the manifest describing
|
4 | * a specific version of a package.
|
5 | *
|
6 | * @param name - package name
|
7 | * @param version - package version (default: `latest`)
|
8 | * @param registry - URL of the registry (default: npm registry)
|
9 | * @param mirrors - URLs of the registry mirrors (default: npm registry mirrors)
|
10 | * @param cached - accept cached responses (default: `true`)
|
11 | *
|
12 | * @example
|
13 | * Get the latest manifest for package `query-registry` from the npm registry:
|
14 | *
|
15 | * ```typescript
|
16 | * import { getPackageManifest } from 'query-registry';
|
17 | *
|
18 | * (async () => {
|
19 | * const manifest = await getPackageManifest({ name: 'query-registry' });
|
20 | *
|
21 | * // Output: 'query-registry'
|
22 | * console.log(manifest.name);
|
23 | * })();
|
24 | * ```
|
25 | *
|
26 | * @example
|
27 | * Get the manifest for package `query-registry@1.0.0` from the npm registry:
|
28 | *
|
29 | * ```typescript
|
30 | * import { getPackageManifest } from 'query-registry';
|
31 | *
|
32 | * (async () => {
|
33 | * const manifest = await getPackageManifest({ name: 'query-registry', version: '1.0.0' });
|
34 | *
|
35 | * // Output: 'query-registry'
|
36 | * console.log(manifest.name);
|
37 | *
|
38 | * // Output: '1.0.0'
|
39 | * console.log(manifest.version);
|
40 | * })();
|
41 | * ```
|
42 | *
|
43 | * @see {@link PackageManifest}
|
44 | * @see {@link RawPackageManifest}
|
45 | * @see {@link npmRegistry}
|
46 | * @see {@link npmRegistryMirrors}
|
47 | */
|
48 | export declare function getPackageManifest({ name, version, registry, mirrors, cached, }: {
|
49 | name: string;
|
50 | version?: string;
|
51 | registry?: string;
|
52 | mirrors?: string[];
|
53 | cached?: boolean;
|
54 | }): Promise<PackageManifest>;
|
55 | //# sourceMappingURL=get-package-manifest.d.ts.map |
\ | No newline at end of file |