query-registry/dist/endpoints/get-daily-package-downloads.esm.js

Query the npm registry for packuments, manifests, packages and download counts

import { assertValidPackageName } from '../utils/assert-valid-package-name.esm.js';
import { fetchDownloadsFromRegistry } from '../utils/fetch-downloads-from-registry.esm.js';
import { normalizeRawDownloadPeriod } from '../utils/normalize-download-period.esm.js';

/**
 * `getDailyPackageDownloads` returns the number of downloads for a package
 * for each day 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 day by day weekly downloads for package `query-registry` from the npm registry:
 *
 * ```typescript
 * import { getDailyPackageDownloads } from 'query-registry';
 *
 * (async () => {
 *     const downloads = await getDailyPackageDownloads({ name: 'query-registry' });
 *
 *     // Output: 'query-registry'
 *     console.log(downloads.package);
 *
 *     // Output: 'number'
 *     console.log(typeof downloads.downloads[0].downloads);
 * })();
 * ```
 *
 * @example
 * Get the day by day monthly downloads for package `query-registry` from the npm registry:
 *
 * ```typescript
 * import { getDailyPackageDownloads } from 'query-registry';
 *
 * (async () => {
 *     const downloads = await getDailyPackageDownloads({ name: 'query-registry', period: 'last-month' });
 *
 *     // Output: 'query-registry'
 *     console.log(downloads.package);
 *
 *     // Output: 'number'
 *     console.log(typeof downloads.downloads[0].downloads);
 * })();
 * ```
 *
 * @see {@link DailyPackageDownloads}
 * @see {@link DownloadPeriod}
 * @see {@link npmRegistryDownloadsAPI}
 * @see {@link https://github.com/npm/registry/blob/master/docs/download-counts.md#ranges}
 */

async function getDailyPackageDownloads({
  name,
  period: rawDownloadPeriod,
  registryDownloadsAPI,
  cached
}) {
  assertValidPackageName({
    name
  });
  const period = normalizeRawDownloadPeriod({
    rawDownloadPeriod
  });
  const endpoint = `/downloads/range/${period}/${name}`;
  return fetchDownloadsFromRegistry({
    endpoint,
    registryDownloadsAPI,
    cached
  });
}

export { getDailyPackageDownloads };
//# sourceMappingURL=get-daily-package-downloads.esm.js.map