diff --git a/README.md b/README.md index 0231397..5af9d8d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@
-

dir-exists-safe

+ + dir-exists-safe + NPM @@ -19,11 +21,11 @@
-> 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` for other errors (for example, permission denied) rather than throwing. +- Returns `undefined` on other errors (for example, permission denied) rather than throwing. ## Installation @@ -60,6 +62,9 @@ function dirExistsSync(path: string): boolean | undefined; [MIT](https://opensource.org/licenses/MIT) +
+ ## Related Packages +- [fs-safe](https://www.npmjs.com/package/fs-safe): A simple fs wrapper that doesn't throw - [file-exists-safe](https://www.npmjs.com/package/file-exists-safe): Check if a file exists without a try catch diff --git a/assets/header.svg b/assets/header.svg new file mode 100644 index 0000000..82ee7a3 --- /dev/null +++ b/assets/header.svg @@ -0,0 +1,28 @@ + + +
+ +
+ +

dir-exists-safe

+
+
+
+
diff --git a/package.json b/package.json index 1036c34..3565453 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "dir-exists-safe", "version": "1.0.0", - "description": "Check if a directory exists without a try catch", + "description": "Check if a directory exists without try catch", "license": "MIT", "author": { "name": "Connor White", @@ -42,4 +42,4 @@ "npmpackagejsonlint": { "extends": "npm-package-json-lint-config-bob" } -} \ No newline at end of file +}