https://github.com/waitingsong/node-rxwalker
https://github.com/waitingsong/node-rxwalker
fs readdir rxjs walker
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/waitingsong/node-rxwalker
- Owner: waitingsong
- License: mit
- Created: 2018-07-08T09:36:35.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-03-16T11:09:35.000Z (over 2 years ago)
- Last Synced: 2025-08-17T14:24:27.188Z (10 months ago)
- Topics: fs, readdir, rxjs, walker
- Language: TypeScript
- Size: 531 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# [rxwalker](https://waitingsong.github.io/node-rxwalker/)
A reactive nodejs directory walker. More flexible control via filename and recursive depth.
[](https://www.npmjs.com/package/rxwalker)
[](https://opensource.org/licenses/MIT)
[]()
[](https://github.com/waitingsong/node-rxwalker/actions?query=workflow%3A%22ci%22)
[](https://ci.appveyor.com/project/waitingsong/node-rxwalker/branch/master)
[](https://codecov.io/gh/waitingsong/node-rxwalker)
[](https://conventionalcommits.org)
## Installing
```powershell
npm install --save rxwalker
```
## Usage
```js
// js
const walk = require('rxwalker').walk
walk('').subscribe(
data => console.info(data),
)
```
```ts
// es6 or typescript
import { walk } from 'rxwalker'
walk('').subscribe(
data => console.info(data),
)
```
```ts
import { walk, EntryType } from 'rxwalker'
const maxDepth = 7 // <--- walk with maxDepth
let dirCount = 0
let fileCount = 0
let linkCount = 0
let entryCount = 0
walk('', { maxDepth }).subscribe(
data => {
switch (data.type) {
case EntryType.dir:
console.info('got a dir', data)
dirCount += 1
entryCount += 1
break
case EntryType.file:
console.info('got a file', data)
fileCount += 1
entryCount += 1
break
case EntryType.link:
console.info('got a symbolicLink', data)
linkCount += 1
// entryCount += 1
break
case EntryType.noAcessPermission:
console.info('got a entry without access permission', data)
entryCount += 1
break
case EntryType.unknown:
console.info('got a unknow entry', data)
break
case EntryType.notExist:
console.error('entry not exists:', data.path)
break
}
},
err => console.error(err),
() => {
console.info(`count result dirs: ${dirCount}, files: ${fileCount}, links: ${linkCount}, entries: ${entryCount} `)
},
)
```
```ts
import { walk, DirFilterCbParams, DirFilterCbRet, EntryType } from 'rxwalker'
let dirCount = 0
let fileCount = 0
let linkCount = 0
let entryCount = 0
const dirFilterCb = ({ files }: DirFilterCbParams): DirFilterCbRet => {
return files.filter(file => {
return file.includes('a') ? true : false // <--- filter filename/dirname
})
}
walk('', { dirFilterCb }).subscribe(
data => {
switch (data.type) {
case EntryType.dir:
console.info('got a dir', data)
dirCount += 1
entryCount += 1
break
case EntryType.file:
console.info('got a file', data)
fileCount += 1
entryCount += 1
break
case EntryType.link:
console.info('got a symbolicLink', data)
linkCount += 1
// entryCount += 1
break
case EntryType.noAcessPermission:
console.info('got a entry without access permission', data)
entryCount += 1
break
case EntryType.unknown:
console.info('got a unknow entry', data)
break
case EntryType.notExist:
console.error('entry not exists:', data.path)
break
}
},
err => console.error(err),
() => {
console.info(`count result dirs: ${dirCount}, files: ${fileCount}, links: ${linkCount}, entries: ${entryCount} `)
},
)
```
```ts
// stop running walker conditionally
import { walk } from 'rxwalker'
const sub = walk('').subscribe(
data => {
if (data.path.includes('a')) {
sub.unsubscribe()
console.log('stopped with:', data)
}
else {
console.log(data)
}
}
)
```
```ts
// no follow symbol link
import { walk } from 'rxwalker'
walk('', { followLink: false }).subscribe(
data => console.log(data),
)
```
## Demo
- [Demos from test](https://github.com/waitingsong/node-rxwalker/blob/master/test/20_index.test.ts)
## License
[MIT](LICENSE)
### Languages
- [English](README.md)
- [中文](README.zh-CN.md)