pacote

NOTE: this package is still under heavy development. Please don't use it yet

pacote is a Node.js library for downloading npm-compatible packages. It supports all package specifier syntax that npm install and its ilk support. It transparently caches anything needed to reduce excess operations, using cacache.

Install

$ npm install --save pacote

Table of Contents

• Example
• Features
• Guide
• API
  • manifest
  • extract
  • options

Example

const pacote = require('pacote')

pacote.manifest('pacote@^1', function (err, pkg) {
  console.log('package manifest for registry pkg:', pkg)
  // { "name": "pacote", "version": "1.0.0", ... }
})

pacote.extract('http://hi.com/pkg.tgz', './here', function (err) {
  console.log('remote tarball contents extracted to ./here')
})

Features

• simple interface to common package-related actions.
• supports all package types npm does.
• fast cache
• offline mode
• authentication support (private git, private npm registries, etc)
• npm-compatible for all relevant operations
• github, gitlab, and bitbucket-aware
• version/tag aware when fetching from git repositories.
• caches git repositories

Guide

Introduction

API

> pacote.manifest(spec, [opts], cb)

Fetches the manifest for a package, aka package.json.

Note that depending on the spec type, some additional fields might be present. For example, packages from registry.npmjs.org have additional metadata appended by the registry.

Example

pacote.manifest('pacote@1.0.0', function (err, pkgJson) {
  // fetched `package.json` data from the registry (or cache, if cached)
})

> pacote.extract(spec, destination, [opts], cb)

Extracts package data identified by <spec> into a directory named <destination>, which will be created if it does not already exist.

If opts.digest is provided and the data it identifies is present in the cache, extract will bypass most of its operations and go straight to extracting the tarball.

Example

pacote.extract('pacote@1.0.0', './woot', {
  digest: 'deadbeef'
}, function (err) {
  // Succeeds as long as `pacote@1.0.0` still exists somewhere. Network and
  // other operations are bypassed entirely if `digest` is present in the cache.
})

> options

opts.digest

If provided, pacote will confirm that the relevant shasum for each operation's results matches the given digest. The call will return EBADCHECKSUM if the check fails.

Additionally, pacote.extract will check the cache before performing any other operations.

opts.cache

opts.cacheUid/opts.cacheGid

opts.uid/opts.gid

opts.scope

opts.registry

opts.@somescope:registry

opts.auth

opts.log

Default: silentNpmLog

An npmlog-compatible logger. Will be used to log various events at the levels specified by npmlog.