Blame view

node_modules/mkdirp/readme.markdown 2.05 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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
  # mkdirp
  
  Like `mkdir -p`, but in node.js!
  
  [![build status](https://secure.travis-ci.org/substack/node-mkdirp.png)](http://travis-ci.org/substack/node-mkdirp)
  
  # example
  
  ## pow.js
  
  ```js
  var mkdirp = require('mkdirp');
      
  mkdirp('/tmp/foo/bar/baz', function (err) {
      if (err) console.error(err)
      else console.log('pow!')
  });
  ```
  
  Output
  
  ```
  pow!
  ```
  
  And now /tmp/foo/bar/baz exists, huzzah!
  
  # methods
  
  ```js
  var mkdirp = require('mkdirp');
  ```
  
  ## mkdirp(dir, opts, cb)
  
  Create a new directory and any necessary subdirectories at `dir` with octal
  permission string `opts.mode`. If `opts` is a non-object, it will be treated as
  the `opts.mode`.
  
  If `opts.mode` isn't specified, it defaults to `0777 & (~process.umask())`.
  
  `cb(err, made)` fires with the error or the first directory `made`
  that had to be created, if any.
  
  You can optionally pass in an alternate `fs` implementation by passing in
  `opts.fs`. Your implementation should have `opts.fs.mkdir(path, mode, cb)` and
  `opts.fs.stat(path, cb)`.
  
  ## mkdirp.sync(dir, opts)
  
  Synchronously create a new directory and any necessary subdirectories at `dir`
  with octal permission string `opts.mode`. If `opts` is a non-object, it will be
  treated as the `opts.mode`.
  
  If `opts.mode` isn't specified, it defaults to `0777 & (~process.umask())`.
  
  Returns the first directory that had to be created, if any.
  
  You can optionally pass in an alternate `fs` implementation by passing in
  `opts.fs`. Your implementation should have `opts.fs.mkdirSync(path, mode)` and
  `opts.fs.statSync(path)`.
  
  # usage
  
  This package also ships with a `mkdirp` command.
  
  ```
  usage: mkdirp [DIR1,DIR2..] {OPTIONS}
  
    Create each supplied directory including any necessary parent directories that
    don't yet exist.
    
    If the directory already exists, do nothing.
  
  OPTIONS are:
  
    -m, --mode   If a directory needs to be created, set the mode as an octal
                 permission string.
  
  ```
  
  # install
  
  With [npm](http://npmjs.org) do:
  
  ```
  npm install mkdirp
  ```
  
  to get the library, or
  
  ```
  npm install -g mkdirp
  ```
  
  to get the command.
  
  # license
  
  MIT