Функция NodeJS fs-extra secureFile ()

Опубликовано: 26 Июля, 2021

Функция sureFile () проверяет, существует ли запрашиваемый пользователем файл. Если файл не существует, функция создаст новый файл. Даже если пользователь запрашивает файл, который находится внутри некоторого каталога, но если каталог не существует, функция сама создаст каталог и файл в этом каталоге. Если файл уже существует, он не будет изменен. createFile () - это другое имя функции sureFile (), что означает, что мы можем использовать функцию createFile () вместо sureFile (), и все будет работать как есть.

Синтаксис:

 fs.ensureFile (файл, обратный вызов)

или же

 fs.createFile (файл, обратный вызов)

Параметры:

  • file: это строка, содержащая путь к файлу.
  • обратный вызов: он будет вызываться после завершения задачи функцией. Это приведет либо к ошибке, либо к успеху. Промисы также можно использовать вместо функции обратного вызова.

Возвращаемое значение: ничего не возвращает.

Следуйте инструкциям по реализации функции:

  1. Модуль можно установить с помощью следующей команды:

     npm установить fs-extra
  2. После установки модуля вы можете проверить версию установленного модуля с помощью этой команды:

     npm ls fs-extra 

  3. Создайте файл с именем index.js и запросите в нем модуль fs-extra, используя следующую команду:

     const fs = require ('fs-extra');
  4. Чтобы запустить файл, напишите в терминале следующую команду:

     узел index.js

Структура проекта: структура проекта будет выглядеть следующим образом.

Пример 1: Создайте файл с именем file.txt. Мы передадим этот файл в нашу функцию



index.js




// Requiring module
const fs = require( "fs-extra" );
// file path
// File already exist
// No modification
// will be done in file
const file = "file.txt" ;
// Function call
// Using callback function
fs.createFile(file, (err) => {
if (err) return console.log(e);
console.log( "Successfully completed" );
});

Вывод: Поскольку мы создали файл ранее, функция не будет создавать новый файл и не будет изменять данные, содержащиеся в нашем файле.

 Успешно завершено

Пример 2: На этот раз мы будем передавать путь к файлу, которого не существует.

index.js




// Requiring module
const fs = require( "fs-extra" );
// file path
// Path contains a directory
// which does not exist
// It will create both
// directory and file
const file = "dir/file.txt" ;
// Function call
// Using Promises
fs.createFile(file)
.then(() => console.log( "Successfully Completed" ))
. catch ((err) => console.log(err));

Вывод: вы увидите, что теперь создается каталог с именем dir и он содержит файл с именем file.txt.

 Успешно завершено

Ссылка: https://github.com/jprichardson/node-fs-extra/blob/HEAD/docs/ensureFile.md