aboutsummaryrefslogtreecommitdiff
path: root/node_modules/make-dir/index.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/make-dir/index.d.ts')
-rw-r--r--node_modules/make-dir/index.d.ts39
1 files changed, 39 insertions, 0 deletions
diff --git a/node_modules/make-dir/index.d.ts b/node_modules/make-dir/index.d.ts
new file mode 100644
index 0000000..3e1529c
--- /dev/null
+++ b/node_modules/make-dir/index.d.ts
@@ -0,0 +1,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;