Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

readify

coderaiser1.1kMIT10.0.1

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

read, file, directory, stat, size, name, date, owner, uid, format

readme

Readify License NPM version Build Status Coverage 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

const readify = require('readify');
const tryToCatch = require('try-to-catch');

const [error, data] = await tryToCatch(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

changelog

2024.08.16, v10.0.1

feature:

  • cba73a1 readify: @cloudcmd/formatify v2.0.0
  • 76b6045 readify: putout v36.0.3
  • a4597a1 readify: eslint v9.9.0
  • 0511e66 readify: c8 v10.1.2

2024.03.29, v10.0.0

feature:

  • 2b6413c readify: drop support of node < 18
  • ff9b38a readify: eslint-plugin-n v16.6.2
  • 300ac78 readify: eslint-plugin-putout v22.5.0
  • 2de9bc7 readify: madrun v10.0.1
  • 53810f6 readify: supertape v10.5.0
  • 943f96a readify: putout v35.7.6
  • f26b1cf readify: nodemon v3.1.0
  • 3e6e321 readify: eslint v8.57.0
  • d92788a readify: c8 v9.1.0

2021.03.01, v9.0.0

feature:

  • feature(readify) add support of archives
  • feature(package) eslint-plugin-putout v7.2.1
  • feature(package) putout v15.4.3
  • feature(package) supertape v5.0.0

2021.01.20, v8.0.1

feature:

  • (package) nicki v6.0.0

2021.01.05, v8.0.0

feature:

  • (package) supertape v4.4.0
  • (package) putout v13.1.2
  • (readify) drop support of node < 14
  • (package) madrun v8.0.0
  • (package) supertape v3.0.0

2020.11.10, v7.0.6

feature:

  • (readdir) function -> arrow function
  • (package) eslint-plugin-putout v6.0.1
  • (package) putout v11.0.5
  • (package) putout v10.0.3
  • (package) eslint-plugin-putout v5.0.1
  • (package) putout v9.1.0
  • (package) madrun v7.0.0
  • (package) @cloudcmd/stub v3.0.0
  • (package) eslint v7.0.0
  • (package) supertape v2.0.1
  • (package) eslint-plugin-putout v4.0.1
  • (package) putout v8.0.0
  • (package) madrun v6.0.0

2020.04.14, v7.0.5

fix:

  • (readify) assign name

2020.04.14, v7.0.4

feature:

  • (package) superstat v2.0.0

2020.02.25, v7.0.3

feature:

  • (package) try-to-catch v3.0.0
  • (package) eslint-plugin-node v11.0.0
  • (package) nyc v15.0.0
  • (package) nodemon v2.0.1
  • (package) madrun v5.0.0
  • (package) eslint-plugin-putout v3.0.0
  • (package) putout v7.0.2
  • (package) madrun v4.1.4

2019.10.17, v7.0.2

feature:

  • (package) nicki v5.0.0

2019.10.16, v7.0.1

feature:

  • (package) try-to-catch v2.0.0

2019.10.11, v7.0.0

feature:

  • (readify) drop support of node < 10

2019.10.11, v6.2.4

feature:

  • (package) shortdate v2.0.0

2019.09.20, v6.2.3

feature:

  • (package) format-io v2.0.0

2019.09.20, v6.2.2

feature:

  • (package) madrun v3.0.5
  • (package) putout v6.1.0
  • (package) eslint-plugin-putout v2.0.0
  • (package) eslint-plugin-node v10.0.0
  • (package) currify v4.0.0
  • (package) eslint v6.0.1

2019.05.18, v6.2.1

fix:

  • (readdir) can not readdir on termux(Android) (#7)

feature:

  • (package) eslint-plugin-node v9.0.1

2019.04.25, v6.2.0

feature:

  • (readify) add superstat

2019.04.25, v6.1.1

fix:

  • (readdify) symbolic link to directory support

feature:

  • (readify) add putout
  • (package) nyc v14.0.0

2018.12.31, v6.1.0

feature:

  • (package) rm: fs-readdir-with-file-types: 3 stat on every file -> 1 stat

2018.12.30, v6.0.4

fix:

  • (tolerant-readdir) isSymbolicLink

2018.12.30, v6.0.3

fix:

  • (tolerant-readdir) readdir

2018.12.30, v6.0.2

fix:

  • (readify) windows EPERM when readdir with file types

feature:

  • (readify) sinon -> stub

2018.11.14, v6.0.1

feature:

  • (package) nicki v4.0.0
  • (package) sinon v7.1.1
  • (package) eslint-plugin-node v8.0.0

2018.10.09, v6.0.0

feature:

  • (package) rm es6-promisify
  • (package) rm execon
  • (package) @cloudcmd/sortify v2.0.0
  • (package) add fs-readdir-with-file-types
  • (package) currify v3.0.0
  • (readify) callback -> promise
  • (readify) drop support of node < 8
  • (package) redrun v7.0.0
  • (package) nyc v13.0.1
  • (package) eslint-plugin-node v7.0.1
  • (package) eslint v5.0.0

2018.06.12, v5.0.6

feature:

  • (package) format-io v1.0.1
  • (package) sinon v6.0.0
  • (package) nyc v12.0.2

2018.05.03, v5.0.5

feature:

  • (package) zames v2.0.0
  • (travis) add node v10
  • (package) sinon v5.0.3
  • (package) redrun v6.0.0
  • (package) rm jscs, jshint
  • (package) eslint-plugin-node v6.0.0

2018.01.31, v5.0.4

feature:

  • (package) es6-promisify v6.0.0
  • (package) add @cloudcmd/formatify

2018.01.30, v5.0.3

feature:

  • (readdir) parseAllStats: rm parse
  • (travis) node_js: 8, 9

2018.01.30, v5.0.2

feature:

  • (readify) add sort from npm
  • (package) sinon v4.0.0
  • (package) coveralls v3.0.0
  • (package) sinon v3.0.0

2017.07.18, v5.0.1

fix:

  • (readify) node v4 support

feature:

  • (gitignore) add package-lock.json

2017.07.14, v5.0.0

feature:

  • (readify) drop support of node version < 4
  • (package) nicki v3.0.0

2017.06.23, v4.1.5

fix:

  • (readify) sort directories by date (#5)

feature:

  • (package) nyc v11.0.2
  • (package) eslint v4.0.0
  • (package) sinon v2.0.0

2017.02.01, v4.1.4

feature:

  • (readify) Object.assign polyfill -> babel transform

2017.01.17, v4.1.3

feature:

  • (package) rm minifyify
  • (package) rm browserify
  • (package) keywords

2017.01.17, v4.1.2

fix:

  • (readify) for old node.js versions without Object.assign

2017.01.16, v4.1.1

fix:

  • (readify) sorting of dot files

2017.01.16, v4.1.0

feature:

  • (readify) add sorting capability (#5)

2017.01.12, v4.0.1

feature:

  • (readify) mv out sorting from readdir

2017.01.11, v4.0.0

feature:

  • (readify) rm Filer support
  • (readify) type -> options.type
  • (readify) readdir: split read and format

2017.01.10, v3.3.1

fix:

  • (readify) sort, rm accents

2017.01.10, v3.3.0

fix:

  • (readify) empty owner when uid = 0

feature:

  • (readify) add accents support
  • (package) nyc v10.0.0

2016.11.23, v3.2.2

feature:

  • (package) currify v2.0.0

2016.11.21, v3.2.1

fix:

  • (readify) raw: return not "dir" but size when directory

feature:

  • (gitignore) add *.swp

2016.11.21, v3.2.0

feature:

  • (package) add eslint
  • (readify) add support of "raw" results

2016.11.16, v3.1.2

feature:

  • (package) nicki v2.0.1

2016.11.16, v3.1.1

feature:

  • (package) ~ -> ^
  • (package) add zames
  • (package) nyc v9.0.1
  • (npmignore) add bower.json
  • (travis) node_js: add 7
  • (travis) node.js v6
  • (readify) exec.with -> currify

2016.10.20, v3.1.0

feature:

  • (readify) Filer: global -> require

2016.10.19, v3.0.0

feature:

  • (readify) es2015-ify
  • (package) nyc v8.1.0
  • (package) redrun v5.0.0
  • (package) nyc v7.0.0
  • (package) redrun v4.0.0
  • (package) npm-run-all -> redrun
  • (package) jscs v3.0.3
  • (package) nyc v6.1.1

2016.02.20, v2.0.2

feature:

  • (package) date: little-endian order

2016.02.20, v2.0.1

feature:

  • (readify) rm shortdate

2016.02.20, v2.0.0

feature:

  • (readify) emptyStat: add mtime
  • (readify) add date support
  • (package) add codestyle
  • (package) add coverage
  • (package) minify v2.0.0

2015.10.25, v1.3.12

feature:

  • (readify) windows.readify -> browserify -s readify

2015.10.23, v1.3.11

fix:

  • (readify) read empty directory

2015.10.22, v1.3.10

feature:

  • (package) add squad

2015.10.22, v1.3.9

feature:

  • (gitignore) add npm-debug.log

2015.10.22, v1.3.8

feature:

  • (npmignore) add
  • (readify) add browserify support
  • (bower) rm
  • (package) scripts: add build, bundle, minify, wisdom

2015.10.21, v1.3.7

feature:

  • (readify) parseStats: simpify

2015.10.21, v1.3.6

feature:

  • (readify) getAllStats files: object -> array

2015.10.20, v1.3.5

feature:

  • (readify) parseStats: rm condition

2015.10.06, v1.3.4

feature:

  • (npmignore) rm

2015.10.06, v1.3.3

feature:

  • (npmignore) rm modules

2015.10.06, v1.3.2

feature:

  • (npmignore) add
  • (package) devDependencies: rm execon

2015.10.06, v1.3.1

fix:

  • (readify) fillJSON: files.sort
  • (readify) changeUIDToName: double call callback

feature:

  • (readify) sort(files) -> files.sort

2015.07.16, v1.3.0

feature:

  • (readify) add ability to work in web browser

2015.06.08, v1.2.0

feature:

  • (package) rm checkup

2015.06.03, v1.1.5

fix:

  • (readify) getAllStats: exec.each -> exec.parallel

2015.06.03, v1.1.4

feature:

  • (execon) v1.2.0

2015.01.15, v1.1.3

feature:

  • (package) execon v1.1.0

2014.12.22, v1.1.2

feature:

  • (package) rm util-io; add checkup, execon

2014.11.20, v1.1.1

feature:

  • (package) nicki v1.2.2
  • (readify) util-io v1.6.3