# is-directory

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

Latest version **0.3.1** (published 2016-05-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install is-directory
pnpm add is-directory
yarn add is-directory
bun add is-directory
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.1 |
| Published | 2016-05-21 |
| First published | 2014-07-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 27 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | dir, directories, directory, dirs, file, filepath, files, fp, fs, node, node.js, path, paths, system |

## Links

- npm: https://www.npmjs.com/package/is-directory
- Repository: https://github.com/jonschlinkert/is-directory
- Issues: https://github.com/jonschlinkert/is-directory/issues
- npm.io page: https://npm.io/package/is-directory

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 0.3.1 (latest) — 2016-05-21
- 0.3.0 — 2015-03-22
- 0.2.3 — 2014-11-17
- 0.2.2 — 2014-09-06
- 0.2.1 — 2014-09-05
- 0.2.0 — 2014-09-05
- 0.1.1 — 2014-07-19
- 0.1.0 — 2014-07-06

## README

# is-directory [![NPM version](https://img.shields.io/npm/v/is-directory.svg?style=flat)](https://www.npmjs.com/package/is-directory) [![NPM downloads](https://img.shields.io/npm/dm/is-directory.svg?style=flat)](https://npmjs.org/package/is-directory) [![Build Status](https://img.shields.io/travis/jonschlinkert/is-directory.svg?style=flat)](https://travis-ci.org/jonschlinkert/is-directory)

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

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install is-directory --save
```

## Usage

```js
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](https://www.npmjs.com/package/is-absolute): Polyfill for node.js `path.isAbolute`. Returns true if a file path is absolute. | [homepage](https://github.com/jonschlinkert/is-absolute)
* [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern.… [more](https://www.npmjs.com/package/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob)
* [is-relative](https://www.npmjs.com/package/is-relative): Returns `true` if the path appears to be relative. | [homepage](https://github.com/jonschlinkert/is-relative)

## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/is-directory/issues/new).

## Building docs

Generate readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm install verb && npm run docs
```

Or, if [verb](https://github.com/verbose/verb) is installed globally:

```sh
$ verb
```

## Running tests

Install dev dependencies:

```sh
$ npm install -d && npm test
```

## Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

## License

Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/jonschlinkert/is-directory/blob/master/LICENSE).

***

_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on May 21, 2016._

---
_Source: https://npm.io/package/is-directory · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._