Node.js — Файловая система

var fs = require("fs");

console.log("Going to write into existing file");
fs.writeFile('input.txt', 'Simply Easy Learning!', function(err) {
   if (err) {
      return console.error(err);
   }
   
   console.log("Data written successfully!");
   console.log("Let's read newly written data");
   
   fs.readFile('input.txt', function (err, data) {
      if (err) {
         return console.error(err);
      }
      console.log("Asynchronous read: " + data.toString());
   });
});

Теперь запустите main.js, чтобы увидеть результат —

$ node main.js

Проверьте вывод.

Going to write into existing file
Data written successfully!
Let's read newly written data
Asynchronous read: Simply Easy Learning!

Чтение файла

Синтаксис

Ниже приводится синтаксис одного из методов для чтения из файла:

fs.read(fd, buffer, offset, length, position, callback)

Этот метод будет использовать дескриптор файла для чтения файла. Если вы хотите прочитать файл напрямую, используя имя файла, вам следует использовать другой доступный метод.

параметры

Вот описание используемых параметров —

• fd — это дескриптор файла, возвращаемый функцией fs.open ().

• буфер — это буфер, в который будут записаны данные.

• смещение — это смещение в буфере, с которого начинается запись.

• длина — это целое число, указывающее количество байтов для чтения.

• позиция — это целое число, указывающее, с чего начать чтение в файле. Если позиция равна нулю, данные будут считаны из текущей позиции файла.

• callback — это функция обратного вызова, которая получает три аргумента (err, bytesRead, buffer).

fd — это дескриптор файла, возвращаемый функцией fs.open ().

буфер — это буфер, в который будут записаны данные.

смещение — это смещение в буфере, с которого начинается запись.

длина — это целое число, указывающее количество байтов для чтения.

позиция — это целое число, указывающее, с чего начать чтение в файле. Если позиция равна нулю, данные будут считаны из текущей позиции файла.

callback — это функция обратного вызова, которая получает три аргумента (err, bytesRead, buffer).

пример

Давайте создадим js-файл с именем main.js со следующим кодом —

var fs = require("fs");
var buf = new Buffer(1024);

console.log("Going to open an existing file");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
      return console.error(err);
   }
   console.log("File opened successfully!");
   console.log("Going to read the file");
   
   fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
      if (err){
         console.log(err);
      }
      console.log(bytes + " bytes read");
      
      // Print only read bytes to avoid junk.
      if(bytes > 0){
         console.log(buf.slice(0, bytes).toString());
      }
   });
});

Теперь запустите main.js, чтобы увидеть результат —

$ node main.js

Проверьте вывод.

Going to open an existing file
File opened successfully!
Going to read the file
97 bytes read
Tutorials Point is giving self learning content
to teach the world in simple and easy way!!!!!

Закрытие файла

Синтаксис

Ниже приведен синтаксис для закрытия открытого файла.

fs.close(fd, callback)

параметры

Вот описание используемых параметров —

• fd — это дескриптор файла, возвращаемый методом file fs.open ().

• callback — это функция обратного вызова. Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

fd — это дескриптор файла, возвращаемый методом file fs.open ().

callback — это функция обратного вызова. Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

пример

Давайте создадим js-файл с именем main.js, имеющий следующий код —

var fs = require("fs");
var buf = new Buffer(1024);

console.log("Going to open an existing file");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
      return console.error(err);
   }
   console.log("File opened successfully!");
   console.log("Going to read the file");
   
   fs.read(fd, buf, 0, buf.length, 0, function(err, bytes) {
      if (err) {
         console.log(err);
      }

      // Print only read bytes to avoid junk.
      if(bytes > 0) {
         console.log(buf.slice(0, bytes).toString());
      }

      // Close the opened file.
      fs.close(fd, function(err) {
         if (err) {
            console.log(err);
         } 
         console.log("File closed successfully.");
      });
   });
});

Теперь запустите main.js, чтобы увидеть результат —

$ node main.js

Проверьте вывод.

Going to open an existing file
File opened successfully!
Going to read the file
Tutorials Point is giving self learning content
to teach the world in simple and easy way!!!!!

File closed successfully.

Усекать файл

Синтаксис

Ниже приведен синтаксис метода для усечения открытого файла:

fs.ftruncate(fd, len, callback)

параметры

Вот описание используемых параметров —

• fd — это дескриптор файла, возвращаемый функцией fs.open ().

• len — это длина файла, после которой файл будет обрезан.

• callback — это функция обратного вызова. Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

fd — это дескриптор файла, возвращаемый функцией fs.open ().

len — это длина файла, после которой файл будет обрезан.

callback — это функция обратного вызова. Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

пример

Давайте создадим js-файл с именем main.js, имеющий следующий код —

var fs = require("fs");
var buf = new Buffer(1024);

console.log("Going to open an existing file");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
      return console.error(err);
   }
   console.log("File opened successfully!");
   console.log("Going to truncate the file after 10 bytes");
   
   // Truncate the opened file.
   fs.ftruncate(fd, 10, function(err) {
      if (err) {
         console.log(err);
      } 
      console.log("File truncated successfully.");
      console.log("Going to read the same file"); 
      
      fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
         if (err) {
            console.log(err);
         }

         // Print only read bytes to avoid junk.
         if(bytes > 0) {
            console.log(buf.slice(0, bytes).toString());
         }

         // Close the opened file.
         fs.close(fd, function(err) {
            if (err) {
               console.log(err);
            } 
            console.log("File closed successfully.");
         });
      });
   });
});

Теперь запустите main.js, чтобы увидеть результат —

$ node main.js

Проверьте вывод.

Going to open an existing file
File opened successfully!
Going to truncate the file after 10 bytes
File truncated successfully.
Going to read the same file
Tutorials 
File closed successfully.

Удалить файл

Синтаксис

Ниже приведен синтаксис метода для удаления файла:

fs.unlink(path, callback)

параметры

Вот описание используемых параметров —

• путь — это имя файла, включая путь.

• callback — это функция обратного вызова. Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

путь — это имя файла, включая путь.

callback — это функция обратного вызова. Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

пример

Давайте создадим js-файл с именем main.js, имеющий следующий код —

var fs = require("fs");

console.log("Going to delete an existing file");
fs.unlink('input.txt', function(err) {
   if (err) {
      return console.error(err);
   }
   console.log("File deleted successfully!");
});

Теперь запустите main.js, чтобы увидеть результат —

$ node main.js

Проверьте вывод.

Going to delete an existing file
File deleted successfully!

Создать каталог

Синтаксис

Ниже приведен синтаксис метода для создания каталога:

fs.mkdir(path[, mode], callback)

параметры

Вот описание используемых параметров —

• путь — это имя каталога, включая путь.

• mode — это разрешение каталога, которое нужно установить. По умолчанию 0777.

• callback — это функция обратного вызова. Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

путь — это имя каталога, включая путь.

mode — это разрешение каталога, которое нужно установить. По умолчанию 0777.

callback — это функция обратного вызова. Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

пример

Давайте создадим js-файл с именем main.js, имеющий следующий код —

var fs = require("fs");

console.log("Going to create directory /tmp/test");
fs.mkdir('/tmp/test',function(err) {
   if (err) {
      return console.error(err);
   }
   console.log("Directory created successfully!");
});

Теперь запустите main.js, чтобы увидеть результат —

$ node main.js

Проверьте вывод.

Going to create directory /tmp/test
Directory created successfully!

Читать каталог

Синтаксис

Ниже приведен синтаксис метода для чтения каталога —

fs.readdir(path, callback)

параметры

Вот описание используемых параметров —

• путь — это имя каталога, включая путь.

• callback — это функция обратного вызова, которая получает два аргумента (err, files), где files — это массив имен файлов в каталоге, исключая ‘.’ а также ‘..’.

путь — это имя каталога, включая путь.

callback — это функция обратного вызова, которая получает два аргумента (err, files), где files — это массив имен файлов в каталоге, исключая ‘.’ а также ‘..’.

пример

Давайте создадим js-файл с именем main.js, имеющий следующий код —

var fs = require("fs");

console.log("Going to read directory /tmp");
fs.readdir("/tmp/",function(err, files) {
   if (err) {
      return console.error(err);
   }
   files.forEach( function (file) {
      console.log( file );
   });
});

Теперь запустите main.js, чтобы увидеть результат —

$ node main.js

Проверьте вывод.

Going to read directory /tmp
ccmzx99o.out
ccyCSbkF.out
employee.ser
hsperfdata_apache
test
test.txt

Удалить каталог

Синтаксис

Ниже приведен синтаксис метода для удаления каталога —

fs.rmdir(path, callback)

параметры

Вот описание используемых параметров —

• путь — это имя каталога, включая путь.

• callback — это функция обратного вызова. Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

путь — это имя каталога, включая путь.

callback — это функция обратного вызова. Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

пример

Давайте создадим js-файл с именем main.js, имеющий следующий код —

var fs = require("fs");

console.log("Going to delete directory /tmp/test");
fs.rmdir("/tmp/test",function(err) {
   if (err) {
      return console.error(err);
   }
   console.log("Going to read directory /tmp");
   
   fs.readdir("/tmp/",function(err, files) {
      if (err) {
         return console.error(err);
      }
      files.forEach( function (file) {
         console.log( file );
      });
   });
});

Теперь запустите main.js, чтобы увидеть результат —

$ node main.js

Проверьте вывод.

fs.rename (oldPath, newPath, callback)

Асинхронное переименование (). Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

fs.ftruncate (fd, len, callback)

Асинхронный ftruncate (). Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

fs.ftruncateSync (fd, len)

Синхронный ftruncate ().

fs.truncate (путь, лен, обратный вызов)

Асинхронное усечение (). Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

fs.truncateSync (путь, длина)

Синхронное усечение ().

fs.chown (путь, uid, gid, обратный вызов)

Асинхронный chown (). Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

fs.chownSync (путь, UID, GID)

Синхронный чоун ().

fs.fchown (fd, uid, gid, callback)

Асинхронный fchown (). Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

fs.fchownSync (fd, uid, gid)

Синхронный fchown ().

fs.lchown (путь, uid, gid, обратный вызов)

Асинхронный lchown (). Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

fs.lchownSync (путь, uid, gid)

Синхронный lchown ().

fs.chmod (путь, режим, обратный вызов)

Асинхронный chmod (). Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

fs.chmodSync (путь, режим)

Синхронный chmod ().

fs.fchmod (fd, mode, callback)

Асинхронный fchmod (). Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

fs.fchmodSync (fd, mode)

Синхронный fchmod ().

fs.lchmod (путь, режим, обратный вызов)

Асинхронный lchmod (). Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения. Доступно только в Mac OS X.

fs.lchmodSync (путь, режим)

Синхронный lchmod ().

fs.stat (путь, обратный вызов)

Асинхронный стат (). Обратный вызов получает два аргумента (err, stats), где stats является объектом fs.Stats.

fs.lstat (путь, обратный вызов)

Асинхронный lstat (). Обратный вызов получает два аргумента (err, stats), где stats является объектом fs.Stats. lstat () идентичен stat (), за исключением того, что если path является символической ссылкой, то сама ссылка является статовой, а не файлом, на который она ссылается.

fs.fstat (fd, обратный вызов)

Асинхронный fstat (). Обратный вызов получает два аргумента (err, stats), где stats является объектом fs.Stats. fstat () идентична stat (), за исключением того, что файл, который нужно проверить, определяется дескриптором файла fd.

fs.statSync (путь)

Синхронный стат (). Возвращает экземпляр fs.Stats.

fs.lstatSync (путь)

Синхронный lstat (). Возвращает экземпляр fs.Stats.

fs.fstatSync (FD)

Синхронный fstat (). Возвращает экземпляр fs.Stats.

fs.link (srcpath, dstpath, callback)

Асинхронная ссылка (). Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

fs.linkSync (srcpath, dstpath)

Синхронная ссылка ().

fs.symlink (srcpath, dstpath [, type], callback)

Асинхронная символическая ссылка (). Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения. Аргумент типа может быть установлен в «dir», «file» или «junction» (по умолчанию «file») и доступен только в Windows (игнорируется на других платформах). Обратите внимание, что точки соединения Windows требуют, чтобы путь назначения был абсолютным. При использовании ‘junction’, целевой аргумент автоматически нормализуется по абсолютному пути.

fs.symlinkSync (srcpath, dstpath [, type])

Синхронная символическая ссылка ().

fs.readlink (путь, обратный вызов)

Асинхронный readlink (). Обратный вызов получает два аргумента (err, linkString).

fs.realpath (путь [, кэш], обратный вызов)

Асинхронный реальный путь (). Обратный вызов получает два аргумента (err, resolvedPath). Может использовать process.cwd для разрешения относительных путей. Кэш — это объектный литерал отображаемых путей, который можно использовать для принудительного разрешения определенного пути или для исключения дополнительных вызовов fs.stat для известных реальных путей.

fs.realpathSync (путь [, кэш])

Синхронный реальный путь (). Возвращает разрешенный путь.

fs.unlink (путь, обратный вызов)

Асинхронный unlink (). Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

fs.unlinkSync (путь)

Синхронный unlink ().

fs.rmdir (путь, обратный вызов)

Асинхронный rmdir (). Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

fs.rmdirSync (путь)

Синхронный rmdir ().

fs.mkdir (путь [, режим], обратный вызов)

Асинхронный MKDIR (2). Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения. режим по умолчанию 0777.

fs.mkdirSync (путь [, режим])

Синхронный MKDIR ().

fs.readdir (путь, обратный вызов)

Асинхронный readdir (3). Читает содержимое каталога. Обратный вызов получает два аргумента (err, files), где files — это массив имен файлов в каталоге, исключая ‘.’ а также ‘..’.

fs.readdirSync (путь)

Синхронный readdir (). Возвращает массив имен файлов, исключая ‘.’ а также ‘..’.

fs.close (fd, обратный вызов)

Асинхронное закрытие (). Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

fs.closeSync (FD)

Синхронное закрытие ().

fs.open (путь, флаги [, режим], обратный вызов)

Открытие асинхронного файла.

fs.openSync (путь, флаги [, режим])

Синхронная версия fs.open ().

fs.utimes (путь, atime, mtime, обратный вызов)

fs.utimesSync (путь, atime, mtime)

Измените метки времени файла, на который указывает указанный путь.

fs.futimes (fd, atime, mtime, callback)

fs.futimesSync (fd, atime, mtime)

Измените временные метки файла, на которые ссылается предоставленный дескриптор файла.

fs.fsync (fd, обратный вызов)

Асинхронный Fsync. Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения.

fs.fsyncSync (FD)

Синхронный fsync.

fs.write (fd, буфер, смещение, длина [, позиция], обратный вызов)

Записать буфер в файл, указанный в fd.

fs.write (fd, data [, position [, encoding]], обратный вызов)

Записать данные в файл, указанный в fd. Если данные не являются экземпляром буфера, значение будет приведено к строке.

fs.writeSync (fd, буфер, смещение, длина [, позиция])

Синхронные версии fs.write (). Возвращает количество записанных байтов.

fs.writeSync (fd, data [, position [, encoding]])

Синхронные версии fs.write (). Возвращает количество записанных байтов.

fs.read (fd, буфер, смещение, длина, позиция, обратный вызов)

Считать данные из файла, указанного в fd.

fs.readSync (fd, буфер, смещение, длина, позиция)

Синхронная версия fs.read. Возвращает количество bytesRead.

fs.readFile (имя файла [, параметры], обратный вызов)

Асинхронно читает все содержимое файла.

fs.readFileSync (имя файла [, параметры])

Синхронная версия fs.readFile. Возвращает содержимое имени файла.

fs.writeFile (имя файла, данные [, параметры], обратный вызов)

Асинхронно записывает данные в файл, заменяя файл, если он уже существует. Данные могут быть строкой или буфером.

fs.writeFileSync (имя файла, данные [, параметры])

Синхронная версия fs.writeFile.

fs.appendFile (имя файла, данные [, параметры], обратный вызов)

Асинхронно добавлять данные в файл, создавая файл, если он не существует. Данные могут быть строкой или буфером.

fs.appendFileSync (имя файла, данные [, параметры])

Синхронная версия fs.appendFile.

fs.watchFile (имя файла [, параметры], слушатель)

Следите за изменениями в имени файла. Слушатель обратного вызова будет вызываться каждый раз, когда к файлу обращаются.

fs.unwatchFile (имя файла [, слушатель])

Хватит наблюдать за изменениями в имени файла. Если указан слушатель, удаляется только этот конкретный слушатель. В противном случае все слушатели будут удалены, и вы фактически перестанете просматривать имя файла.

fs.watch (имя файла [, параметры] [, слушатель])

Следите за изменениями имени файла, где имя файла — это файл или каталог. Возвращаемый объект — fs.FSWatcher.

fs.exists (путь, обратный вызов)

Проверьте, существует ли данный путь, проверив с файловой системой. Затем вызовите аргумент обратного вызова с истиной или ложью.

fs.existsSync (путь)

Синхронная версия fs.exists.

fs.access (путь [, режим], обратный вызов)

Проверяет права пользователя для файла, указанного путем. mode — необязательное целое число, которое определяет проверки доступности, которые должны быть выполнены.

fs.accessSync (путь [, режим])

Синхронная версия fs.access. Он выдает, если какие-либо проверки доступности не пройдены, и ничего не делает иначе.

fs.createReadStream (путь [, параметры])

Возвращает новый объект ReadStream.

fs.createWriteStream (путь [, параметры])

Возвращает новый объект WriteStream.

fs.symlink (srcpath, dstpath [, type], callback)

Асинхронная символическая ссылка (). Никакие аргументы, кроме возможного исключения, не передаются для обратного вызова завершения. Аргумент типа может быть установлен в «dir», «file» или «junction» (по умолчанию «file») и доступен только в Windows (игнорируется на других платформах). Обратите внимание, что точки соединения Windows требуют, чтобы путь назначения был абсолютным. При использовании ‘junction’, целевой аргумент автоматически нормализуется по абсолютному пути.