Filesystem

API support and documentation for the node:fs and node:fs/promises modules.

import fs from "node:fs"

const fs = require("node:fs")

import fs from "node:fs/promises"

const fs = require("node:fs/promises")

Modules

Status	Module	Docs
🟡 Partially supported.	`node:fs`	Filesystem
🟡 Partially supported.	`node:fs/promises`	Filesystem (Promises)

`fs` | Classes

Dir: 🔴 Not implemented.
Dirent: 🔴 Not implemented.
FSWatcher: 🔴 Not implemented.
StatWatcher: 🔴 Not implemented.
ReadStream: 🔴 Not implemented.
Stats: 🔴 Not implemented.
StatFs: 🔴 Not implemented.
WriteStream: 🔴 Not implemented.

`fs` | Properties

constants: 🟢 Supported.

`fs` | Methods

access(path[, mode], callback): 🟢 Supported.
accessSync(path[, mode]): 🟢 Supported.
appendFile(path, data[, options], callback): 🔴 Not implemented.
appendFileSync(path, data[, options]): 🔴 Not implemented.
chmod(path, mode, callback): 🔴 Not implemented.
chmodSync(path, mode): 🔴 Not implemented.
chown(path, uid, gid, callback): 🔴 Not implemented.
chownSync(path, uid, gid): 🔴 Not implemented.
close(fs[, callback]): 🔴 Not implemented.
closeSync(fs): 🔴 Not implemented.
copyFile(src, dest[, mode], callback): 🔴 Not implemented.
copyFileSync(src, dest[, mode]): 🔴 Not implemented.
cp(src, dest[, options], callback): 🔴 Not implemented.
cpSync(src, dest[, options]): 🔴 Not implemented.
createReadStream(path[, options]): 🔴 Not implemented.
createWriteStream(path[, options]): 🔴 Not implemented.
exists(path, callback): 🟢 Supported. Deprecated since Node v1.
existsSync(path): 🟢 Supported. Deprecated since Node v1.
fchmod(fd, mode, callback): 🔴 Not implemented.
fchmodSync(fd, mode): 🔴 Not implemented.
fchown(fd, uid, gid, callback): 🔴 Not implemented.
fchownSync(fd, uid, gid): 🔴 Not implemented.
fdatasync(fd, callback): 🔴 Not implemented.
fdatasyncSync(fd): 🔴 Not implemented.
fstat(fd[, options], callback): 🔴 Not implemented.
fstatSync(fd[, options]): 🔴 Not implemented.
fsync(fd, callback): 🔴 Not implemented.
fsyncSync(fd): 🔴 Not implemented.
ftruncate(fd[, len], callback): 🔴 Not implemented.
ftruncateSync(fd[, len]): 🔴 Not implemented.
futimes(fd, atime, mtime, callback): 🔴 Not implemented.
futimesSync(fd, atime, mtime): 🔴 Not implemented.
glob(pattern[, options], callback): 🔴 Not implemented.
globSync(pattern[, options]): 🔴 Not implemented.
lchmod(path, mode, callback): 🔴 Not implemented.
lchmodSync(path, mode): 🔴 Not implemented.
lchown(path, uid, gid, callback): 🔴 Not implemented.
lchownSync(path, uid, gid): 🔴 Not implemented.
lutimes(path, atime, mtime, callback): 🔴 Not implemented.
lutimesSync(path, atime, mtime): 🔴 Not implemented.
link(existingPath, newPath, callback): 🔴 Not implemented.
linkSync(existingPath, newPath): 🔴 Not implemented.
lstat(path[, options], callback): 🔴 Not implemented.
lstatSync(path[, options]): 🔴 Not implemented.
mkdir(path[, options], callback): 🟢 Supported.
mkdirSync(path[, options]): 🟢 Supported.
mkdtemp(prefix[, options], callback): 🔴 Not implemented.
mkdtempSync(prefix[, options]): 🔴 Not implemented.
open(path[, flags[, mode]], callback): 🔴 Not implemented.
openSync(path[, flags[, mode]]): 🔴 Not implemented.
openAsBlob(path[, options]): 🔴 Not implemented.
opendir(path[, options], callback): 🔴 Not implemented.
opendirSync(path[, options]): 🔴 Not implemented.
read(fd, buffer, offset, length, position, callback): 🔴 Not implemented.
readSync(fd, buffer, offset, length, position): 🔴 Not implemented.
read(fd[, options], callback): 🔴 Not implemented.
readSync(fd[, options]): 🔴 Not implemented.
read(fd, buffer[, options], callback): 🔴 Not implemented.
readSync(fd, buffer[, options]): 🔴 Not implemented.
readdir(path[, options], callback): 🔴 Not implemented.
readdirSync(path[, options]): 🔴 Not implemented.
readFile(path[, options], callback): 🟡 Supported for UTF-8 reads. Binary reads do not work yet.
readFileSync(path[, options]): 🟡 Supported for UTF-8 reads. Binary reads do not work yet.
readlink(path[, options], callback): 🔴 Not implemented.
readlinkSync(path[, options]): 🔴 Not implemented.
readv(fd, buffers[, position], callback): 🔴 Not implemented.
readvSync(fd, buffers[, position]): 🔴 Not implemented.
readv(fd, buffers[, position], callback): 🔴 Not implemented.
readvSync(fd, buffers[, position]): 🔴 Not implemented.
realpath(path[, options], callback): 🔴 Not implemented.
realpathSync(path[, options], callback): 🔴 Not implemented.
realpath.native(path[, options], callback): 🔴 Not implemented.
realpathSync.native(path[, options], callback): 🔴 Not implemented.
rename(oldPath, newPath, callback): 🔴 Not implemented.
renameSync(oldPath, newPath): 🔴 Not implemented.
rmdir(path[, options], callback): 🔴 Not implemented.
rmdirSync(path[, options]): 🔴 Not implemented.
rm(path[, options], callback): 🔴 Not implemented.
rmSync(path[, options]): 🔴 Not implemented.
stat(path[, options], callback): 🔴 Not implemented.
statSync(path[, options]): 🔴 Not implemented.
statfs(path[, options], callback): 🔴 Not implemented.
statfsSync(path[, options]): 🔴 Not implemented.
symlink(target, path[, type], callback): 🔴 Not implemented.
symlinkSync(target, path[, type]): 🔴 Not implemented.
truncate(path[, len], callback): 🔴 Not implemented.
truncateSync(path[, len]): 🔴 Not implemented.
unlink(path, callback): 🔴 Not implemented.
unlinkSync(path): 🔴 Not implemented.
unwatchFile(filename[, listener]): 🔴 Not implemented.
utimes(path, atime, mtime, callback): 🔴 Not implemented.
utimesSync(path, atime, mtime): 🔴 Not implemented.
watch(filename[, options][, listener]): 🔴 Not implemented.
watchFile(filename[, options][, listener]): 🔴 Not implemented.
write(fd, buffer, offset[, length[, position]], callback): 🔴 Not implemented.
writeSync(fd, buffer, offset[, length[, position]]): 🔴 Not implemented.
write(fd, buffer[, options], callback): 🔴 Not implemented.
writeSync(fd, buffer[, options]): 🔴 Not implemented.
write(fd, string[, position[, encoding]], callback): 🔴 Not implemented.
writeSync(fd, string[, position[, encoding]]): 🔴 Not implemented.
writeFile(file, data[, options], callback): 🟡 Supported. Buffer cannot be used for writes yet.
writeFileSync(file, data[, options]): 🟡 Supported. Buffer cannot be used for writes yet.
writev(fd, buffers[, position], callback): 🔴 Not implemented.
writevSync(fd, buffers[, position]): 🔴 Not implemented.

`fs/promises` | Classes

FileHandle: 🔴 Not implemented.

`fs/promises` | Properties

constants: 🟢 Supported.

`fs/promises` | Methods

access(path[, mode]): 🔴 Not implemented.
appendFile(path, data[, options]): 🔴 Not implemented.
chmod(path, mode): 🔴 Not implemented.
chown(path, uid, gid): 🔴 Not implemented.
copyFile(src, dest[, mode]): 🔴 Not implemented.
cp(src, dest[, options]): 🔴 Not implemented.
glob(pattern[, options]): 🔴 Not implemented.
lchmod(path, mode): 🔴 Not implemented.
lchown(path, uid, gid): 🔴 Not implemented.
luntimes(path, atime, mtime): 🔴 Not implemented.
link(existingPath, newPath): 🔴 Not implemented.
lstat(path[, options]): 🔴 Not implemented.
mkdir(path[, options]): 🔴 Not implemented.
mkdtemp(prefix[, options]): 🔴 Not implemented.
open(path, flags[, mode]): 🔴 Not implemented.
opendir(path[, options]): 🔴 Not implemented.
readdir(path[, options]): 🔴 Not implemented.
readFile(path[, options]): 🟡 Supported for UTF-8 reads. Binary reads do not work yet.
readlink(path[, options]): 🔴 Not implemented.
realpath(path[, options]): 🔴 Not implemented.
rename(oldPath, newPath): 🔴 Not implemented.
rmdir(path[, options]): 🔴 Not implemented.
rm(path[, options]): 🔴 Not implemented.
stat(path[, options]): 🔴 Not implemented.
statfs(path[, options]): 🔴 Not implemented.
symlink(target, path[, type]): 🔴 Not implemented.
truncate(path[, len]): 🔴 Not implemented.
unlink(path): 🔴 Not implemented.
utimes(path, atime, mtime): 🔴 Not implemented.
watch(filename[, options]): 🔴 Not implemented.
writeFile(file, data[, options]): 🔴 Not implemented.

Last modified: 14 May 2024