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