1 | import { DownloadPeriod } from '../types/download-period';
|
2 | import { PackageDownloads } from '../types/downloads';
|
3 | /**
|
4 | * `getPackageDownloads` returns the number of downloads for a package
|
5 | * in a given time period.
|
6 | *
|
7 | * @param name - package name
|
8 | * @param period - time period in which downloads happened (default: `last-week`)
|
9 | * @param registryDownloadsAPI - URL of the registry's downloads API (default: npm registry)
|
10 | * @param cached - accept cached responses (default: `true`)
|
11 | *
|
12 | * @example
|
13 | * Get the weekly downloads for package `query-registry` from the npm registry:
|
14 | *
|
15 | * ```typescript
|
16 | * import { getPackageDownloads } from 'query-registry';
|
17 | *
|
18 | * (async () => {
|
19 | * const downloads = await getPackageDownloads({ name: 'query-registry' });
|
20 | *
|
21 | * // Output: 'query-registry'
|
22 | * console.log(downloads.package);
|
23 | *
|
24 | * // Output: 'number'
|
25 | * console.log(typeof downloads.downloads);
|
26 | * })();
|
27 | * ```
|
28 | *
|
29 | * @example
|
30 | * Get the monthly downloads for package `query-registry` from the npm registry:
|
31 | *
|
32 | * ```typescript
|
33 | * import { getPackageDownloads } from 'query-registry';
|
34 | *
|
35 | * (async () => {
|
36 | * const downloads = await getPackageDownloads({ name: 'query-registry', period: 'last-month' });
|
37 | *
|
38 | * // Output: 'query-registry'
|
39 | * console.log(downloads.package);
|
40 | *
|
41 | * // Output: 'number'
|
42 | * console.log(typeof downloads.downloads);
|
43 | * })();
|
44 | * ```
|
45 | *
|
46 | * @see {@link PackageDownloads}
|
47 | * @see {@link DownloadPeriod}
|
48 | * @see {@link npmRegistryDownloadsAPI}
|
49 | * @see {@link https://github.com/npm/registry/blob/master/docs/download-counts.md#point-values}
|
50 | */
|
51 | export declare function getPackageDownloads({ name, period: rawDownloadPeriod, registryDownloadsAPI, cached, }: {
|
52 | name: string;
|
53 | period?: DownloadPeriod;
|
54 | registryDownloadsAPI?: string;
|
55 | cached?: boolean;
|
56 | }): Promise<PackageDownloads>;
|
57 | //# sourceMappingURL=get-package-downloads.d.ts.map |
\ | No newline at end of file |