npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2025 – Pkg Stats / Ryan Hefner

pnpm-shrinkwrap

v8.1.6

Published

Read/write/prune and other utils for dealing with shrinkwrap.yaml files

Downloads

2,102

Readme

pnpm-shrinkwrap

Read/write/prune and other utils for dealing with shrinkwrap.yaml files

Reads and writes the wanted (shrinkwrap.yaml) and current (node_modules/.shrinkwrap.yaml) shrinkwrap files of pnpm. Shrinkwrap files are the state files of the node_modules installed via pnpm. They are like the package-lock.json of npm or the yarn.lock of Yarn.

Install

npm i pnpm-shrinkwrap

API

readWanted(pkgPath, opts) => Promise<Shrinkwrap>

Alias: read

Reads the shrinkwrap.yaml file from the root of the package.

Arguments

  • pkgPath - Path - the path to the project
  • opts.ignoreIncompatible - Boolean - false by default. If true, throws an error if the shrinkwrap file format is not compatible with the current library.

readCurrent(pkgPath, opts) => Promise<Shrinkwrap>

Alias: readPrivate

Reads the shrinkwrap file from node_modules/.shrinkwrap.yaml.

existsWanted(pkgPath) => Promise<Boolean>

Returns true if a shrinkwrap.yaml exists in the root of the package.

write(pkgPath, wantedShrinkwrap, currentShrinkwrap) => Promise<void>

Writes the wanted/current shrinkwrap files. When they are empty, removes them.

writeWantedOnly(pkgPath, wantedShrinkwrap) => Promise<void>

Writes the wanted shrinkwrap file only. Sometimes it is needed just to update the wanted shrinkwrap without touching node_modules.

writeCurrentOnly(pkgPath, currentShrinkwrap) => Promise<void>

Writes the current shrinkwrap file only. Fails if there is no node_modules directory in the pkgPath.

prune(shrinkwrap, package, warn: (msg: string) => void) => Promise<Shrinkwrap>

Prunes a shrinkwrap file. Prunning means removing packages that are not referenced.

pruneWithoutPackageJson(shrinkwrap, warn: (msg: string) => void) => Promise<Shrinkwrap>

Prunes a shrinkwrap file using only the shrinkwrap object.

nameVerFromPkgSnapshot(relDepPath, pkgSnapshot): {name: string, version: string}

pkgSnapshotToResolution(relDepPath, pkgSnapshot, registry): Resolution

satisfiesPackageJson(shrinkwrap, packageJson): Boolean

Returns true if the shrinkwrap file resolves the dependencies in the package.json.

License

MIT