Blame view

node_modules/make-dir/index.d.ts 1.07 KB
7820380e   “wangming”   1
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
  /// <reference types="node"/>
  import * as fs from 'fs';
  
  export interface Options {
  	/**
  	 * Directory [permissions](https://x-team.com/blog/file-system-permissions-umask-node-js/).
  	 *
  	 * @default 0o777 & (~process.umask())
  	 */
  	readonly mode?: number;
  
  	/**
  	 * Use a custom `fs` implementation. For example [`graceful-fs`](https://github.com/isaacs/node-graceful-fs).
  	 *
  	 * Using a custom `fs` implementation will block the use of the native `recursive` option if `fs.mkdir` or `fs.mkdirSync` is not the native function.
  	 *
  	 * @default require('fs')
  	 */
  	readonly fs?: typeof fs;
  }
  
  /**
   * Make a directory and its parents if needed - Think `mkdir -p`.
   *
   * @param path - Directory to create.
   * @returns A `Promise` for the path to the created directory.
   */
  export default function makeDir(
  	path: string,
  	options?: Options
  ): Promise<string>;
  
  /**
   * Synchronously make a directory and its parents if needed - Think `mkdir -p`.
   *
   * @param path - Directory to create.
   * @returns The path to the created directory.
   */
  export function sync(path: string, options?: Options): string;