Blame view

node_modules/is-directory/README.md 2.34 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
  # 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._