Parrier NPM | npm.io

Welcome to parrier

GitHub package.json version

This is a package that lists everything inside the provided "path" (or the full tree structure if "recurse" is set), asynchronously.

Gif showing software working

Homepage

Demo

Welcome to parrier Prerequisites Install Usage Async / await example Promise example Run tests Author Contributing References Show your support * License

Prerequisites

node: >=8.0.0
npm: >=5.0.0

Install

npm install parrier

Usage

Async / await example

/**
 * Async / await
 */

const parrier = require('parrier');
// import parrier from 'parrier'; // for typescript

const path = './example-folder/';

(() => {
  try {
    async () => {
      const folderContent = await parrier(path);
      console.log(folderContent); // logs an array of IFile

      // IFile is a typescript interface (of this package)
      // that represents the file object (including
      // file.name, file.extension, file.isFile, etc...)
      // refer to API to know more
    };
  } catch (err) {
    console.log(err.message);
  }
})();

Promise example

/**
 * Promise
 */

const parrier = require('parrier');
// import parrier from 'parrier'; // for typescript

const path = './example-folder/';

parrier(path)
  .then((folderContent) => console.log(folderContent))
  .catch((err) => console.log(err.message));