# npm-package-walker

> Walks down the local npm package dependency tree and calls a visitor function for each package

Latest version **8.0.11** (published 2025-11-26) · 0BSD license · 0 weekly downloads

## Install

```sh
npm install npm-package-walker
pnpm add npm-package-walker
yarn add npm-package-walker
bun add npm-package-walker
```

## Health

**Score 70/100 (B)** — status: stable.

Positive: has types; esm support; no vulnerabilities; has provenance; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 8.0.11 |
| Published | 2025-11-26 |
| First published | 2017-10-13 |
| Weekly downloads | 0 |
| License | 0BSD |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=22.15.0 |
| Dependencies | 0 |
| Unpacked size | 10.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 4 |
| Maintainers | arlac77 |
| Keywords | dependecy |

## Links

- npm: https://www.npmjs.com/package/npm-package-walker
- Repository: https://github.com/arlac77/npm-package-walker
- Homepage: https://github.com/arlac77/npm-package-walker#readme
- Issues: https://github.com/arlac77/npm-package-walker/issues
- npm.io page: https://npm.io/package/npm-package-walker

## Recent versions

- 8.0.11 (latest) — 2025-11-26
- 8.0.10 — 2025-09-12
- 8.0.9 — 2025-05-08
- 8.0.8 — 2025-05-06
- 8.0.7 — 2025-05-06
- 8.0.6 — 2025-05-06
- 8.0.5 — 2025-05-05
- 8.0.4 — 2025-05-05
- 8.0.3 — 2025-04-28
- 8.0.2 — 2025-04-25
- 8.0.1 — 2025-04-24
- 8.0.0 — 2025-03-02
- 7.0.7 — 2024-09-25
- 7.0.6 — 2024-09-24
- 7.0.5 — 2024-09-23
- … 41 more at https://npm.io/package/npm-package-walker/versions

## README

[![Maintainability](undefined)](undefined)

# npm-package-walker

Walks down the local npm package dependency tree and calls a visitor function
for each package.

<!-- skip-example -->

```js
import { packageWalker } from "npm-package-walker";

async function collectPackageNames() {
  const names = new Set();

  await packageWalker(
    async (pkg, base, modulePath) => {
      names.add(pkg.name);
      return true;
    },
    process.cwd(),
    ["dependencies"]
  );

  return names;
}

collectPackageNames().then(names => console.log(names));
```

# API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

*   [defaultDependencyTypes](#defaultdependencytypes)
*   [packageVisitor](#packagevisitor)
    *   [Parameters](#parameters)
*   [packageWalker](#packagewalker)
    *   [Parameters](#parameters-1)

## defaultDependencyTypes

Dependency types used by default

*   dependencies
*   devDependencies
*   optionalDependencies
*   peerDependencies

## packageVisitor

Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)

### Parameters

*   `package` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** package.json content
*   `directory` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** package base dir
*   `packagePath` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** how deep in the dependency tree are we (starting with 0 for the root package)

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)>** true to continue traversing dependencies of this package

## packageWalker

Walks the local package dependency tree and calls a visitor function.
The visitor function recives the decoded package.json, its directory, and the nesting level starting with 0 for the base package.
Descending the dependency tree continues until the visitor function returns false or no more dependencies
are declared in a package.

### Parameters

*   `visitor` **[packageVisitor](#packagevisitor)** async to be called for each package
*   `base` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** directory where to start crawling package.json (optional, default `process.cwd()`)
*   `dependencyTypes` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** dig into dependency dev and/or prod (optional, default `defaultDependencyTypes`)

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)>** when resolving to true further dig into the dependencies

# install

With [npm](http://npmjs.org) do:

```shell
npm install npm-package-walker
```

# license

BSD-2-Clause

---
_Source: https://npm.io/package/npm-package-walker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
