bconnorwhite/write-dir-safe

Create directories and their parents recursively

write-dir-safe

Create directories and their parents recursively.

If I should maintain this repo, please ⭐️

DM me on Twitter if you have questions or suggestions.

---

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

pnpm add write-dir-safe

Usage

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

• @types/mock-fs: TypeScript definitions for mock-fs
• @types/node: TypeScript definitions for Node.js
• autorepo: Autorepo abstracts away your dev dependencies, providing a single command to run all of your scripts.
• mock-fs: A configurable mock file system. You know, for testing.
• read-file-safe: Read files without try catch

License

MIT - MIT 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

write-dir-safe's Issues

Release v1.0.0