bconnorwhite / dir-exists-safe

Check if a directory exists without a try catch

Check if a directory exists without try catch.

• Returns true if the path exists and is a directory.
• Returns false if the path is not a directory, or does not exist.
• Returns undefined on other errors (for example, permission denied) rather than throwing.

Installation

yarn add dir-exists-safe

npm install dir-exists-safe

API

import { dirExists, dirExistsSync, Options } from "dir-exists-safe";

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

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

type Options = {
  /**
   * Return true if path is file. Default: `false`
   */
  includeFiles?: 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

MIT

Related Packages

• fs-safe: A simple fs wrapper that doesn't throw
• file-exists-safe: Check if a file exists without a try catch

dir-exists-safe's Issues

Release v1.0.0