# @w5/walk

> [‼️]: ✏️README.mdt

Latest version **0.0.1** (published 2023-03-20) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @w5/walk
pnpm add @w5/walk
yarn add @w5/walk
bun add @w5/walk
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2023-03-20 |
| First published | 2023-03-20 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 0 |
| Unpacked size | 3.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | i@wac.tax |
| Maintainers | i-user |

## Links

- npm: https://www.npmjs.com/package/@w5/walk
- Repository: https://github.com/wactax/node
- Homepage: https://github.com/wactax/node/tree/main/walk
- Issues: https://github.com/wactax/node/issues
- npm.io page: https://npm.io/package/@w5/walk

## Recent versions

- 0.0.1 (latest) — 2023-03-20

## README

[‼️]: ✏️README.mdt

# @w5/walk

[test/main.coffee](./test/main.coffee) :

```coffee
#!/usr/bin/env coffee

import walk, {walkRel} from '@w5/walk'
import {dirname} from 'path'

{pathname} = new URL(import.meta.url)

dir = dirname dirname pathname

console.log dir

console.log '> full path'
for await i from walk(dir,(i)=>i.includes 'node_modules')
  console.log i

console.log '\n> relative path'
for await i from walkRel(
  dir
  (i)=>
    ['src','node_modules'].includes i
)
  console.log '\t',i
```

output :

```
/Users/z/wac.tax/node/walk
> full path
/Users/z/wac.tax/node/walk/README.mdt
/Users/z/wac.tax/node/walk/out.txt
/Users/z/wac.tax/node/walk/test/main.coffee
/Users/z/wac.tax/node/walk/dev.sh
/Users/z/wac.tax/node/walk/dist.sh
/Users/z/wac.tax/node/walk/run.sh
/Users/z/wac.tax/node/walk/README.md
/Users/z/wac.tax/node/walk/build.sh
/Users/z/wac.tax/node/walk/package.json
/Users/z/wac.tax/node/walk/lib/index.js
/Users/z/wac.tax/node/walk/src/index.coffee

> relative path
	 README.mdt
	 out.txt
	 test/main.coffee
	 dev.sh
	 dist.sh
	 run.sh
	 README.md
	 build.sh
	 package.json
	 lib/index.js
```

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