is-directory

What is is-directory?

The 'is-directory' npm package is a simple utility that allows developers to check if a given path is a directory. It provides a straightforward API for synchronous and asynchronous checks, making it useful in various file system operations where such validation is necessary.

What are is-directory's main functionalities?

Synchronous Directory Check

This feature allows you to synchronously check if a specified path is a directory. It is useful when you need an immediate result and are working in a synchronous code context.

const isDirectory = require('is-directory');
const result = isDirectory.sync('/path/to/directory');
console.log(result); // outputs true if path is a directory, false otherwise

Asynchronous Directory Check

This feature provides an asynchronous method to check if a path is a directory. It is particularly useful in non-blocking environments where operations should not interrupt the main application flow.

const isDirectory = require('is-directory');
isDirectory('/path/to/directory', function(err, dir) {
  if (err) throw err;
  console.log(dir); // outputs true if path is a directory, false otherwise
});

Other packages similar to is-directory

fs-extra

fs-extra is an extension of the native 'fs' module in Node.js. It includes additional methods like 'ensureDir' which can be used to check if a directory exists and create it if it doesn't. This package offers more comprehensive file system operations compared to 'is-directory' which focuses only on directory checking.

node-dir

node-dir provides utilities for reading directories, files, and their paths. It can check if a path is a directory, but it also includes capabilities to read directories recursively, which is not a feature of 'is-directory'. This makes node-dir suitable for applications that require more than just directory checking.

README

is-directory

Returns true if a filepath exists on the file system and it's directory.

Install

Install with npm:

$ npm install is-directory --save

Usage

var isDirectory = require('is-directory');

isDirectory('node_modules', function(err, dir) {
  if (err) throw err;
  console.log(dir);
  //=> true
});

isDirectory.sync('README.md');
//=> false

Related projects

You might also be interested in these projects:

• is-absolute: Polyfill for node.js path.isAbolute. Returns true if a file path is absolute. | homepage
• is-glob: Returns true if the given string looks like a glob pattern or an extglob pattern.… more | homepage
• is-relative: Returns true if the path appears to be relative. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb, v0.9.0, on May 21, 2016.