UNPKG

834 BPlain TextView Raw
1import { DistTags } from './dist-tags';
2import { RawAbbreviatedPackument } from './raw-abbreviated-packument';
3
4/**
5 * `AbbreviatedPackument` represents a packument (package document)
6 * containing only the metadata necessary to install a package.
7 *
8 * @see {@link RawAbbreviatedPackument}
9 */
10export interface AbbreviatedPackument extends RawAbbreviatedPackument {
11 /** Unique package name (for example, `foo` or `@bar/baz`) */
12 readonly id: string;
13
14 /**
15 * Timestamp of when the package was last modified
16 * in ISO 8601 format (for example, `2021-11-23T19:12:24.006Z`);
17 * (alias to `modified`)
18 */
19 readonly modifiedAt: string;
20
21 /**
22 * Mapping of distribution tags to version numbers
23 * (alias to `dist-tags`)
24 *
25 * @see {@link DistTags}
26 */
27 readonly distTags: DistTags;
28}