Socket
Socket
Sign inDemoInstall

is-directory

Package Overview
Dependencies
0
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    is-directory

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


Version published
Weekly downloads
5M
decreased by-19.12%
Maintainers
1
Install size
6.46 kB
Created
Weekly downloads
 

Package description

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

Readme

Source

is-directory NPM version NPM downloads Build Status

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

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

License

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


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

Keywords

FAQs

Last updated on 21 May 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc