Skip to content

Latest commit

 

History

History
96 lines (94 loc) · 3.71 KB

api-status.md

File metadata and controls

96 lines (94 loc) · 3.71 KB
Raw

API Status

All of the Node's fs API is implemented. Some error messages may be inaccurate. File permissions are currently not implemented (you have access to any file), basically fs.access() is a no-op.

  • Promises
  • Constants
  • FSWatcher
  • ReadStream
  • WriteStream
  • Stats
  • Dirent
  • access(path[, mode], callback)
    • Does not check permissions
  • accessSync(path[, mode])
    • Does not check permissions
  • appendFile(file, data[, options], callback)
  • appendFileSync(file, data[, options])
  • chmod(path, mode, callback)
  • chmodSync(path, mode)
  • chown(path, uid, gid, callback)
  • chownSync(path, uid, gid)
  • fs.copyFile(src, dest[, flags], callback)
  • fs.copyFileSync(src, dest[, flags])
    • Honors COPYFILE_EXCL
    • Ignores COPYFILE_FICLONE copy-on-write — always creates a copy.
    • If COPYFILE_FICLONE_FORCE flag specified, will always fail with ENOSYS.
  • close(fd, callback)
  • closeSync(fd)
  • createReadStream(path[, options])
  • createWriteStream(path[, options])
  • exists(path, callback)
  • existsSync(path)
  • fchmod(fd, mode, callback)
  • fchmodSync(fd, mode)
  • fchown(fd, uid, gid, callback)
  • fchownSync(fd, uid, gid)
  • fdatasync(fd, callback)
  • fdatasyncSync(fd)
  • fstat(fd, callback)
  • fstatSync(fd)
  • fsync(fd, callback)
  • fsyncSync(fd)
  • ftruncate(fd[, len], callback)
  • ftruncateSync(fd[, len])
  • futimes(fd, atime, mtime, callback)
  • futimesSync(fd, atime, mtime)
  • lchmod(path, mode, callback)
  • lchmodSync(path, mode)
  • lchown(path, uid, gid, callback)
  • lchownSync(path, uid, gid)
  • link(existingPath, newPath, callback)
  • linkSync(existingPath, newPath)
  • lstat(path, callback)
  • lstatSync(path)
  • mkdir(path[, options], callback)
  • mkdirSync(path[, options])
  • mkdtemp(prefix[, options], callback)
  • mkdtempSync(prefix[, options])
  • open(path, flags[, mode], callback)
  • openSync(path, flags[, mode])
  • read(fd, buffer, offset, length, position, callback)
  • readSync(fd, buffer, offset, length, position)
  • readdir(path[, options], callback)
  • readdirSync(path[, options])
  • readFile(path[, options], callback)
  • readFileSync(path[, options])
  • readlink(path[, options], callback)
  • readlinkSync(path[, options])
  • realpath(path[, options], callback)
  • realpathSync(path[, options])
    • Caching not implemented
  • rename(oldPath, newPath, callback)
  • renameSync(oldPath, newPath)
  • rmdir(path, callback)
  • rmdirSync(path)
  • stat(path, callback)
  • statSync(path)
  • symlink(target, path[, type], callback)
  • symlinkSync(target, path[, type])
  • truncate(path[, len], callback)
  • truncateSync(path[, len])
  • unlink(path, callback)
  • unlinkSync(path)
  • utimes(path, atime, mtime, callback)
  • utimesSync(path, atime, mtime)
  • watch(filename[, options][, listener])
  • watchFile(filename[, options], listener)
  • unwatchFile(filename[, listener])
  • write(fd, buffer[, offset[, length[, position]]], callback)
  • write(fd, string[, position[, encoding]], callback)
  • writeFile(file, data[, options], callback)
  • writeFileSync(file, data[, options])
  • writeSync(fd, buffer[, offset[, length[, position]]])
  • writeSync(fd, string[, position[, encoding]])