Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

walker

Package Overview
Dependencies
1
Maintainers
1
Versions
11
Issues
File Explorer

Advanced tools

walker

A simple directory tree walker.

    1.0.8latest

Version published
Maintainers
1
Weekly downloads
16,730,019
decreased by-2.26%

Weekly downloads

Readme

Source

walker Build Status

A nodejs directory walker. Broadcasts events for various file types as well as a generic "entry" event for all types and provides the ability to prune directory trees. This shows the entire API; everything is optional:

Walker('/etc/') .filterDir(function(dir, stat) { if (dir === '/etc/pam.d') { console.warn('Skipping /etc/pam.d and children') return false } return true }) .on('entry', function(entry, stat) { console.log('Got entry: ' + entry) }) .on('dir', function(dir, stat) { console.log('Got directory: ' + dir) }) .on('file', function(file, stat) { console.log('Got file: ' + file) }) .on('symlink', function(symlink, stat) { console.log('Got symlink: ' + symlink) }) .on('blockDevice', function(blockDevice, stat) { console.log('Got blockDevice: ' + blockDevice) }) .on('fifo', function(fifo, stat) { console.log('Got fifo: ' + fifo) }) .on('socket', function(socket, stat) { console.log('Got socket: ' + socket) }) .on('characterDevice', function(characterDevice, stat) { console.log('Got characterDevice: ' + characterDevice) }) .on('error', function(er, entry, stat) { console.log('Got error ' + er + ' on entry ' + entry) }) .on('end', function() { console.log('All files traversed.') })

You specify a root directory to walk and optionally specify a function to prune sub-directory trees via the filterDir function. The Walker exposes a number of events, broadcasting various file type events a generic error event and finally the event to signal the end of the process.

Keywords

FAQs

What is walker?

A simple directory tree walker.

Is walker popular?

The npm package walker receives a total of 13,406,814 weekly downloads. As such, walker popularity was classified as popular.

Is walker well maintained?

We found that walker demonstrated a healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.

Last updated on 23 Oct 2021
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc