跳到主要内容
版本号:Next

Interface: Manifest

Represents upstream manifest from another registry

Hierarchy

Properties

_attachments

_attachments: AttachMents

The _attachments object has different usages:

  • When a package is published, it contains the tarball as an string, this string is used to be converted as a tarball, usually attached to the package but not stored in the database.
  • If user runs npm star the _attachments will be at the manifest body but empty.

It has also an internal usage:

  • Used as a cache for the tarball, quick access to the tarball shasum, etc. Instead iterate versions and find the right one, just using the tarball as a key which is what the package manager sends to the registry.

  • A _attachments object is added every time a private tarball is published, upstream cached tarballs are not being part of this object, only for published private packages.

Note: This field is removed when the package is accesed through the web user interface.

Inherited from

PublishManifest._attachments

Defined in

packages/core/types/src/manifest.ts:277


_distfiles

_distfiles: DistFiles

store fast access to the dist url of an specific tarball, instead search version by id, just the tarball id is faster.

The _distfiles is created only when a package is being sync from an upstream. also used to fetch tarballs from upstream, the private publish tarballs are not stored in this object because they are not published in the upstream registry.

Defined in

packages/core/types/src/manifest.ts:209


_id

Optional _id: string

Inherited from

FullRemoteManifest._id

Defined in

packages/core/types/src/manifest.ts:175


_rev

_rev: string

store the revision of the manifest

Overrides

FullRemoteManifest._rev

Defined in

packages/core/types/src/manifest.ts:222


_uplinks: UpLinks

Store access cache metadata, to avoid to fetch the same metadata multiple times.

The key represents the uplink id which is composed of a etag and a fetched timestamp.

The fetched timestamp is the time when the metadata was fetched, used to avoid to fetch the same metadata until the metadata is older than the last fetch.

Defined in

packages/core/types/src/manifest.ts:218


access

Optional access: any

Inherited from

FullRemoteManifest.access

Defined in

packages/core/types/src/manifest.ts:190


author

Optional author: string | Author

Inherited from

FullRemoteManifest.author

Defined in

packages/core/types/src/manifest.ts:196


bugs

Optional bugs: Object

Type declaration

NameType
urlstring

Inherited from

FullRemoteManifest.bugs

Defined in

packages/core/types/src/manifest.ts:191


contributors

Optional contributors: Author[]

Inherited from

FullRemoteManifest.contributors

Defined in

packages/core/types/src/manifest.ts:184


description

Optional description: string

Inherited from

FullRemoteManifest.description

Defined in

packages/core/types/src/manifest.ts:178


dist-tags

dist-tags: GenericBody

Inherited from

FullRemoteManifest.dist-tags

Defined in

packages/core/types/src/manifest.ts:179


homepage

Optional homepage: string

Inherited from

FullRemoteManifest.homepage

Defined in

packages/core/types/src/manifest.ts:193


keywords

Optional keywords: string[]

Inherited from

FullRemoteManifest.keywords

Defined in

packages/core/types/src/manifest.ts:195


license

Optional license: string

Inherited from

FullRemoteManifest.license

Defined in

packages/core/types/src/manifest.ts:192


maintainers

Optional maintainers: Author[]

store owners of this package

Inherited from

FullRemoteManifest.maintainers

Defined in

packages/core/types/src/manifest.ts:183


name

name: string

Inherited from

FullRemoteManifest.name

Defined in

packages/core/types/src/manifest.ts:177


readme

Optional readme: string

store the latest readme *

Inherited from

FullRemoteManifest.readme

Defined in

packages/core/types/src/manifest.ts:186


repository

Optional repository: string | { directory?: string ; type?: string ; url: string }

Inherited from

FullRemoteManifest.repository

Defined in

packages/core/types/src/manifest.ts:194


time

time: GenericBody

Inherited from

FullRemoteManifest.time

Defined in

packages/core/types/src/manifest.ts:180


users

Optional users: PackageUsers

store star assigned to this packages by users

Inherited from

FullRemoteManifest.users

Defined in

packages/core/types/src/manifest.ts:188


versions

versions: Versions

Inherited from

FullRemoteManifest.versions

Defined in

packages/core/types/src/manifest.ts:181