query-registry
Version:
Query the npm registry for packuments, manifests, packages and download counts
57 lines • 1.96 kB
TypeScript
import { DownloadPeriod } from '../types/download-period';
import { PackageDownloads } from '../types/downloads';
/**
* `getPackageDownloads` returns the number of downloads for a package
* in a given time period.
*
* @param name - package name
* @param period - time period in which downloads happened (default: `last-week`)
* @param registryDownloadsAPI - URL of the registry's downloads API (default: npm registry)
* @param cached - accept cached responses (default: `true`)
*
* @example
* Get the weekly downloads for package `query-registry` from the npm registry:
*
* ```typescript
* import { getPackageDownloads } from 'query-registry';
*
* (async () => {
* const downloads = await getPackageDownloads({ name: 'query-registry' });
*
* // Output: 'query-registry'
* console.log(downloads.package);
*
* // Output: 'number'
* console.log(typeof downloads.downloads);
* })();
* ```
*
* @example
* Get the monthly downloads for package `query-registry` from the npm registry:
*
* ```typescript
* import { getPackageDownloads } from 'query-registry';
*
* (async () => {
* const downloads = await getPackageDownloads({ name: 'query-registry', period: 'last-month' });
*
* // Output: 'query-registry'
* console.log(downloads.package);
*
* // Output: 'number'
* console.log(typeof downloads.downloads);
* })();
* ```
*
* @see {@link PackageDownloads}
* @see {@link DownloadPeriod}
* @see {@link npmRegistryDownloadsAPI}
* @see {@link https://github.com/npm/registry/blob/master/docs/download-counts.md#point-values}
*/
export declare function getPackageDownloads({ name, period: rawDownloadPeriod, registryDownloadsAPI, cached, }: {
name: string;
period?: DownloadPeriod;
registryDownloadsAPI?: string;
cached?: boolean;
}): Promise<PackageDownloads>;
//# sourceMappingURL=get-package-downloads.d.ts.map