@npm/types
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

@npm/types

Typescript definitions for npm registry endpoints

For example:

import * as npm from '@npm/types';

fetch('https://registry.npmjs.org/cookie')
  .then((res) => res.json())
  .then((obj: npm.Packument) => {
    // `obj` has proper registry types!
  })

Types

Packument

Response type for the https://registry.npmjs.org/:packageName endpoint

PackumentVersion

Response type for the https://registry.npmjs.org/:packageName/:packageVersion endpoint. Also the type of Packument['versions'] entries.

Manifest

Response type for the https://registry.npmjs.org/:packageName endpoint, when made with the 'Accept: application/vnd.npm.install-v1+json' header.

ManifestVersion

Response type for the https://registry.npmjs.org/:packageName/:packageVersion endpoint, when made with the 'Accept: application/vnd.npm.install-v1+json' header. Also the type of Manifest['versions'] entries.

PackageJSON

A "loose" definition of package.json structures.

[!NOTE] This is not an authoritative definition of package.json structures. Rather, it is a best-effort attempt to describe the fields that are de-facto standards for Node.js, npm, and TypeScript development.

Package Sidebar

Install

npm i @npm/types

Weekly Downloads

15,644

Version

2.0.0

License

MIT

Unpacked Size

9.13 kB

Total Files

4

Last publish

Collaborators

  • maitxn
  • shmam
  • kartykp
  • jithinpg
  • reggi
  • karenjli
  • tayvongh
  • navin22
  • dhei
  • tiagonbotelho
  • hashtagchris
  • nishantms
  • feelepxyz.github
  • monishcm
  • jumoel
  • trevrosen
  • fritzy
  • npm
  • npmci
  • saquibkhan
  • gar
  • mylesborins