Blame view

node_modules/make-dir/readme.md 2.63 KB
2a09d1a4   liuqimichale   添加宜春 天水 宣化
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
  # make-dir [![Build Status: macOS & Linux](https://travis-ci.org/sindresorhus/make-dir.svg?branch=master)](https://travis-ci.org/sindresorhus/make-dir) [![Build status: Windows](https://ci.appveyor.com/api/projects/status/e0vtt8y600w91gcs/branch/master?svg=true)](https://ci.appveyor.com/project/sindresorhus/make-dir/branch/master) [![codecov](https://codecov.io/gh/sindresorhus/make-dir/branch/master/graph/badge.svg)](https://codecov.io/gh/sindresorhus/make-dir)
  
  > Make a directory and its parents if needed - Think `mkdir -p`
  
  
  ## Advantages over [`mkdirp`](https://github.com/substack/node-mkdirp)
  
  - Promise API *(Async/await ready!)*
  - Fixes many `mkdirp` issues: [#96](https://github.com/substack/node-mkdirp/pull/96) [#70](https://github.com/substack/node-mkdirp/issues/70) [#66](https://github.com/substack/node-mkdirp/issues/66)
  - 100% test coverage
  - CI-tested on macOS, Linux, and Windows
  - Actively maintained
  - Doesn't bundle a CLI
  
  
  ## Install
  
  ```
  $ npm install make-dir
  ```
  
  
  ## Usage
  
  ```
  $ pwd
  /Users/sindresorhus/fun
  $ tree
  .
  ```
  
  ```js
  const makeDir = require('make-dir');
  
  makeDir('unicorn/rainbow/cake').then(path => {
  	console.log(path);
  	//=> '/Users/sindresorhus/fun/unicorn/rainbow/cake'
  });
  ```
  
  ```
  $ tree
  .
  └── unicorn
      └── rainbow
          └── cake
  ```
  
  Multiple directories:
  
  ```js
  const makeDir = require('make-dir');
  
  Promise.all([
  	makeDir('unicorn/rainbow')
  	makeDir('foo/bar')
  ]).then(paths => {
  	console.log(paths);
  	/*
  	[
  		'/Users/sindresorhus/fun/unicorn/rainbow',
  		'/Users/sindresorhus/fun/foo/bar'
  	]
  	*/
  });
  ```
  
  
  ## API
  
  ### makeDir(path, [options])
  
  Returns a `Promise` for the path to the created directory.
  
  ### makeDir.sync(path, [options])
  
  Returns the path to the created directory.
  
  #### path
  
  Type: `string`
  
  Directory to create.
  
  #### options
  
  Type: `Object`
  
  ##### mode
  
  Type: `integer`<br>
  Default: `0o777 & (~process.umask())`
  
  Directory [permissions](https://x-team.com/blog/file-system-permissions-umask-node-js/).
  
  ##### fs
  
  Type: `Object`<br>
  Default: `require('fs')`
  
  Use a custom `fs` implementation. For example [`graceful-fs`](https://github.com/isaacs/node-graceful-fs).
  
  
  ## Related
  
  - [make-dir-cli](https://github.com/sindresorhus/make-dir-cli) - CLI for this module
  - [del](https://github.com/sindresorhus/del) - Delete files and directories
  - [globby](https://github.com/sindresorhus/globby) - User-friendly glob matching
  - [cpy](https://github.com/sindresorhus/cpy) - Copy files
  - [cpy-cli](https://github.com/sindresorhus/cpy-cli) - Copy files on the command-line
  - [move-file](https://github.com/sindresorhus/move-file) - Move a file
  
  
  ## License
  
  MIT © [Sindre Sorhus](https://sindresorhus.com)