|
Size: 2447
Comment:
|
← Revision 3 as of 2025-12-19 21:03:39 ⇥
Size: 2584
Comment: Cleanup
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = Node Fs = | = Node fs = The '''`fs`''' module includes tools for interacting with file systems. |
| Line 19: | Line 21: |
| === AccessSyunc === ---- === AppendFileSync === ---- === ChModSync === ---- === ChOwnSync === ---- === CopyFileSync === ---- === ExistsSync === ---- === LinkSync === ---- === MkDirSync === ---- === MkDTempSync === ---- === ReadDirSync === |
=== Example === |
| Line 84: | Line 32: |
| ---- | |
| Line 87: | Line 34: |
| === Functions === | |
| Line 88: | Line 36: |
| === ReadFileSync === | ||'''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` || || |
| Line 94: | Line 64: |
| === ReadLinkSync === | == 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` || || |
| Line 100: | Line 123: |
| === RealPathSync === | == Exists == |
| Line 102: | Line 125: |
| ---- === RenameSync === ---- === RmDirSync === ---- === RmSync === ---- === StatSync === ---- === SymLinkSync === ---- === UnlinkSync === ---- === UTimesSync === ---- === WriteFileSync === ---- == Callback API == === Access === ---- === AppendFile === ---- === ChMod === ---- === ChOwn === ---- === CopyFile === ---- === Exists === Deprecated. Use `stat` or `access` instead. |
`exists` is deprecated; replace with `stat` or `access`. |
| Line 208: | Line 143: |
| === Link === ---- === MkDir === ---- === MkDTemp === ---- === ReadDir === ---- === ReadFile === {{{ const fs = require("fs"); fs.readFile(filename, "utf8", (err, content) => { if (err) { console.log("cannot read file"); } else { console.log(content); } }); }}} ---- === ReadLink === ---- === RealPath === ---- === Rename === ---- === RmDir === ---- === Rm === ---- === Stat === ---- === SymLink === ---- === Unlink === ---- === UnwatchFile === ---- === UTimes === ---- === WatchFile === ---- === WriteFile === {{{ fs.writeFile(filename, content, (err) => { if (err) { console.log("cannot write file"); } }); }}} ---- |
Node fs
The fs module includes tools for interacting with file systems.
Contents
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");
}
});