Check if a file exists without try catch.
- Returns
true
if the path exists and is a file. - Returns
false
if the path is not a file, or does not exist. - Returns
undefined
on other errors (for example, permission denied) rather than throwing.
Installation
yarn add file-exists-safe
npm install file-exists-safe
API
import { fileExists, fileExistsSync, Options } from "file-exists-safe";
function fileExists(path: string, options?: Options): Promise<boolean | undefined>;
function fileExistsSync(path: string, options?: Options): boolean | undefined;
type Options = {
/**
* Return true if path is directory. Default: `false`
*/
includeDirectories?: boolean;
}
- @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.
Related Packages
- fs-safe: A simple fs wrapper that doesn't throw
- dir-exists-safe: Check if a directory exists without a try catch