Site-wide navigation
query-registry

Modules

Classes

FetchError

Functions

getAbbreviatedPackumentgetDailyPackageDownloadsgetDailyRegistryDownloadsgetPackageDownloadsgetPackageManifestgetPackumentgetRawAbbreviatedPackumentgetRawPackageManifestgetRawPackumentgetRegistryDownloadsgetRegistryMetadatasearchPackages

Interfaces

AbbreviatedPackumentBugTrackerDailyPackageDownloadsDailyRegistryDownloadsDateRangeDistInfoDistTagsDownloadsPerDayGitRepositoryNpmOperationalInternalPackageDownloadsPackageFlagsPackageJSONPackageLinksPackageManifestPackageSearchResultPackumentPersonRawAbbreviatedPackumentRawPackageManifestRawPackumentRegistryDownloadsRegistryMetadataRegistryMetadataOtherRegistryMetadataSizesRepositorySearchCriteriaSearchResultSearchResultsSearchScoreSearchScoreDetailVersionsToTimestamps

Constants

InvalidPackageNameErrorInvalidPackageVersionErrorcloudflareRegistrynpmRegistrynpmRegistryDownloadsAPInpmRegistryMirrorsyarnRegistry
async function

getPackument

(__namedParameters,[object Object]): Promise<Packument>
getPackument returns the packument (package document) containing all the metadata about a package present on the registry.

Examples

Get the packument for package query-registry from the npm registry:
import { getPackument } from 'query-registry';

(async () => {
    const packument = await getPackument({ name: 'query-registry' });

    // Output: 'query-registry'
    console.log(packument.name);
})();