Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
.gitignore
LICENSE
README.md
index.js
package.json

README.md

npm-registry-client

The code that npm uses to talk to the registry.

It handles all the caching and HTTP calls.

Usage

var RegClient = require('npm-registry-client')
var client = new RegClient(config)
var uri = "npm://registry.npmjs.org/npm"
var options = {timeout: 1000}

client.get(uri, options, function (error, data, raw, res) {
  // error is an error if there was a problem.
  // data is the parsed data object
  // raw is the json string
  // res is the response from couch
})

Registry URLs

The registry calls take either a full URL pointing to a resource in the registry, or a base URL for the registry as a whole (for the base URL, any path will be ignored). In addition to http and https, npm URLs are allowed. npm URLs are https URLs with the additional restrictions that they will always include authorization credentials, and the response is always registry metadata (and not tarballs or other attachments).

Configuration

This program is designed to work with npmconf, but you can also pass in a plain-jane object with the appropriate configs, and it'll shim it for you. Any configuration thingie that has get/set/del methods will also be accepted.

  • cache Required {String} Path to the cache folder
  • always-auth {Boolean} Auth even for GET requests.
  • auth {String} A base64-encoded username:password
  • email {String} User's email address
  • tag {String} The default tag to use when publishing new packages. Default = "latest"
  • ca {String} Cerficate signing authority certificates to trust.
  • cert {String} Client certificate (PEM encoded). Enable access to servers that require client certificates
  • key {String} Private key (PEM encoded) for client certificate 'cert'
  • strict-ssl {Boolean} Whether or not to be strict with SSL certificates. Default = true
  • user-agent {String} User agent header to send. Default = "node/{process.version} {process.platform} {process.arch}"
  • log {Object} The logger to use. Defaults to require("npmlog") if that works, otherwise logs are disabled.
  • fetch-retries {Number} Number of times to retry on GET failures. Default=2
  • fetch-retry-factor {Number} factor setting for node-retry. Default=10
  • fetch-retry-mintimeout {Number} minTimeout setting for node-retry. Default=10000 (10 seconds)
  • fetch-retry-maxtimeout {Number} maxTimeout setting for node-retry. Default=60000 (60 seconds)
  • proxy {URL} The url to proxy requests through.
  • https-proxy {URL} The url to proxy https requests through. Defaults to be the same as proxy if unset.
  • _auth {String} The base64-encoded authorization header.
  • username _password {String} Username/password to use to generate _auth if not supplied.
  • _token {Object} A token for use with couch-login

client.request(method, uri, options, cb)

  • method {String} HTTP method
  • uri {String} URI pointing to the resource to request
  • options {Object} Object containing optional per-request properties.
    • what {Stream | Buffer | String | Object} The request body. Objects that are not Buffers or Streams are encoded as JSON.
    • etag {String} The cached ETag
    • follow {Boolean} Follow 302/301 responses (defaults to true)
  • cb {Function}
    • error {Error | null}
    • data {Object} the parsed data object
    • raw {String} the json
    • res {Response Object} response from couch

Make a request to the registry. All the other methods are wrappers around request.

client.adduser(base, username, password, email, cb)

  • base {String} Base registry URL
  • username {String}
  • password {String}
  • email {String}
  • cb {Function}

Add a user account to the registry, or verify the credentials.

client.deprecate(uri, version, message, cb)

  • uri {String} Full registry URI for the deprecated package
  • version {String} Semver version range
  • message {String} The message to use as a deprecation warning
  • cb {Function}

Deprecate a version of a package in the registry.

client.bugs(uri, cb)

  • uri {String} Full registry URI for the package
  • cb {Function}

Get the url for bugs of a package

client.get(uri, options, cb)

  • uri {String} The complete registry URI to fetch
  • options {Object} Object containing optional per-request properties.
    • timeout {Number} Duration before the request times out.
    • follow {Boolean} Follow 302/301 responses (defaults to true)
    • staleOk {Boolean} If there's cached data available, then return that to the callback quickly, and update the cache the background.

Fetches data from the registry via a GET request, saving it in the cache folder with the ETag.

client.publish(uri, data, tarball, cb)

  • uri {String} The registry URI to publish to
  • data {Object} Package data
  • tarball {String | Stream} Filename or stream of the package tarball
  • cb {Function}

Publish a package to the registry.

Note that this does not create the tarball from a folder. However, it can accept a gzipped tar stream or a filename to a tarball.

client.star(uri, starred, cb)

  • uri {String} The complete registry URI to star
  • starred {Boolean} True to star the package, false to unstar it.
  • cb {Function}

Star or unstar a package.

Note that the user does not have to be the package owner to star or unstar a package, though other writes do require that the user be the package owner.

client.stars(base, username, cb)

  • base {String} The base URL for the registry
  • username {String} Name of user to fetch starred packages for.
  • cb {Function}

View your own or another user's starred packages.

client.tag(uri, version, tag, cb)

  • uri {String} The complete registry URI to tag
  • version {String} Version to tag
  • tag {String} Tag name to apply
  • cb {Function}

Mark a version in the dist-tags hash, so that pkg@tag will fetch the specified version.

client.unpublish(uri, [ver], cb)

  • uri {String} The complete registry URI to unpublish
  • ver {String} version to unpublish. Leave blank to unpublish all versions.
  • cb {Function}

Remove a version of a package (or all versions) from the registry. When the last version us unpublished, the entire document is removed from the database.

client.upload(uri, file, [etag], [nofollow], cb)

  • uri {String} The complete registry URI to upload to
  • file {String | Stream} Either the filename or a readable stream
  • etag {String} Cache ETag
  • nofollow {Boolean} Do not follow 301/302 responses
  • cb {Function}

Upload an attachment. Mostly used by client.publish().

Something went wrong with that request. Please try again.