jb1905 / npm-get-package-info

📦 Get info about npm package

npm-get-package-info

About

Get info about npm package

Alternatives

• npm-view
• package-info by Alessandro Minoccheri

How to Install

First, install the library in your project by npm:

$ npm install npm-get-package-info

Or Yarn:

$ yarn add npm-get-package-info

Getting Started

Connect the library to the project with ES6 import:

import npmGetPackageInfo from 'npm-get-package-info';

Or CommonJS:

const npmGetPackageInfo = require('npm-get-package-info');

Next use library:

const info = await npmGetPackageInfo({
  // options...
});

Options

Name	Type	Default	Description	Available options
name	string	undefined	Package name	e.g.: react
version	string	undefined	Package version	e.g.: 16.8.0, ~2.1.2, ^4.5.0
parseOutput	boolean	true	Parse results to JSON	Enable true / disable false
info	string[] or string	package.json fields keys	Info about packages to be fetched	e.g.: version, contributors, main etc.

Example

Info for latest React version:

await npmGetPackageInfo({
  name: 'react',
});

Not parsed license and description for latest jQuery version:

await npmGetPackageInfo({
  name: 'jquery',
  parseOutput: false,
  info: ['license', 'description'],
});

Description for Angular v9.0.0:

await npmGetPackageInfo({
  name: 'angular',
  version: '9.0.0',
  info: 'description',
});

License

This project is licensed under the MIT License © 2020-present Jakub Biesiada

npm-get-package-info's Issues

Clean up library logic

Check commit name structure

Test commonjs usage

Add CLI support

Fix output for multiple package versions

Add npm view to alternatives

Fix type when none of values is valid info item

Test on Windows

Update eslint + prettier config (ignore files)

• auto remove unused imports
• require type for type imports
• restrict import orders

Test with yarn

Fix travis build stats

Fix coverage stats

Publish new version

Handle different output when only one info item is passed

Update gitignore, npmignore file

Fix type for custom package.json fields

Autopublish (autochangelog)

Fix travis connection

Fix husky

Export types