Skip to content

Repository files navigation

Readify LicenseNPM versionBuild StatusCoverage Status

Read directory content with file attributes: size, date, owner, mode and type.

Install

With npm:

npm i readify

API

readify(dir [, options, ])

  • dir - path of a directory
  • options - object can contain:
    • type - type of result, could be "raw"
    • sort - sort by: name, size, date
    • order - "asc" or "desc" for ascending and descending order (default: "asc")

Examples

import{readify}from'readify';const{tryToCatch}=require('try-to-catch');const[error,data]=awaittryToCatch(readify,'/');console.log(data);// output({path: '/',files: [{name: 'readify.js',size: '4.22kb',date: '20.02.2016',owner: 'coderaiser',mode: 'rw- rw- r--',type: 'file',}],});readify('/',{type: 'raw',}).then(console.log);// output({path: '/',files: [{name: 'readify.js',size: 4735,date: '2016-11-21T13:37:55.275Z',owner: 1000,mode: 33_204,type: 'file',}],});readify('/',{type: 'raw',sort: 'size',order: 'desc',}).then(console.log);// output({path: '/',files: [{name: 'readify.js',size: 4735,date: '2016-11-21T13:37:55.275Z',owner: 1000,mode: 33_204,type: 'file',}],});

License

MIT

About

Read directory content with file attributes: size, date, owner, mode

Topics

Resources

Stars

9 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages