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 🙏

© 2024 – Pkg Stats / Ryan Hefner

fs-readdirp

v1.0.0

Published

simple readdirp with filter and sync/async version

Downloads

5

Readme

simple readdirp with filter and sync/async version

Features

  • just traverse the file path, not the content of file
  • readdirpSync for sync usecase

Usage

readdirpSync(dir, [filter])

sync to read the dir. the result is an array, which contains the file path(no filter param) or the filter return

  • dir: the start directory, which will not include in the result
  • filter: the filter function filter(filePath, stats).
    • filePath is the full path for the sub dir or file.
    • stats is the lstat return
    • the return value will be pushed at the result. if you return false, then this file will be ignored

readdirp(dir, filter, done)

async to read the dir.

  • filter: filter(filePath, stats, [callback]).
    • callback: callback(err, ret). if no callback, then the return will be used in the result. otherwise, callback's ret parameter will be used in the result. if the ret param's value is false, the file will be ignored
  • done: when finished, done is called. done(err, results)
var readdirp = require('fs-readdirp').readdirp;
var readdirpSync = require('fs-readdirp').readdirpSync;

//read current directory's sub file path(absolute path)
var files = readdirpSync('.');


//read current directory's sub file relative path
var files = readdirpSync('.', function(filePath, stats){
  return require('path').relative('.', filePath);
});

//ignore all directory, only its files
var files = readdirpSync('.', function(filePath, stats){
  if(stats.isDirectory()) return false;
  return require('path').relative('.', filePath);
});

//async with no-callback filter: filter is sync
readdirp('.', function(filePath, stats){
  if(stats.isDirectory()) return false;
  return require('path').relative('.', filePath);
}, function(err, files){

});

//async with callback filter: filter is async
readdirp('.', function(filePath, stats, cb){
  if(stats.isDirectory()) cb(null, false);
  else cb(null, require('path').relative('.', filePath));
}, function(err, files){

});

License :

Licensed under MIT

Copyright (c) 2015 kiliwalk