Как проверить наличие файла?
В документации для модуля fs
описано описание метода fs.exists(path, callback)
. Но, как я понимаю, он проверяет наличие только каталогов. И мне нужно проверить файл!
Как это можно сделать?
Как проверить наличие файла?
В документации для модуля fs
описано описание метода fs.exists(path, callback)
. Но, как я понимаю, он проверяет наличие только каталогов. И мне нужно проверить файл!
Как это можно сделать?
Почему бы просто не попробовать открыть файл? fs.open('YourFile', 'a', function (err, fd) { ... })
в любом случае, после минутного поиска попробуйте это:
var path = require('path');
path.exists('foo.txt', function(exists) {
if (exists) {
// do something
}
});
// or
if (path.existsSync('foo.txt')) {
// do something
}
For Node.js v0.12.x и higher
path.exists
и fs.exists
устарели
* Edit:
Изменено: else if(err.code == 'ENOENT')
к: else if(err.code === 'ENOENT')
Линтер жалуется, что двойные равные не являются тройными равными.
Использование fs.stat:
fs.stat('foo.txt', function(err, stat) {
if(err == null) {
console.log('File exists');
} else if(err.code === 'ENOENT') {
// file does not exist
fs.writeFile('log.txt', 'Some log\n');
} else {
console.log('Some other error: ', err.code);
}
});
Более простой способ сделать это синхронно.
if (fs.existsSync('/etc/file')) {
console.log('Found file');
}
В документе API говорится, как existsSync
работает:
Проверьте, существует ли данный путь, проверяя файловую систему.
Альтернативой для stat может быть использование нового fs.access(...)
:
сокращенная функция коротких обещаний для проверки:
s => new Promise(r=>fs.access(s, fs.F_OK, e => r(!e)))
Использование образца:
let checkFileExists = s => new Promise(r=>fs.access(s, fs.F_OK, e => r(!e)))
checkFileExists("Some File Location")
.then(bool => console.log(´file exists: ${bool}´))
расширенный способ Promise:
// returns a promise which resolves true if file exists:
function checkFileExists(filepath){
return new Promise((resolve, reject) => {
fs.access(filepath, fs.F_OK, error => {
resolve(!error);
});
});
}
или если вы хотите сделать это синхронно:
function checkFileExistsSync(filepath){
let flag = true;
try{
fs.accessSync(filepath, fs.F_OK);
}catch(e){
flag = false;
}
return flag;
}
fs.exists(path, callback)
и fs.existsSync(path)
устарели, см. https://nodejs.org/api/fs.html#fs_fs_exists_path_callback и https://nodejs.org/api/fs.html#fs_fs_existssync_path.
Чтобы проверить наличие файла синхронно, можно использовать ie. fs.statSync(path)
. Объект fs.Stats
будет возвращен, если файл существует, см. https://nodejs.org/api/fs.html#fs_class_fs_stats, в противном случае возникает ошибка, которая будет улавливаться оператором try/catch.
var fs = require('fs'),
path = '/path/to/my/file',
stats;
try {
stats = fs.statSync(path);
console.log("File exists.");
}
catch (e) {
console.log("File does not exist.");
}
Старая версия до V6: здесь документация
const fs = require('fs');
fs.exists('/etc/passwd', (exists) => {
console.log(exists ? 'it\ there' : 'no passwd!');
});
// or Sync
if (fs.existsSync('/etc/passwd')) {
console.log('it\ there');
}
UPDATE
Новые версии из V6: документация для fs.stat
fs.stat('/etc/passwd', function(err, stat) {
if(err == null) {
//Exist
} else if(err.code == 'ENOENT') {
// NO exist
}
});
fs.exists
устарел с версии 1.0.0. Вы можете использовать fs.stat
вместо этого.
var fs = require('fs');
fs.stat(path, (err, stats) => {
if ( !stats.isFile(filename) ) { // do this
}
else { // do this
}});
Вот ссылка на документацию fs.stats
@Fox: отличный ответ! Здесь немного расширения с некоторыми опциями. Это то, что я использовал в последнее время в качестве решения для перехода:
var fs = require('fs');
fs.lstat( targetPath, function (err, inodeStatus) {
if (err) {
// file does not exist-
if (err.code === 'ENOENT' ) {
console.log('No file or directory at',targetPath);
return;
}
// miscellaneous error (e.g. permissions)
console.error(err);
return;
}
// Check if this is a file or directory
var isDirectory = inodeStatus.isDirectory();
// Get file size
//
// NOTE: this won't work recursively for directories-- see:
// http://stackoverflow.com/a/7550430/486547
//
var sizeInBytes = inodeStatus.size;
console.log(
(isDirectory ? 'Folder' : 'File'),
'at',targetPath,
'is',sizeInBytes,'bytes.'
);
}
P.S. проверьте fs-extra, если вы еще не используете it--, это довольно мило. https://github.com/jprichardson/node-fs-extra)
Есть много неточных комментариев о fs.existsSync()
, которые устарели; это не так.
https://nodejs.org/api/fs.html#fs_fs_existssync_path
Обратите внимание, что fs.exists() устарел, но fs.existsSync() не является.
async/await
с использованием util.promisify
от Node 8:
const fs = require('fs');
const { promisify } = require('util');
const stat = promisify(fs.stat);
describe('async stat', () => {
it('should not throw if file does exist', async () => {
try {
const stats = await stat(path.join('path', 'to', 'existingfile.txt'));
assert.notEqual(stats, null);
} catch (err) {
// shouldn't happen
}
});
});
describe('async stat', () => {
it('should throw if file does not exist', async () => {
try {
const stats = await stat(path.join('path', 'to', 'not', 'existingfile.txt'));
} catch (err) {
assert.notEqual(err, null);
}
});
});
fs.statSync(path, function(err, stat){
if(err == null) {
console.log('File exists');
//code when all ok
}else if (err.code == "ENOENT") {
//file doesn't exist
console.log('not file');
}
else {
console.log('Some other error: ', err.code);
}
});
После нескольких экспериментов я нашел следующий пример, используя fs.stat
, чтобы быть хорошим способом асинхронной проверки наличия файла. Он также проверяет, что ваш "файл" "действительно-есть файл" (а не каталог).
Этот метод использует Promises, предполагая, что вы работаете с асинхронной кодовой базой:
const fileExists = path => {
return new Promise((resolve, reject) => {
try {
fs.stat(path, (error, file) => {
if (!error && file.isFile()) {
return resolve(true);
}
if (error && error.code === 'ENOENT') {
return resolve(false);
}
});
} catch (err) {
reject(err);
}
});
};
Если файл не существует, обещание по-прежнему разрешается, хотя false
. Если файл существует, и он является каталогом, то он разрешает true
. Любые ошибки, пытающиеся прочитать файл, будут reject
обещание самой ошибки.
Хорошо, я сделал это так, как показано на https://nodejs.org/api/fs.html#fs_fs_access_path_mode_callback
fs.access('./settings', fs.constants.F_OK | fs.constants.R_OK | fs.constants.W_OK, function(err){
console.log(err ? 'no access or dir doesnt exist' : 'R/W ok');
if(err && err.code === 'ENOENT'){
fs.mkdir('settings');
}
});
Есть ли проблемы с этим?
Современный асинхронный/ожидающий путь (Узел 12.8.x)
const fileExists = async path => !!(await fs.promises.stat(path).catch(e => false));
const main = async () => {
console.log(await fileExists('/path/myfile.txt'));
}
main();
Нам нужно использовать fs.stat() or fs.access()
, потому что fs.exists(path, callback)
теперь устарела
Еще один хороший способ - fs-extra.
в старые времена, прежде чем сесть, я всегда проверяю, есть ли там стул, тогда я сижу еще. У меня есть альтернативный план, как сидеть на тренере. Теперь node.js сайт предлагает просто пойти (нет необходимости проверять), и ответ выглядит следующим образом:
fs.readFile( '/foo.txt', function( err, data )
{
if(err)
{
if( err.code === 'ENOENT' )
{
console.log( 'File Doesn\'t Exist' );
return;
}
if( err.code === 'EACCES' )
{
console.log( 'No Permission' );
return;
}
console.log( 'Unknown Error' );
return;
}
console.log( data );
} );
код, взятый из http://fredkschott.com/post/2014/03/understanding-error-first-callbacks-in-node-js/ с марта 2014 года и слегка модифицированный для соответствия компьютеру. Он также проверяет разрешение - удалите разрешение для тестирования chmod a-r foo.txt
function fileExists(path, cb){
return fs.access(path, fs.constants.F_OK,(er, result)=> cb(!err && result)) //F_OK checks if file is visible, is default does no need to be specified.
}
docs говорят, что вы должны использовать access()
в качестве замены устаревшего exists()
function fileExists(path, cb){
return new Promise((accept,deny) =>
fs.access(path, fs.constants.F_OK,(er, result)=> cb(!err && result))
);
}
var fs = require('fs-extra')
await fs.pathExists(filepath)
Как вы видите намного проще. И преимущество перед обещанием состоит в том, что у вас есть полные типирования с этим пакетом (полный intellisense/ typescript)! В большинстве случаев вы уже включили эту библиотеку, потому что (+ -10.000) другие библиотеки зависят от нее.
Вы можете использовать fs.stat
, чтобы проверить, является ли цель файлом или каталогом, и вы можете использовать fs.access
, чтобы проверить, можете ли вы записать/прочитать/выполнить файл. (не забудьте использовать path.resolve
, чтобы получить полный путь к цели)
Документация:
Полный пример (TypeScript)
import * as fs from 'fs';
import * as path from 'path';
const targetPath = path.resolve(process.argv[2]);
function statExists(checkPath): Promise<fs.Stats> {
return new Promise((resolve) => {
fs.stat(checkPath, (err, result) => {
if (err) {
return resolve(undefined);
}
return resolve(result);
});
});
}
function checkAccess(checkPath: string, mode: number = fs.constants.F_OK): Promise<boolean> {
return new Promise((resolve) => {
fs.access(checkPath, mode, (err) => {
resolve(!err);
});
});
}
(async function () {
const result = await statExists(targetPath);
const accessResult = await checkAccess(targetPath, fs.constants.F_OK);
const readResult = await checkAccess(targetPath, fs.constants.R_OK);
const writeResult = await checkAccess(targetPath, fs.constants.W_OK);
const executeResult = await checkAccess(targetPath, fs.constants.X_OK);
const allAccessResult = await checkAccess(targetPath, fs.constants.F_OK | fs.constants.R_OK | fs.constants.W_OK | fs.constants.X_OK);
if (result) {
console.group('stat');
console.log('isFile: ', result.isFile());
console.log('isDir: ', result.isDirectory());
console.groupEnd();
}
else {
console.log('file/dir does not exist');
}
console.group('access');
console.log('access:', accessResult);
console.log('read access:', readResult);
console.log('write access:', writeResult);
console.log('execute access:', executeResult);
console.log('all (combined) access:', allAccessResult);
console.groupEnd();
process.exit(0);
}());