Interface IPackageMetadata

An interface for a subset of the keys known to be included for package metadata.

See https://github.com/npm/registry/blob/master/docs/responses/package-metadata.md for full specification.

Hierarchy

IPackageMetadata

Index

Properties

Properties

description

description: string

A short description of the package.

dist-tags

dist-tags: { latest: string }

A mapping of dist tags to the versions they point to.

Type declaration

[key: string]: string
latest: string

The version tagged as 'latest'.

modified

modified: string

ISO string of the last time this package was modified.

name

name: string

The package name.

versions

versions: {}

A mapping of semver-compliant version numbers to version data.

Type declaration

[key: string]: { deprecated?: string; description: string; name: string; version: string }
- Optional deprecated?: string
  
  The deprecation warnings message of this version.
- description: string
  
  A short description of the package.
- name: string
  
  The package name.
- version: string
  
  The version string for this version.

Generated using TypeDoc