alejandro.alvarez5 70bb213259 articulo | 3 years ago | |
---|---|---|
.. | ||
out | 3 years ago | |
LICENSE | 3 years ago | |
README.md | 3 years ago | |
package.json | 3 years ago |
List files and directories inside the specified directory.
The package is aimed at obtaining information about entries in the directory.
name
, path
, dirent
and stats
(optional).old
and modern
mode.npm install @nodelib/fs.scandir
import * as fsScandir from '@nodelib/fs.scandir';
fsScandir.scandir('path', (error, stats) => { /* … */ });
Returns an array of plain objects (Entry
) with information about entry for provided path with standard callback-style.
fsScandir.scandir('path', (error, entries) => { /* … */ });
fsScandir.scandir('path', {}, (error, entries) => { /* … */ });
fsScandir.scandir('path', new fsScandir.Settings(), (error, entries) => { /* … */ });
Returns an array of plain objects (Entry
) with information about entry for provided path.
const entries = fsScandir.scandirSync('path');
const entries = fsScandir.scandirSync('path', {});
const entries = fsScandir.scandirSync(('path', new fsScandir.Settings());
true
string | Buffer | URL
A path to a file. If a URL is provided, it must use the file:
protocol.
false
Options | Settings
Settings
classAn Options
object or an instance of Settings
class.
:book: When you pass a plain object, an instance of the
Settings
class will be created automatically. If you plan to call the method frequently, use a pre-created instance of theSettings
class.
A class of full settings of the package.
const settings = new fsScandir.Settings({ followSymbolicLinks: false });
const entries = fsScandir.scandirSync('path', settings);
name
— The name of the entry (unknown.txt
).path
— The path of the entry relative to call directory (root/unknown.txt
).dirent
— An instance of fs.Dirent
class. On Node.js below 10.10 will be emulated by DirentFromStats
class.stats
(optional) — An instance of fs.Stats
class.For example, the scandir
call for tools
directory with one directory inside:
{
dirent: Dirent { name: 'typedoc', /* … */ },
name: 'typedoc',
path: 'tools/typedoc'
}
boolean
false
Adds an instance of fs.Stats
class to the Entry
.
:book: Always use
fs.readdir
without thewithFileTypes
option. ??TODO??
boolean
false
Follow symbolic links or not. Call fs.stat
on symbolic link if true
.
throwErrorOnBrokenSymbolicLink
boolean
true
Throw an error when symbolic link is broken if true
or safely use lstat
call if false
.
pathSegmentSeparator
string
path.sep
By default, this package uses the correct path separator for your OS (\
on Windows, /
on Unix-like systems). But you can set this option to any separator character(s) that you want to use instead.
fs
FileSystemAdapter
By default, the built-in Node.js module (fs
) is used to work with the file system. You can replace any method with your own.
interface FileSystemAdapter {
lstat?: typeof fs.lstat;
stat?: typeof fs.stat;
lstatSync?: typeof fs.lstatSync;
statSync?: typeof fs.statSync;
readdir?: typeof fs.readdir;
readdirSync?: typeof fs.readdirSync;
}
const settings = new fsScandir.Settings({
fs: { lstat: fakeLstat }
});
old
and modern
modeThis package has two modes that are used depending on the environment and parameters of use.
10.10
or when the stats
option is enabledWhen working in the old mode, the directory is read first (fs.readdir
), then the type of entries is determined (fs.lstat
and/or fs.stat
for symbolic links).
stats
option is disabledIn the modern mode, reading the directory (fs.readdir
with the withFileTypes
option) is combined with obtaining information about its entries. An additional call for symbolic links (fs.stat
) is still present.
This mode makes fewer calls to the file system. It’s faster.
See the Releases section of our GitHub project for changelog for each release version.
This software is released under the terms of the MIT license.