Code Monkey home page Code Monkey logo

recursive-dir-reader's Introduction

About

The module will allow you to sync or async get all the paths to the files inside the directory and all its sub-directories.

Installation

npm i recursive-dir-reader

After install, you can require module:

const readdir = require('recursive-dir-reader');

// Code

Usage

For example, we have the following directory structure:

alt text

In the code below, we gave several examples of how to read this directory and all its subdirectories.

const readdir = require('recursive-dir-reader');

// EX 1
readdir.sync('./someDir', path => {
  console.info(path);
});
// ./someDir/someFile1.js
// ./someDir/someFile2.js
// ./someDir/someSubDir/folderWithOneFile/template.html
// ./someDir/someSubDir/someModule1.js
// ./someDir/someSubDir/someModule2.js


// EX 2
readdir.async('./someDir', path => {
  console.info(path);
});
// ./someDir/someFile1.js
// ./someDir/someFile2.js
// ./someDir/someSubDir/someModule1.js
// ./someDir/someSubDir/someModule2.js
// ./someDir/someSubDir/folderWithOneFile/template.html

// EX 3
const filesIntoDirSync = readdir.sync('./someDir');

console.info(filesIntoDirSync);
// [
//   './someDir/someFile1.js',
//   './someDir/someFile2.js',
//   './someDir/someSubDir/folderWithOneFile/template.html',
//   './someDir/someSubDir/someModule1.js',
//   './someDir/someSubDir/someModule2.js'
// ]

// EX 4
const filesIntoDirAsync = readdir.async('./someDir');

setTimeout(() => {
  console.info(filesIntoDirAsync);
}, 1000);
// [
//   './someDir/someFile1.js',
//   './someDir/someFile2.js',
//   './someDir/someSubDir/someModule1.js',
//   './someDir/someSubDir/someModule2.js',
//   './someDir/someSubDir/folderWithOneFile/template.html'
// ]

You can easily combine this methods.

const filesIntoDirAsync = readdir.async('./someDir', path => {
  console.info(path);
});
// ./someDir/someFile1.js
// ./someDir/someFile2.js
// ./someDir/someSubDir/someModule1.js
// ./someDir/someSubDir/someModule2.js
// ./someDir/someSubDir/folderWithOneFile/template.html

setTimeout(() => {
  console.info(filesIntoDirAsync);
}, 1000);
// [
//   './someDir/someFile1.js',
//   './someDir/someFile2.js',
//   './someDir/someSubDir/someModule1.js',
//   './someDir/someSubDir/someModule2.js',
//   './someDir/someSubDir/folderWithOneFile/template.html'
// ]

Help

If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official Discord server.

Although the server was created for Russian speakers, you can also write in English! We will understand you!

recursive-dir-reader's People

Contributors

kiidii avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.