@visulima/fs
Advanced tools
Human friendly file system utilities for Node.js
Daniel Bannert's open source work is supported by the community on GitHub Sponsors
npm install @visulima/fs
yarn add @visulima/fs
pnpm add @visulima/fs
import { walk } from "@visulima/fs";
const filesAndFolders: string[] = [];
for await (const index of walk(`${__dirname}/fixtures`, {})) {
filesAndFolders.push(index.path);
}
console.log(filesAndFolders);
import { walkSync } from "@visulima/fs";
const filesAndFolders: string[] = [];
for (const index of walkSync(`${__dirname}/fixtures`, {})) {
filesAndFolders.push(index.path);
}
console.log(filesAndFolders);
walk and walkSyncType: string
The directory to start from.
Type: object
Type: number
Default: Infinity
Optional: true
Description: The maximum depth of the file tree to be walked recursively.
Type: boolean
Default: true
Optional: true
Description: Indicates whether file entries should be included or not.
Type: boolean
Default: true
Optional: true
Description: Indicates whether directory entries should be included or not.
Type: boolean
Default: true
Optional: true
Description: Indicates whether symlink entries should be included or not. This option is meaningful only if followSymlinks is set to false.
Type: boolean
Default: false
Optional: true
Description: Indicates whether symlinks should be resolved or not.
Type: string[]
Default: undefined
Optional: true
Description: List of file extensions used to filter entries. If specified, entries without the file extension specified by this option are excluded.
Type: (RegExp | string)[]
Default: undefined
Optional: true
Description: List of regular expression or glob patterns used to filter entries. If specified, entries that do not match the patterns specified by this option are excluded.
Type: (RegExp | string)[]
Default: undefined
Optional: true
Description: List of regular expression or glob patterns used to filter entries. If specified, entries matching the patterns specified by this option are excluded.
Find a file or directory by walking up parent directories.
import { findUp } from "@visulima/fs";
// Returns a Promise for the found path or undefined if it could not be found.
const file = await findUp("package.json");
console.log(file);
Find a file or directory by walking up parent directories.
import { findUpSync } from "@visulima/fs";
// Returns the found path or undefined if it could not be found.
const file = findUpSync("package.json");
console.log(file);
findUp and findUpSyncType: string[] | string | ((directory: PathLike) => PathLike | Promise<PathLike | typeof FIND_UP_STOP> | typeof FIND_UP_STOP)
Sync Type: string[] | string | ((directory: PathLike) => PathLike | typeof FIND_UP_STOP)
The name of the file or directory to find.
If an array is specified, the first item that exists will be returned.
A function that will be called with each directory until it returns a string with the path, which stops the search, or the root directory has been reached and nothing was found. Useful if you want to match files with certain patterns, set of permissions, or other advanced use-cases.
When using async mode, the matcher may optionally be an async or promise-returning function that returns the path.
Type: object
Type: URL | string
Default: process.cwd()
The directory to start from.
Type: string
Default: 'file'
Values: 'file' | 'directory'
The type of path to match.
Type: URL | string
Default: Root directory
A directory path where the search halts if no matches are found before reaching this point.
Type: boolean
Default: true
Allow symbolic links to match if they point to the target file or directory.
Read a file.
import { readFile } from "@visulima/fs";
// Returns a Promise for the file contents.
const file = await readFile("package.json");
console.log(file);
Read a file.
import { readFileSync } from "@visulima/fs";
// Returns the file contents.
const file = readFileSync("package.json");
console.log(file);
readFile and readFileSyncType: string
The path to the file to read.
Type: object
Type: boolean
Default: true
Optional: true
Description: Indicates whether the file contents should be returned as a Buffer or a string.
Type: "brotli" | "gzip" | undefined
Default: undefined
Optional: true
Description: The file compression.
Type: "ascii" | "base64" | "base64url" | "hex" | "latin1" | "ucs-2" | "ucs2" | "utf-8" | "utf-16le" | "utf8" | "utf16le" | undefined
Default: utf8
Optional: true
Type: number | string | undefined
Default: 'r'
Optional: true
Check if a file or directory exists and is accessible.
import { isAccessible } from "@visulima/fs";
// Returns a Promise for the result.
const file = await isAccessible("package.json");
console.log(file);
Check if a file or directory exists and is accessible.
import { isAccessibleSync } from "@visulima/fs";
// Returns the result.
const file = isAccessibleSync("package.json");
console.log(file);
isAccessible and isAccessibleSyncType: string
The path to the file or directory to check.
Type: number
Default: fs.constants.F_OK
Optional: true
Description: The accessibility mode.
Parse JSON with more helpful errors.
import { parseJson, JSONError } from "@visulima/fs/utils";
const json = '{\n\t"foo": true,\n}';
JSON.parse(json);
/*
undefined:3
}
^
SyntaxError: Unexpected token }
*/
parseJson(json);
/*
JSONError: Unexpected token } in JSON at position 16 while parsing near '{ "foo": true,}'
1 | {
2 | "foo": true,
> 3 | }
| ^
*/
parseJson(json, "foo.json");
/*
JSONError: Unexpected token } in JSON at position 16 while parsing near '{ "foo": true,}' in foo.json
1 | {
2 | "foo": true,
> 3 | }
| ^
*/
parseJsonType: string
The JSON string to parse.
Type: Function
Prescribes how the value originally produced by parsing is transformed, before being returned. See JSON.parse docs for more.
Type: string
The filename to use in error messages.
JSONErrorExposed for use in instanceof checks.
Type: string
The filename displayed in the error message.
Type: string
The printable section of the JSON which produces the error.
Error thrown when file already exists.
Errornew AlreadyExistsError(message): AlreadyExistsError
Creates a new instance.
• message: string
The error message.
Error.constructor
packages/fs/src/error/already-exists-error.ts:9
get code(): string
set code(_name): void
• _name: string
string
packages/fs/src/error/already-exists-error.ts:14
get name(): string
set name(_name): void
• _name: string
string
Error.name
packages/fs/src/error/already-exists-error.ts:24
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
• targetObject: object
• constructorOpt?: Function
void
Error.captureStackTrace
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
optional cause: unknown;
Error.cause
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
message: string;
Error.message
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1077
optional stack: string;
Error.stack
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1078
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
• err: Error
• stackTraces: CallSite[]
any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Error.prepareStackTrace
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
static stackTraceLimit: number;
Error.stackTraceLimit
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:29
Error thrown when an operation is not allowed on a directory.
Errornew DirectoryError(message): DirectoryError
Creates a new instance.
• message: string
The error message.
Error.constructor
packages/fs/src/error/directory-error.ts:9
get code(): string
set code(_name): void
• _name: string
string
packages/fs/src/error/directory-error.ts:14
get name(): string
set name(_name): void
• _name: string
string
Error.name
packages/fs/src/error/directory-error.ts:24
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
• targetObject: object
• constructorOpt?: Function
void
Error.captureStackTrace
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
optional cause: unknown;
Error.cause
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
message: string;
Error.message
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1077
optional stack: string;
Error.stack
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1078
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
• err: Error
• stackTraces: CallSite[]
any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Error.prepareStackTrace
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
static stackTraceLimit: number;
Error.stackTraceLimit
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:29
Error thrown when a directory is not empty.
Errornew NotEmptyError(message): NotEmptyError
Creates a new instance.
• message: string
The error message.
Error.constructor
packages/fs/src/error/not-empty-error.ts:9
get code(): string
set code(_name): void
• _name: string
string
packages/fs/src/error/not-empty-error.ts:14
get name(): string
set name(_name): void
• _name: string
string
Error.name
packages/fs/src/error/not-empty-error.ts:24
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
• targetObject: object
• constructorOpt?: Function
void
Error.captureStackTrace
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
optional cause: unknown;
Error.cause
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
message: string;
Error.message
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1077
optional stack: string;
Error.stack
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1078
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
• err: Error
• stackTraces: CallSite[]
any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Error.prepareStackTrace
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
static stackTraceLimit: number;
Error.stackTraceLimit
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:29
Error thrown when a file or directory is not found.
Errornew NotFoundError(message): NotFoundError
Creates a new instance.
• message: string
The error message.
Error.constructor
packages/fs/src/error/not-found-error.ts:9
get code(): string
set code(_name): void
• _name: string
string
packages/fs/src/error/not-found-error.ts:14
get name(): string
set name(_name): void
• _name: string
string
Error.name
packages/fs/src/error/not-found-error.ts:24
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
• targetObject: object
• constructorOpt?: Function
void
Error.captureStackTrace
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
optional cause: unknown;
Error.cause
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
message: string;
Error.message
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1077
optional stack: string;
Error.stack
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1078
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
• err: Error
• stackTraces: CallSite[]
any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Error.prepareStackTrace
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
static stackTraceLimit: number;
Error.stackTraceLimit
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:29
Error thrown when an operation is not permitted.
Errornew PermissionError(message): PermissionError
Creates a new instance.
• message: string
The error message.
Error.constructor
packages/fs/src/error/permission-error.ts:9
get code(): string
set code(_name): void
• _name: string
string
packages/fs/src/error/permission-error.ts:14
get name(): string
set name(_name): void
• _name: string
string
Error.name
packages/fs/src/error/permission-error.ts:24
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
• targetObject: object
• constructorOpt?: Function
void
Error.captureStackTrace
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
optional cause: unknown;
Error.cause
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
message: string;
Error.message
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1077
optional stack: string;
Error.stack
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1078
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
• err: Error
• stackTraces: CallSite[]
any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Error.prepareStackTrace
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
static stackTraceLimit: number;
Error.stackTraceLimit
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:29
Error thrown in walk or walkSync during iteration.
Errornew WalkError(cause, root): WalkError
Constructs a new instance.
• cause: unknown
• root: string
Error.constructor
packages/fs/src/error/walk-error.ts:12
get name(): string
set name(_name): void
• _name: string
string
Error.name
packages/fs/src/error/walk-error.ts:21
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
• targetObject: object
• constructorOpt?: Function
void
Error.captureStackTrace
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
optional cause: unknown;
Error.cause
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
message: string;
Error.message
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1077
root: string;
File path of the root that's being walked.
packages/fs/src/error/walk-error.ts:9
optional stack: string;
Error.stack
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1078
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
• err: Error
• stackTraces: CallSite[]
any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Error.prepareStackTrace
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
static stackTraceLimit: number;
Error.stackTraceLimit
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:29
Re-exports JSONError
function collect(directory, options): Promise<string[]>
• directory: string
• options: WalkOptions = {}
Promise<string[]>
packages/fs/src/find/collect.ts:4
function collectSync(directory, options): string[]
• directory: string
• options: WalkOptions = {}
string[]
packages/fs/src/find/collect-sync.ts:4
function detect(content): "\n" | "\r\n"
Detect the EOL character for string input. Returns null if no newline.
• content: string
"\n" | "\r\n"
function emptyDir(dir, options?): Promise<void>
Ensures that a directory is empty. Deletes directory contents if the directory is not empty. If the directory does not exist, it is created. The directory itself is not deleted.
• dir: string | URL
• options?: EmptyDirOptions
Promise<void>
packages/fs/src/remove/empty-dir.ts:19
function emptyDirSync(dir, options?): void
Ensures that a directory is empty. Deletes directory contents if the directory is not empty. If the directory does not exist, it is created. The directory itself is not deleted.
• dir: string | URL
• options?: EmptyDirOptions
void
packages/fs/src/remove/empty-dir-sync.ts:18
function ensureDir(directory): Promise<void>
Ensures that the directory exists. If the directory structure does not exist, it is created. Like mkdir -p.
• directory: string | URL
Promise<void>
packages/fs/src/ensure/ensure-dir.ts:12
function ensureDirSync(directory): void
Ensures that the directory exists. If the directory structure does not exist, it is created. Like mkdir -p.
• directory: string | URL
void
packages/fs/src/ensure/ensure-dir-sync.ts:12
function ensureFile(filePath): Promise<void>
Ensures that the file exists. If the file that is requested to be created is in directories that do not exist, these directories are created. If the file already exists, it is NOTMODIFIED.
• filePath: string | URL
Promise<void>
packages/fs/src/ensure/ensure-file.ts:16
function ensureFileSync(filePath): void
Ensures that the file exists. If the file that is requested to be created is in directories that do not exist, these directories are created. If the file already exists, it is NOTMODIFIED.
• filePath: string | URL
void
packages/fs/src/ensure/ensure-file-sync.ts:16
function ensureLink(source, destination): Promise<void>
Ensures that the hard link exists. If the directory structure does not exist, it is created.
• source: string | URL
• destination: string | URL
Promise<void>
packages/fs/src/ensure/ensure-link.ts:15
function ensureLinkSync(source, destination): void
Ensures that the hard link exists. If the directory structure does not exist, it is created.
• source: string | URL
• destination: string | URL
void
packages/fs/src/ensure/ensure-link-sync.ts:15
function ensureSymlink(
target,
linkName,
type?): Promise<void>
Ensures that the link exists, and points to a valid file. If the directory structure does not exist, it is created. If the link already exists, it is not modified but error is thrown if it is not point to the given target.
• target: string | URL
the source file path
• linkName: string | URL
the destination link path
• type?: Type
the type of the symlink, or null to use automatic detection
Promise<void>
A void promise that resolves once the link exists.
packages/fs/src/ensure/ensure-symlink.ts:28
function ensureSymlinkSync(
target,
linkName,
type?): void
Ensures that the link exists, and points to a valid file. If the directory structure does not exist, it is created. If the link already exists, it is not modified but error is thrown if it is not point to the given target.
• target: string | URL
the source file path
• linkName: string | URL
the destination link path
• type?: Type
the type of the symlink, or null to use automatic detection
void
A void.
packages/fs/src/ensure/ensure-symlink-sync.ts:28
function findUp(name, options): Promise<string>
• name: FindUpName
• options: FindUpOptions = {}
Promise<string>
packages/fs/src/find/find-up.ts:11
function findUpSync(name, options): string
• name: FindUpNameSync
• options: FindUpOptions = {}
string
packages/fs/src/find/find-up-sync.ts:11
function format(content, eol): string
Format the file to the targeted EOL.
• content: string
• eol: "\n" | "\r\n"
string
function isAccessible(path, mode?): Promise<boolean>
Returns a Promise that resolves to a boolean indicating if the path is accessible or not.
• path: string | URL
• mode?: number
Promise<boolean>
packages/fs/src/is-accessible.ts:9
function isAccessibleSync(path, mode?): boolean
Returns a boolean indicating if the path is accessible or not.
• path: string | URL
• mode?: number
boolean
packages/fs/src/is-accessible-sync.ts:9
function move(
sourcePath,
destinationPath,
options): Promise<void>
Move a file asynchronously.
• sourcePath: string
The file you want to move.
• destinationPath: string
Where you want the file moved.
• options: MoveOptions = {}
Configuration options.
Promise<void>
A Promise that resolves when the file has been moved.
import { moveFile } from '@visulima/fs';
await moveFile('source/test.png', 'destination/test.png');
console.log('The file has been moved');
packages/fs/src/move/index.ts:35
function moveSync(
sourcePath,
destinationPath,
options?): void
Move a file synchronously.
• sourcePath: string
The file you want to move.
• destinationPath: string
Where you want the file moved.
• options?: MoveOptions
Configuration options.
void
Nothing is returned.
import { moveFileSync } from '@visulima/fs';
moveFileSync('source/test.png', 'destination/test.png');
console.log('The file has been moved');
packages/fs/src/move/index.ts:61
function readFile<O>(path, options?): Promise<ContentType<O>>
• O extends ReadFileOptions<"brotli" | "gzip" | "none"> = undefined
• path: string | URL
• options?: O
Promise<ContentType<O>>
packages/fs/src/read/read-file.ts:20
function readFileSync<O>(path, options?): ContentType<O>
• O extends ReadFileOptions<"brotli" | "gzip" | "none"> = undefined
• path: string | URL
• options?: O
ContentType<O>
packages/fs/src/read/read-file-sync.ts:18
function readJson<T>(path, options?): Promise<T>
• T extends JsonValue
• path: string | URL
• options?: ReadJsonOptions
Promise<T>
packages/fs/src/read/read-json.ts:8
function readJson<T>(
path,
reviver,
options?): Promise<T>
• T extends JsonValue
• path: string | URL
• reviver
• options?: ReadJsonOptions
Promise<T>
packages/fs/src/read/read-json.ts:10
function readJsonSync<T>(path, options?): T
• T extends JsonValue
• path: string | URL
• options?: ReadJsonOptions
T
packages/fs/src/read/read-json-sync.ts:8
function readJsonSync<T>(
path,
reviver,
options?): T
• T extends JsonValue
• path: string | URL
• reviver
• options?: ReadJsonOptions
T
packages/fs/src/read/read-json-sync.ts:10
function readYaml<R>(path, options?): Promise<R>
• R = Record<string, unknown>
• path: string | URL
• options?: ReadYamlOptions<"brotli" | "gzip" | "none">
Promise<R>
packages/fs/src/read/read-yaml.ts:6
function readYaml<R>(
path,
reviver?,
options?): Promise<R>
• R = Record<string, unknown>
• path: string | URL
• reviver?: YamlReviver
• options?: ReadYamlOptions<"brotli" | "gzip" | "none">
Promise<R>
packages/fs/src/read/read-yaml.ts:7
function readYamlSync<R>(path, options?): R
• R = Record<string, unknown>
• path: string | URL
• options?: ReadYamlOptions<"brotli" | "gzip" | "none">
R
packages/fs/src/read/read-yaml-sync.ts:6
function readYamlSync<R>(
path,
reviver?,
options?): R
• R = Record<string, unknown>
• path: string | URL
• reviver?: YamlReviver
• options?: ReadYamlOptions<"brotli" | "gzip" | "none">
R
packages/fs/src/read/read-yaml-sync.ts:7
function remove(path, options): Promise<void>
• path: string | URL
• options = {}
• options.maxRetries?: number
If an EBUSY, EMFILE, ENFILE, ENOTEMPTY, or
EPERM error is encountered, Node.js will retry the operation with a linear
backoff wait of retryDelay ms longer on each try. This option represents the
number of retries. This option is ignored if the recursive option is not
true.
Default
0
• options.retryDelay?: number
The amount of time in milliseconds to wait between retries.
This option is ignored if the recursive option is not true.
Default
100
Promise<void>
packages/fs/src/remove/remove.ts:5
function removeSync(path, options): void
• path: string | URL
• options = {}
• options.maxRetries?: number
If an EBUSY, EMFILE, ENFILE, ENOTEMPTY, or
EPERM error is encountered, Node.js will retry the operation with a linear
backoff wait of retryDelay ms longer on each try. This option represents the
number of retries. This option is ignored if the recursive option is not
true.
Default
0
• options.retryDelay?: number
The amount of time in milliseconds to wait between retries.
This option is ignored if the recursive option is not true.
Default
100
void
packages/fs/src/remove/remove-sync.ts:5
function rename(
source,
destination,
options?): Promise<void>
Rename a file asynchronously.
• source: string
The file you want to rename.
• destination: string
The name of the renamed file.
• options?: MoveOptions
Configuration options.
Promise<void>
A Promise that resolves when the file has been renamed.
import { renameFile } from '@visulima/fs';
await renameFile('test.png', 'tests.png', {cwd: 'source'});
console.log('The file has been renamed');
packages/fs/src/move/index.ts:85
function renameSync(
source,
destination,
options?): void
Rename a file synchronously.
• source: string
The file you want to rename.
• destination: string
The name of the renamed file.
• options?: MoveOptions
Configuration options.
void
A Promise that resolves when the file has been renamed.
import {renameFileSync} from '@visulima/fs';
renameFileSync('test.png', 'tests.png', {cwd: 'source'});
console.log('The file has been renamed');
packages/fs/src/move/index.ts:109
function walk(directory, __namedParameters): AsyncIterableIterator<WalkEntry>
Walks the file tree rooted at root, yielding each file or directory in the tree filtered according to the given options. Options:
• directory: string | URL
• __namedParameters: WalkOptions = {}
AsyncIterableIterator<WalkEntry>
packages/fs/src/find/walk.ts:52
function walkSync(directory, __namedParameters): IterableIterator<WalkEntry>
Same as walk but uses synchronous ops
• directory: string | URL
• __namedParameters: WalkOptions = {}
IterableIterator<WalkEntry>
packages/fs/src/find/walk-sync.ts:40
function writeFile(
path,
content,
options?): Promise<void>
• path: string | URL
• content: string | ArrayBuffer | ArrayBufferView
• options?: WriteFileOptions
Promise<void>
packages/fs/src/write/write-file.ts:15
function writeFileSync(
path,
content,
options?): void
• path: string | URL
• content: string | ArrayBuffer | ArrayBufferView
• options?: WriteFileOptions
void
packages/fs/src/write/write-file-sync.ts:15
function writeJson(
path,
data,
options): Promise<void>
• path: string | URL
• data: unknown
• options: WriteJsonOptions = {}
Promise<void>
packages/fs/src/write/write-json.ts:11
function writeJsonSync(
path,
data,
options): void
• path: string | URL
• data: unknown
• options: WriteJsonOptions = {}
void
packages/fs/src/write/write-json-sync.ts:11
function writeYaml(
path,
data,
options?): Promise<void>
• path: string | URL
• data: any
• options?: Options
Promise<void>
packages/fs/src/write/write-yaml.ts:10
function writeYaml(
path,
data,
replacer?,
options?): Promise<void>
• path: string | URL
• data: any
• replacer?: JsonReplacer
• options?: string | number | Options
Promise<void>
packages/fs/src/write/write-yaml.ts:16
function writeYamlSync(
path,
data,
options?): void
• path: string | URL
• data: any
• options?: Options
void
packages/fs/src/write/write-yaml-sync.ts:10
function writeYamlSync(
path,
data,
replacer?,
options?): void
• path: string | URL
• data: any
• replacer?: JsonReplacer
• options?: string | number | Options
void
packages/fs/src/write/write-yaml-sync.ts:16
const CRLF: "\r\n";
End-of-line character for Windows platforms.
const EOL: "\n" | "\r\n";
End-of-line character evaluated for the current platform.
const F_OK: 0 = 0;
Is the path visible to the calling process?
packages/fs/src/constants.ts:2
const FIND_UP_STOP: typeof FIND_UP_STOP;
packages/fs/src/constants.ts:13
const LF: "\n";
End-of-line character for POSIX platforms such as macOS and Linux.
const R_OK: 4 = 4;
Is the path readable to the calling process?
packages/fs/src/constants.ts:5
const W_OK: 2 = 2;
Is the path writable to the calling process?
packages/fs/src/constants.ts:8
const X_OK: 1 = 1;
Is the path executable to the calling process?
packages/fs/src/constants.ts:11
Pick<Dirent, "isDirectory" | "isFile" | "isSymbolicLink" | "name">isDirectory(): boolean
Returns true if the fs.Dirent object describes a file system
directory.
boolean
v10.10.0
Pick.isDirectory
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/fs.d.ts:190
isFile(): boolean
Returns true if the fs.Dirent object describes a regular file.
boolean
v10.10.0
Pick.isFile
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/fs.d.ts:184
isSymbolicLink(): boolean
Returns true if the fs.Dirent object describes a symbolic link.
boolean
v10.10.0
Pick.isSymbolicLink
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/fs.d.ts:205
name: string;
The file name that this fs.Dirent object refers to. The type of this
value is determined by the options.encoding passed to readdir or readdirSync.
v10.10.0
Pick.name
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/fs.d.ts:222
path: string;
optional extensions: string[];
List of file extensions used to filter entries. If specified, entries without the file extension specified by this option are excluded.
{undefined}
optional followSymlinks: boolean;
Indicates whether symlinks should be resolved or not.
{false}
optional includeDirs: boolean;
Indicates whether directory entries should be included or not.
{true}
optional includeFiles: boolean;
Indicates whether file entries should be included or not.
{true}
optional includeSymlinks: boolean;
Indicates whether symlink entries should be included or not.
This option is meaningful only if followSymlinks is set to false.
{true}
optional match: (string | RegExp)[];
List of regular expression or glob patterns used to filter entries. If specified, entries that do not match the patterns specified by this option are excluded.
{undefined}
optional maxDepth: number;
The maximum depth of the file tree to be walked recursively.
{Infinity}
optional skip: (string | RegExp)[];
List of regular expression or glob patterns used to filter entries. If specified, entries matching the patterns specified by this option are excluded.
{undefined}
type CodeFrameLocation: object;
optional column: number;
line: number;
type EmptyDirOptions: object;
optional maxRetries: number;
If an EBUSY, EMFILE, ENFILE, ENOTEMPTY, or
EPERM error is encountered, Node.js will retry the operation with a linear
backoff wait of retryDelay ms longer on each try. This option represents the
number of retries. This option is ignored if the recursive option is not
true.
0
optional retryDelay: number;
The amount of time in milliseconds to wait between retries.
This option is ignored if the recursive option is not true.
100
type FindUpName: string[] | string | (directory) => FindUpNameFnResult;
type FindUpNameFnResult: PathLike | Promise<PathLike | typeof FIND_UP_STOP> | typeof FIND_UP_STOP | undefined;
type FindUpNameSync: string[] | string | (directory) => FindUpNameSyncFnResult;
type FindUpNameSyncFnResult: PathLike | typeof FIND_UP_STOP | undefined;
type FindUpOptions: object;
optional allowSymlinks: boolean;
optional cwd: URL | string;
optional stopAt: URL | string;
optional type: "directory" | "file";
type JsonReplacer: (number | string)[] | (this, key, value) => unknown | null;
type JsonReviver: Parameters<typeof JSON["parse"]>["1"];
type MoveOptions: object;
optional cwd: URL | string;
The working directory to find source files. The source and destination path are relative to this.
process.cwd()
readonly optional directoryMode: FilePermissions;
Permissions for created directories.
It has no effect on Windows.
0o777
readonly optional overwrite: boolean;
Overwrite existing destination file.
true
packages/fs/src/move/types.ts:3
type ReadFileEncoding:
| "ascii"
| "base64"
| "base64url"
| "hex"
| "latin1"
| "ucs-2"
| "ucs2"
| "utf-8"
| "utf-16le"
| "utf8"
| "utf16le";
type ReadFileOptions<C>: object;
• C
optional buffer: boolean;
Return content as a Buffer. Default: false
optional compression: C;
Compression method to decompress the file against. Default: none
optional encoding: ReadFileEncoding;
The encoding to use. Default: utf8
https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings
optional flag: number | string;
The flag used to open the file. Default: r
type ReadJsonOptions: CodeFrameOptions & object;
optional beforeParse: (source) => string;
• source: string
string
type WriteFileOptions: object;
optional chown: object;
The group and user ID used to set the file ownership. Default: undefined
gid: number;
uid: number;
optional encoding: BufferEncoding | null;
The encoding to use. Default: utf8
optional flag: string;
The flag used to write the file. Default: w
optional mode: number;
The file mode (permission and sticky bits). Default: 0o666
optional overwrite: boolean;
Indicates whether the file should be overwritten if it already exists. Default: false
optional recursive: boolean;
Recursively create parent directories if needed. Default: true
type WriteJsonOptions: WriteFileOptions & object;
optional detectIndent: boolean;
Detect indentation automatically if the file exists. Default: false
optional indent: number | string;
The space used for pretty-printing.
Pass in undefined for no formatting.
optional replacer: JsonReplacer;
Passed into JSON.stringify.
optional stringify: (data, replacer, space) => string;
Override the default JSON.stringify method.
• data: unknown
• replacer: JsonReplacer
• space: number | string | undefined
string
type YamlReplacer: JsonReplacer;
Errornew JSONError(message): JSONError
• message: string
Error.constructor
packages/fs/src/error/json-error.ts:11
get message(): string
set message(message): void
• message: string
string
Error.message
packages/fs/src/error/json-error.ts:21
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
• targetObject: object
• constructorOpt?: Function
void
Error.captureStackTrace
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
optional cause: unknown;
Error.cause
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
codeFrame: string;
packages/fs/src/error/json-error.ts:4
fileName: string;
packages/fs/src/error/json-error.ts:2
readonly name: "JSONError" = "JSONError";
Error.name
packages/fs/src/error/json-error.ts:7
optional stack: string;
Error.stack
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1078
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
• err: Error
• stackTraces: CallSite[]
any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Error.prepareStackTrace
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
static stackTraceLimit: number;
Error.stackTraceLimit
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:29
function assertValidFileContents(contents): void
• contents: any
void
packages/fs/src/utils/assert-valid-file-contents.ts:2
function assertValidFileOrDirectoryPath(fileOrDirectoryPath): void
• fileOrDirectoryPath: any
void
packages/fs/src/utils/assert-valid-file-or-directory-path.ts:2
function parseJson<T>(
string,
filename?,
options?): T
• T = JsonValue
• string: string
• filename?: string
• options?: CodeFrameOptions
T
packages/fs/src/utils/parse-json.ts:60
function parseJson<T>(
string,
reviver,
fileName?,
options?): T
• T = JsonValue
• string: string
• reviver
• fileName?: string
• options?: CodeFrameOptions
T
packages/fs/src/utils/parse-json.ts:61
function stripJsonComments(jsonString, __namedParameters): string
• jsonString: string
• __namedParameters = {}
• __namedParameters.whitespace: boolean = true
string
packages/fs/src/utils/strip-json-comments.ts:5
function toPath(urlOrPath): string
• urlOrPath: string | URL
string
node_modules/.pnpm/@visulima+path@1.1.1/node_modules/@visulima/path/dist/utils.d.mts:7
Libraries in this ecosystem make the best effort to track Node.js’ release schedule. Here’s a post on why we think this is important.
If you would like to help take a look at the list of issues and check our Contributing guild.
Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
The visulima fs is open-sourced software licensed under the MIT
FAQs
Human friendly file system utilities for Node.js
The npm package @visulima/fs receives a total of 1,370 weekly downloads. As such, @visulima/fs popularity was classified as popular.
We found that @visulima/fs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.
Security News
Socket has been recognized for the second consecutive year on the Fortune Cyber 60 list, which identifies the most significant venture-backed cybersecurity startups.
Security News
Python becomes GitHub's top language in 2024, driven by AI and data science projects, while AI-powered security tools are gaining adoption.