UNPKG

2.09 kBSource Map (JSON)View Raw
1{"version":3,"file":"get-raw-packument.esm.js","sources":["../../src/endpoints/get-raw-packument.ts"],"sourcesContent":["import { RawPackument } from '../types/raw-packument';\nimport { assertValidPackageName } from '../utils/assert-valid-package-name';\nimport { fetchFromRegistry } from '../utils/fetch-from-registry';\n\n/**\n * `getRawPackument` returns the packument (package document) containing\n * all the metadata about a package present on the registry.\n *\n * Note: the packument is returned as retrieved from the registry.\n *\n * @param name - package name\n * @param registry - URL of the registry (default: npm registry)\n * @param mirrors - URLs of the registry mirrors (default: npm registry mirrors)\n * @param cached - accept cached responses (default: `true`)\n *\n * @example\n * Get the packument for package `query-registry` from the npm registry:\n *\n * ```typescript\n * import { getRawPackument } from 'query-registry';\n *\n * (async () => {\n * const packument = await getRawPackument({ name: 'query-registry' });\n *\n * // Output: 'query-registry'\n * console.log(packument.name);\n * })();\n * ```\n *\n * @see {@link RawPackument}\n * @see {@link npmRegistry}\n * @see {@link npmRegistryMirrors}\n */\nexport async function getRawPackument({\n name,\n registry,\n mirrors,\n cached,\n}: {\n name: string;\n registry?: string;\n mirrors?: string[];\n cached?: boolean;\n}): Promise<RawPackument> {\n assertValidPackageName({ name });\n\n const endpoint = `/${name}`;\n return fetchFromRegistry({ endpoint, registry, mirrors, cached });\n}\n"],"names":["getRawPackument","name","registry","mirrors","cached","assertValidPackageName","endpoint","fetchFromRegistry"],"mappings":";;;AAIA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BO,eAAeA,eAAf,CAA+B;AAClCC,EAAAA,IADkC;AAElCC,EAAAA,QAFkC;AAGlCC,EAAAA,OAHkC;AAIlCC,EAAAA;AAJkC,CAA/B;AAWHC,EAAAA,sBAAsB,CAAC;AAAEJ,IAAAA;AAAF,GAAD,CAAtB;AAEA,QAAMK,QAAQ,OAAOL,MAArB;AACA,SAAOM,iBAAiB,CAAC;AAAED,IAAAA,QAAF;AAAYJ,IAAAA,QAAZ;AAAsBC,IAAAA,OAAtB;AAA+BC,IAAAA;AAA/B,GAAD,CAAxB;AACH;;;;"}
\No newline at end of file