npm-digger v1.2.1

npm-digger

API wrapper and data extractor on NPM packages without any requirements.

Table of content

• npm-digger
  • Table of content
  • Installation
  • Features
  • Usage - Registry - Package - Version - Downloads - User - Search - Provenance - Vulnerabilities

Installation

npm i npm-digger

Features

• No dependencies
• built-in types system
• Built-in management of caching data so it won't make unnecessary requests every time you ask for data in a same class.
• Parsing data that not expose on the official npm API documentations

Usage

npm-digger expose all npm's API data and some more extras from npm's website and internal methods.

The main classes you can use are:

• Registry - basic information on the npm registry and DB
• Package - information on a specific package
• Version - information on a specific version of a package
• Downloads - statistics data on downloads of a specific package
• User - information on npm's users
• Search - results of searching on npm's website
• Provenance - new feature introduced on Apr 23 and gives you a way to link package to its source repo and specific build instructions used to publish it.

Registry

By init the Registry class, you get access to all registry data npm's API is expose in its documentations.

import { Registry } from 'npm-digger'

const registry = new Registry()

const dbName = await registry.dbName()

console.log(dbName)

// console: "registry"

Functionality

Package

By init the Package class, you get access to all data npm's API is expose in its documentations in the package route https://registry.npmjs.org/:package. Also, there is some more information that comes from package page on npm website.

This class includes also the Downloads class (can be imported separately too)

import { Package } from 'npm-digger'

const package = new Package('express')

const description = await package.description()

console.log(description)

// console: "Fast, unopinionated, minimalist web framework"

Params

Functionality

Version

By init the Version class, you get access to all version data npm's API is expose in its documentations. If no version number provided, the latest version will be used.

This class includes also the Provenance class (can be imported separately too)

import { Version } from 'npm-digger'

const version = new Version('express', '4.18.2')

const name = await version.name()

console.log(name)

// console: "express@4.18.2"

Params | Name | Description | Type | Required | | ------ | ------ | ------ | ------ | | packageName | package name | string | yes | | packageVersion | requested version number | string | no |

Functionality

Downloads

By init the Downloads class, you get access to analytics data about the package downloads.

import { Downloads } from 'npm-digger'

const downloads = new Downloads('express')

const pointDownload = await downloads.pointDownload('last-week')

console.log(pointDownload)

// console: 
//      {
//          "downloads": 26951829,
//          "start": "2023-08-10",
//          "end": "2023-08-16",
//          "package": "express"
//      }

Params | Name | Description | Type | Required | | ------ | ------ | ------ | ------ | | packageName | package name | string | yes |

Functionality

User

By init the User class, you get access to all available data exist on npm user page

import { User } from 'npm-digger'

const user = new User('username')

const accountType = await user.accountType()

console.log(accountType)

// console: "user"

Params | Name | Description | Type | Required | | ------ | ------ | ------ | ------ | | username | name of required user data | string | yes |

Functionality

Search

By init the Search class, you get access npm search engine for package searching as define in the npm documentations.

import { Search } from 'npm-digger'

const search = new Search()

const res = await search.searchPackage('express', 5)

Functionality

Params | Name | Description | Type | Required | | ------ | ------ | ------ | ------ | | query | full text search to apply | string | yes | | size | how many results should be returned | number | no | | from | offset to return results from | number | no | | quality | how much of an effect should quality have on search results | number | no | | popularity | how much of an effect should popularity have on search results | number | no | | maintenance | how much of an effect should maintenance have on search results | number | no |

Provenance

Provenance

By init the Provenance class, you get access npm & github provenance data.

import { Provenance } from 'npm-digger'

const provenance = new Provenance()

const res = await provenance.searchPackage('express', 5)

Params | Name | Description | Type | Required | | ------ | ------ | ------ | ------ | | packageName | package name | string | yes | | packageVersion | requested version number | string | yes |

Functionality

Vulnerabilities

By init the Vulnerabilities class, you get access osv data about the package and can search for vulnerabilities. this class uses the osv API to fetch the data.

import { Vulnerabilities } from 'npm-digger'

const vulnerabilities = new Vulnerabilities()

const res = await vulnerabilities.number('express', '3.0.0')

console.log(res)
// 1

Params | Name | Description | Type | Required | | ------ | ------ | ------ | ------ | | packageName | package name | string | yes | | packageVersion | requested version number | string | yes |

Functionality