FileSystem

Requires

• tuckn/WshOS

Namespaces

constants

Methods

(static) copyFileSync(src, dest, flagopt) → {void}

Source:

• FileSystem.js, line 877

Example

var fs = Wsh.FileSystem; // Shorthand

fs.copyFileSync('D:\\SrcFile.path', 'R:\\DestFile.path');

// The following does not work.
// Ex.1 Directory
fs.copyFileSync('D:\\SrcDir', 'R:\\DestDir');
// Ex.2 Non-existing parent directory
fse.copySync('D:\\SrcFile.path', 'R:\\NonExistingDir\\DestFile.path');

Parameters:

Returns:

Type

void

(static) excludeSymboliclinkPaths(filePaths, optionsopt) → {Array.<string>}

Source:

• FileSystem.js, line 770

Example

var fs = Wsh.FileSystem; // Shorthand
var list = [
  'D:\\My Dir\\memo.txt',
  'D:\\MyBook-SymLink.xlsx', // SymbolicLink
  'D:\\image.png' ];

var files = fs.excludeSymboliclinkPaths(list);
// Returns: [
//   'D:\\My Dir\\memo.txt',
//   'D:\\image.png' ];

Parameters:

Returns:

Type

Array.<string>

(static) existsSync(fpath) → {boolean}

Source:

• FileSystem.js, line 321

Example

var fs = Wsh.FileSystem; // Shorthand

fs.existsSync('D:\\ExistingDir'); // true
fs.existsSync('D:\\ExistingDir\\File.path'); // true
fs.existsSync('D:\\NonExistingDir\\File.path'); // false
fs.existsSync('\\\\MyComp\\Public\\ExistingDir\\File.path'); // true

Parameters:

Returns:

Type

boolean

(static) getAllChildrensFullPaths(dirPath, optionsopt) → {Array.<string>}

Source:

• FileSystem.js, line 826

Parameters:

Returns:

Type

Array.<string>

(static) getChildrenDirectories(dirPath, optionsopt) → {Array.<string>|Array.<Object>}

Source:

• FileSystem.js, line 592

Parameters:

Returns:

Type

Array.<string> | Array.<Object>

(static) getChildrenFiles(dirPath, optionsopt) → {Array.<string>|Array.<Object>}

Source:

• FileSystem.js, line 514

Parameters:

Returns:

Type

Array.<string> | Array.<Object>

(static) inspectPathWhetherMAX_PATH(fullPath) → {void}

Source:

• FileSystem.js, line 115

Example

var tooLongPath = 'C:\\Users\\UserName\\AppData\\Roaming\\Microsoft\\Internet Explorer\\Quick Launch\\User Pinned\\ImplicitAppShortcuts\\database\\Document and Settings\\MongoDB Inc\\MongoDB Compass Community\\computer\\operationsManagement\\img\\01_original_screencapture-20180213T043515+0900.png';

Wsh.FileSystem.inspectPathWhetherMAX_PATH(tooLongPath); // Throws an Error

Parameters:

Throws:

• If a length of the file-path is over then 255.

Type

string

Returns:

Type

void

(static) linkSync(existingPath, newPath, optionsopt) → {boolean|string}

Source:

• FileSystem.js, line 919

Example

// Run this script as admin
var fs = Wsh.FileSystem; // Shorthand

fs.linkSync('D:\\MyDir\\BackUp', 'C:\\BackUp-Symlink'); // Requires admin

Parameters:

Returns:

Type

boolean | string

(static) mkdirSync(dirPath, optionsopt) → {void}

Source:

• FileSystem.js, line 141

Example

var fs = Wsh.FileSystem; // Shorthand

fs.mkdirSync('D:\\MyDir');

// The following does not work.
// Ex.1 The existing directory
fs.mkdirSync('D:\\MyDir'); // Throws an Error
// Ex.2 Non-existing parent directory
fs.mkdirSync('R:\\NonExistingDir\\NewDir'); // Throws an Error

Parameters:

Returns:

Type

void

(static) readdirSync(dirPath, optionsopt) → {Array.<string>|Array.<Object>}

Source:

• FileSystem.js, line 674

Example

var fs = Wsh.FileSystem; // Shorthand

var testDir = 'D:\\testDir';
//  D:\testDir\
//  │  fileRoot1.txt
//  │  fileRoot2-Symlink.log // <SYMLINKD>
//  │  fileRoot2.log
//  │
//  ├─DirBar\
//  ├─DirBar-Symlink\ // <SYMLINKD>
//  └─DirFoo\
//          fileFoo1.txt

// Ex.1 No options
fs.readdirSync(testDir);
// Returns: [
//   'fileRoot1.txt',
//   'fileRoot2-Symlink.log', // <SYMLINKD>
//   'fileRoot2.log',
//   'DirBar',
//   'DirBar-Symlink', // <SYMLINKD>
//   'DirFoo' ]

// Ex.2 Files only
fs.readdirSync(testDir, { isOnlyFile: true });
// Returns: [
//   'fileRoot1.txt',
//   'fileRoot2-Symlink.log', // <SYMLINKD>
//   'fileRoot2.log' ]

// Ex.3 Directories only
fs.readdirSync(testDir, { isOnlyDir: true });
// Returns: [
//   'DirBar',
//   'DirBar-Symlink', // <SYMLINKD>
//   'DirFoo' ]

// Ex.4 Excludes Symlink
fs.readdirSync(testDir, { excludesSymlink: true });
// Returns: [
//   'fileRoot1.txt',
//   'fileRoot2.log',
//   'DirBar',
//   'DirFoo' ]

// Ex.5 Filtering
fs.readdirSync(testDir, { matchedRegExp: '\\d+\\.txt$' });
// Returns: ['fileRoot1.txt']

// Ex.6 withFileTypes
fs.readdirSync(testDir, { withFileTypes: true });
// Returns: [
//   { name: 'fileRoot1.txt',
//     path: 'D:\\testDir\\fileRoot1.txt',
//     attributes: 32,
//     isDirectory: false,
//     isFile: true,
//     isSymbolicLink: false },
//   ...
//   ..
//   { name: 'DirFoo.txt',
//     path: 'D:\\testDir\\DirFoo',
//     attributes: 16,
//     isDirectory: true,
//     isFile: false,
//     isSymbolicLink: false }]

Parameters:

Returns:

Type

Array.<string> | Array.<Object>

(static) readFileSync(fpath, optionsopt) → {unknown|string}

Source:

• FileSystem.js, line 435

Example

var fs = Wsh.FileSystem; // Shorthand

var readBin = fs.readFileSync('D:\\MyPage\\index.html');
// The default is reading the file as binary

var readHtml = fs.readFileSync('D:\\MyPage\\index.html', { encoding: 'utf8' });
var readText = fs.readFileSync('D:\\MyNote\\memo.txt', { encoding: 'sjis' });

Parameters:

Returns:

Type

unknown | string

(static) rmdirSync(dirPath) → {void}

Source:

• FileSystem.js, line 1069

Example

var fs = Wsh.FileSystem; // Shorthand

fs.rmdirSync('D:\\MyDir');

// The following does not work.
// Ex.1 File
fs.rmdirSync('D:\\MyFile.path');
// Ex.2 A non-existing directory
fs.mkdirSync('R:\\NonExistingDir');

Parameters:

Returns:

Type

void

(static) statSync(fpath) → {typeFsStat}

Source:

• FileSystem.js, line 356

Example

var fs = Wsh.FileSystem; // Shorthand

var stat = fs.statSync('D:\\My Dir\\File.path');
stat.size; // 2345
stat.isFile(); // true
stat.isDirectory(); // false
stat.isSymbolicLink(); // false
stat.atime; // Thu Sep 3 07:16:02 UTC+0900 2020,
stat.mtime; // Sat Feb 3 07:18:51 UTC+0900 2018,
stat.ctime; // null,
stat.birthtime; // Thu Sep 3 07:16:02 UTC+0900 2020

var stat = fs.statSync('D:\\Symlink Dir');
stat.size; // 0
stat.isFile(); // false
stat.isDirectory(); // true
stat.isSymbolicLink(); // true

Parameters:

Returns:

Type

typeFsStat

(static) unlinkSync(fpath) → {void}

Source:

• FileSystem.js, line 1119

Example

var fs = Wsh.FileSystem; // Shorthand

fs.unlinkSync('D:\\MyFile.path');
fs.unlinkSync('D:\\MyDir'); // Throws an Error

Parameters:

Returns:

Type

void

(static) writeFileSync(fpath, data, optionsopt) → {void}

Source:

• FileSystem.js, line 170

Example

var fs = Wsh.FileSystem; // Shorthand
var writeData = 'Foo Bar';

// The default is writing data to the file as binary (UTF-16 LE NoBOM)
fs.writeFileSync('D:\\MyData.bin', writeData);

fs.writeFileSync('D:\\my-note.txt', writeData, { encoding: 'utf8' });

fs.writeFileSync('D:\\MyNote.txt', writeData, { encoding: 'sjis' });

fs.writeFileSync('D:\\my-script.wsf', writeData, {
  encoding: 'utf8', bom: true
});

fs.writeFileSync('D:\\fixme.txt', '', { encoding: 'utf8' });
// Thorws a error! Fix this (T_T)

Parameters:

Returns:

Type

void

(static) writeTmpFileSync(data, optionsopt) → {string}

Source:

• FileSystem.js, line 297

Example

var fs = Wsh.FileSystem; // Shorthand
var writeData = 'Foo Bar';

var tmpPath = fs.writeTmpFileSync(writeData, { encoding: 'utf8' });
// Returns: 'C:\\Users\\UserName\\AppData\\Local\\Temp\\fs-writeTmpFileSync_rad6E884.tmp'

Parameters:

Returns:

Type

string

(static) xcopySync(src, dest, optionsopt) → {void|typeExecSyncReturn|string}

Source:

• FileSystem.js, line 989

Example

var fs = Wsh.FileSystem; // Shorthand

fs.xcopySync('D:\\SrcFile.path', 'R:\\DestFile.path');
fs.xcopySync('D:\\SrcDir', 'R:\\DestDir');

var stdObj = fs.xcopySync('D:\\src.js', 'R:\\dest.js', { withStd: true });
// Returns: {
//   error: false,
//   exitCode: 0,
//   stdout: '<String of StdOut>',
//   stderr: '<String of StdErr>' }

Parameters:

Returns:

Type

void | typeExecSyncReturn | string