write-dir-safe

Create directories and their parents recursively

Usage no npm install needed!

<script type="module">
  import writeDirSafe from 'https://cdn.skypack.dev/write-dir-safe';
</script>

README

write-dir-safe

NPM

TypeScript

Coverage Status

Create directories and their parents recursively.

Returns true if directory now exists.
Returns false if unable to create directory.
Returns undefined on other errors (ex: permission denied) rather than throwing.

Installation

yarn add write-dir-safe

npm install write-dir-safe

API

import { writeDir, writeDirSync, Options } from "write-dir-safe";

function writeDir(path: string, options: Options): Promise<boolean | undefined>;

function writeDirSync(path: string, options: Options): boolean | undefined;

type Options = {
  /**
   * Recursively create parent directories as well. Default: `true`
   */
  recursive?: boolean;
}

Dev Dependencies

@bconnorwhite/bob: Bob is a toolkit for typescript projects
@types/mock-fs: TypeScript definitions for mock-fs
@types/node: TypeScript definitions for Node.js
mock-fs: A configurable mock file system. You know, for testing.

License

Related Packages

fs-safe: A simple fs wrapper that doesn't throw
read-dir-safe: Read directories recursively or non-recursively
remove-dir-safe: Remove directories recursively or non-recursively
read-file-safe: Read files without try catch
write-file-safe: Write files, and parent directories if necessary
remove-file-safe: Remove a file without try catch