read-dir-and-stat

1.0.8 • Public • Published

read-dir-and-stat

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

Buy Me A Coffee

Reads the directory files and adds the stat info.

☁️ Installation

# Using npm 
npm install --save read-dir-and-stat
 
# Using yarn 
yarn add read-dir-and-stat

📋 Example

const readDirAndStat = require("read-dir-and-stat");
 
readDirAndStat((err, res) => {
    console.log(res);
});
 
console.log(readDirAndStat.sync());
// =>
// [ { path: '.../read-dir-and-stat/.git',
//     stat:
//      { dev: 16777220,
//        mode: 16877,
//        nlink: 13,
//        uid: 501,
//        gid: 20,
//        rdev: 0,
//        blksize: 4096,
//        ino: 5647152,
//        size: 442,
//        blocks: 0,
//        atime: 2016-07-04T08:37:44.000Z,
//        mtime: 2016-07-04T08:37:44.000Z,
//        ctime: 2016-07-04T08:37:44.000Z,
//        birthtime: 2016-07-04T08:37:44.000Z } },
//   { path: '.../read-dir-and-stat/example',
//     stat:
//      {...} },
//   { path: '.../read-dir-and-stat/lib',
//     stat:
//      {...} },
//   { path: '.../read-dir-and-stat/node_modules',
//     stat:
//      {...} },
//   { path: '.../read-dir-and-stat/package.json',
//     stat:
//      {...} } ]

❓ Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. 🐛
  3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

readDirAndStat(inputPath, cb)

Reads the files/directories and adds the stat information.

Params

  • String inputPath: The directory path.
  • Function cb: The callback function.

sync(inputPath)

The sync version.

Params

  • String inputPath: The directory path.

Return

  • Array An array of objects containing:
  • path (String): The full file/directory path
  • stat (Object): The stat result.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like 🚀

  • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

  • fs-file-tree

📜 License

MIT © Ionică Bizău

Package Sidebar

Install

npm i read-dir-and-stat

Weekly Downloads

2,116

Version

1.0.8

License

MIT

Unpacked Size

8.91 kB

Total Files

4

Last publish

Collaborators

  • ionicabizau