= Node fs =

The '''`fs`''' module includes tools for interacting with file systems. 

<<TableOfContents>>

----



== Constants ==

----



== Synchronous API ==



=== Example ===

{{{
const fs = require("fs");

function readDirectory(directory) {
  let files = fs.readdirSync(directory);
  return files.sort((a,b) => a.localeCompare(b));
};
}}}



=== Functions ===

||'''Function Name'''||'''Description'''||
||`fs.accessSync`    || ||
||`fs.appendFileSync`|| ||
||`fs.chmodSync`     || ||
||`fs.chownSync`     || ||
||`fs.closeSync`     || ||
||`fs.copyFileSync`  || ||
||`fs.existsSync`    || ||
||`fs.linkSync`      || ||
||`fs.mkdirSync`     || ||
||`fs.mkdtempSync`   || ||
||`fs.readdirSync`   || ||
||`fs.readFileSync`  || ||
||`fs.readlinkSync`  || ||
||`fs.realpathSync`  || ||
||`fs.renameSync`    || ||
||`fs.rmdirSync`     || ||
||`fs.rmSync`        || ||
||`fs.statSync`      || ||
||`fs.symlinkSync`   || ||
||`fs.unlinkSync`    || ||
||`fs.utimesSync`    || ||
||`fs.writeFileSync` || ||

----



== Asynchronous API ==

Designed for callbacks.



=== Example ===

{{{
const fs = require("fs");

fs.readFile(filename, "utf8", (err, content) => {
if (err) {
  console.log("cannot read file");
}
else {
  console.log(content);
}
});

fs.writeFile(filename, content, (err) => {
  if (err) {
    console.log("cannot write file");
  }
});
}}}



=== Functions ===

||'''Function Name'''||'''Description'''||
||`fs.access`        || ||
||`fs.appendFile`    || ||
||`fs.chmod`         || ||
||`fs.chown`         || ||
||`fs.copyFile`      || ||
||`fs.link`          || ||
||`fs.mkdir`         || ||
||`fs.mkdtemp`       || ||
||`fs.readdir`       || ||
||`fs.readFile`      || ||
||`fs.readlink`      || ||
||`fs.realpath`      || ||
||`fs.rename`        || ||
||`fs.rmdir`         || ||
||`fs.rm`            || ||
||`fs.stat`          || ||
||`fs.symlink`       || ||
||`fs.unlink`        || ||
||`fs.unwatchFile`   || ||
||`fs.utimes`        || ||
||`fs.watchFile`     || ||
||`fs.writeFile`     || ||

----



== Exists ==

`exists` is deprecated; replace with `stat` or `access`.

Furthermore, do not try using this to check if a file exists before writing it. This will introduce a race condition.

{{{
const fs = require("fs");

exists(filename, (err) => {
  if (err) {
    console.log("file exists");
  }
});
}}}

----



== See also ==

[[https://nodejs.org/api/fs.html|Node API for fs]]



----
CategoryRicottone