JSPM

  • Created
  • Published
  • Downloads 702324
  • Score
    100M100P100Q182445F
  • License ISC

Programmatic API for the bits behind npm pack

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (libnpmpack) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    libnpmpack

    npm version license CI - libnpmpack

    libnpmpack is a Node.js library for programmatically packing tarballs from a local directory or from a registry or github spec. If packing from a local source, libnpmpack will also run the prepack and postpack lifecycles.

    Table of Contents

    Example

    const pack = require('libnpmpack')

    Install

    $ npm install libnpmpack

    API

    > pack(spec, [opts]) -> Promise

    Packs a tarball from a local directory or from a registry or github spec and returns a Promise that resolves to the tarball data Buffer, with from, resolved, and integrity fields attached.

    If no options are passed, the tarball file will be saved on the same directory from which pack was called in.

    libnpmpack uses pacote. Most options are passed through directly to that library, so please refer to its own opts documentation for options that can be passed in.

    Examples
    // packs from cwd
    const tarball = await pack()
    
    // packs from a local directory
    const localTar = await pack('/Users/claudiahdz/projects/my-cool-pkg')
    
    // packs from a registry spec
    const registryTar = await pack('abbrev@1.0.3')
    
    // packs from a github spec
    const githubTar = await pack('isaacs/rimraf#PR-192')