Like `fs.promise.readdir()`, but sorts the result based on `String#localeCompare()`
npm install readdir-sorted
Like fs.promise.readdir() but sorts the result based on String#localeCompare()
``javascript
const readdirSorted = require('readdir-sorted');
(async () => {
await readdirSorted('.'); /* => [
'.editorconfig',
'.gitattributes',
'.gitignore',
'.travis.yml',
'index.js',
'LICENSE',
'package.json',
'README.md',
'test'
] */
})();
`
`
npm install readdir-sorted
`javascript`
const readdirSorted = require('readdir-sorted');
path: string | Buffer | URL (directory path) Object
options: Promise
Return:
It returns a result of fs.promises.readdir() with sorting entries based on String#localeCompare().
#### Options
#### options.encoding and options.withFileTypes
Both will be passed to fs.promises.readdir().
`javascript
(async () => {
await readdirSorted('example');
//=> ['directory', 'file.txt', 'symlink']
await readdirSorted('example', {
encoding: 'base64',
withFileTypes: true
});
/* => [
Dirent { name: 'ZGlyZWN0b3J5', [Symbol(type)]: 2 },
Dirent { name: 'aW5kZXguanM=', [Symbol(type)]: 1 },
Dirent { name: 'c3ltbGluaw==', [Symbol(type)]: 3 }
] */
})();
`
#### Other options
locale property will be passed to the second argument of String#localeCompare(), and the rest will be used in the third argument.
`javascript
(async () => {
await readdirSorted('/path/to/dir');
//=> ['10', '2', 'ä', 'z']
await readdirSorted('/path/to/dir', {
locale: 'sv',
numeric: true
});
//=> ['2', '10', 'z', 'ä']
})();
``
ISC License © 2017 - 2019 Watanabe Shinnosuke