fs-check

fs check

A simple Node fs wrapper to check by a boolean if a path exists, is a directory or a file.

Synchronous version at the moment.

Installation

npm install fs-check --save

How to use it

Require module

var fsc = require('fs-check');

Synchronous methods

existsSync(path)

var path = '~/love-letter.txt';
if (!existsSync(path)) {
  console.log('You can create a file with this path without overriding it...');
}

isDirSync(path)

function anExampleSetup(pathToCopyFile) {
  if (isDirSync(pathToCopyFile)) {
    console.log('Okay copy this file in this directory path.');
  }
}

isFileSync(path)

var pathToDefaultConfig = './env.json';
var pathToEnvConfig = './.env';
if (!isFileSync(pathToDefaultConfig) && !isFileSync(pathToEnvConfig)) {
    console.log('No configuration file, create a default config file.');
}

Contributing

Any advices or help will be greatly welcome.

TODO :

• Test application (very important)
• Add asynchronous support

Notes

This project was initially made to help me quickly check if a file or directory exists without opening it. This may not match your attempts or project needs. Please feel free to send issues, pr, fork, adapt, add features, ...

Licence

The MIT License (MIT) Copyright © 2016 Adrien Valcke

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.