npm-api
Advanced tools
Package description
The npm-api package provides a simple interface to interact with the npm registry programmatically. It allows users to fetch information about packages, users, and other entities on the npm registry.
Get Package Information
This feature allows you to fetch detailed information about a specific npm package. In this example, it retrieves information about the 'express' package.
const NpmApi = require('npm-api');
const repo = new NpmApi().repo('express');
repo.package().then(pkg => console.log(pkg));Get User Information
This feature allows you to fetch information about a specific npm user. In this example, it retrieves information about the user 'isaacs'.
const NpmApi = require('npm-api');
const user = new NpmApi().user('isaacs');
user.info().then(info => console.log(info));Search for Packages
This feature allows you to search for packages on the npm registry. In this example, it searches for packages related to 'express'.
const NpmApi = require('npm-api');
const npm = new NpmApi();
npm.search('express').then(results => console.log(results));The npm-registry-fetch package provides a low-level interface to interact with the npm registry. It is more flexible and allows for more customized requests compared to npm-api, but it requires more setup and understanding of the npm registry API.
The package-json package allows you to get metadata of a package from the npm registry. It is simpler and more focused on fetching package information compared to npm-api, which offers a broader range of functionalities.
The npm package itself can be used programmatically to interact with the npm registry. It provides a comprehensive set of features but is more complex to use compared to npm-api, which offers a more streamlined and simplified interface.
Readme
Base class for retrieving data from the npm registry.
Install with npm:
$ npm install npm-api --save
var NpmApi = require('npm-api');
NpmApi constructor. Create an instance to work with maintainer and repository information.
Example
var npm = new NpmApi();
Create a new instance of View or get an existing instance to work with npm couchdb views.
Params
name {String}: Name of the couchdb view to work with.returns {Object} View: instanceExample
var view = npm.view('byUser');
Create a new instance of List or get an existing instance to work with npm couchdb list.
Params
name {String}: Name of the couchdb list to work with.view {String|Object}: Name or instance of a view to work with.returns {Object} List: instanceExample
var list = npm.list('sortCount', 'byUser');
Create an instance of a repo to work with.
Params
name {String}: Name of the repo as it's published to npm.returns {Object}: Instance of a Repo model to work with.Example
var repo = npm.repo('micromatch');
Create an instance of a maintainer to work with.
Params
name {String}: Npm username of the maintainer.returns {Object}: Instance of a Maintainer model to work with.Example
var maintainer = npm.maintainer('doowb');
Base model to include common plugins.
Params
store {Object}: Cache store intance to use.Maintainer constructor. Create an instance of an npm maintainer by maintainer name.
Params
name {String}: Name of the npm maintainer to get information about.store {Object}: Optional cache store instance for caching results. Defaults to a memory store.Example
var maintainer = new Maintainer('doowb');
Get the repositories owned by this maintainer.
returns {Promise}: Returns array of repository names when promise resolves.Example
maintainer.repos()
.then(function(repos) {
console.log(repos);
}, function(err) {
console.error(err);
});
Repo constructor. Create an instance of an npm repo by repo name.
Params
name {String}: Name of the npm repo to get information about.store {Object}: Optional cache store instance for caching results. Defaults to a memory store.Example
var repo = new Repo('micromatch');
Get the repo's published package.json.
returns {Promise}: Returns the package.json object when promise resolves.Example
repo.package()
.then(function(pkg) {
console.log(pkg);
}, function(err) {
console.error(err);
});
Get the repo's published package.json value for the specified version.
Params
version {String}: Specific version to retrieve.returns {Promise}: Returns the package.json object for the specified version when promise resolves.Example
repo.version('0.2.0')
.then(function(pkg) {
console.log(pkg);
}, function(err) {
console.error(err);
});
Get the repo's dependencies for the specified version.
Params
version {String}: Specific version to retrieve. Defaults to latest.returns {Promise}: Returns the dependencies object for the specified version when promise resolves.Example
repo.dependencies()
.then(function(dependencies) {
console.log(dependencies);
}, function(err) {
console.error(err);
});
Get the repo's devDependencies for the specified version.
Params
version {String}: Specific version to retrieve. Defaults to latest.returns {Promise}: Returns the devDependencies object for the specified version when promise resolves.Example
repo.devDependencies()
.then(function(devDependencies) {
console.log(devDependencies);
}, function(err) {
console.error(err);
});
Get the specified property from the repo's package.json for the specified version.
Params
prop {String}: Name of the property to get.version {String}: Specific version to retrieve. Defaults to latest.returns {Promise}: Returns the property for the specified version when promise resolves.Example
repo.prop('author')
.then(function(author) {
console.log(author);
}, function(err) {
console.error(err);
});
View constructor. Create an instance of a view associated with a couchdb view in the npm registry.
Params
name {String}: Name of couchdb view to use.returns {Object}: instance of ViewExample
var view = new View('dependedUpon');
Query the couchdb view with the provided parameters.
Params
params {Object}: URL query parameters to pass along to the couchdb view.returns {Promise}: Results of the query when promise is resolved.Example
view.query({ group_level: 2, startkey: JSON.stringify(['micromatch']), endkey: JSON.stringify(['micromatch', {}])})
.then(function(results) {
console.log(results);
}, function(err) {
console.log(err);
});
Build a formatted url with the provided parameters.
Params
params {Object}: URL query parameters.returns {String}: formatted url stringList constructor. Create an instance of a list associated with a couchdb list in the npm registry.
Params
name {String}: Name of couchdb list to use.view {Object}: Instance of a View to use with the list.returns {Object}: instance of ListExample
var list = new List('dependedUpon', view);
Query the couchdb list with the provided parameters.
Params
params {Object}: URL query parameters to pass along to the couchdb list.returns {Promise}: Results of the query when promise is resolved.Example
list.query({ key: JSON.stringify(['micromatch']) })
.then(function(results) {
console.log(results);
}, function(err) {
console.log(err);
});
Build a formatted url with the provided parameters.
Params
params {Object}: URL query parameters.returns {String}: formatted url stringPull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Generate readme and API documentation with verb:
$ npm install verb && npm run docs
Or, if verb is installed globally:
$ verb
Install dev dependencies:
$ npm install -d && npm test
Brian Woodward
Copyright © 2016 Brian Woodward Released under the MIT license.
This file was generated by verb, v0.9.0, on March 29, 2016.
FAQs
Unknown package
The npm package npm-api receives a total of 193,656 weekly downloads. As such, npm-api popularity was classified as popular.
We found that npm-api demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.