read-file-safe

Read files without try catch.

• Returns string or Buffer if successful.
• Returns undefined on error rather than throwing.

Installation

yarn add read-file-safe

npm install read-file-safe

API

import { readFile, readFileSync } from "read-file-safe";

readFile(path: string) => Promise<string | undefined>;

readFileSync(path: string) => string | undefined;

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
• write-file-safe: Write files, and parent directories if necessary
• remove-file-safe: Remove files without try catch
• read-dir-safe: Read directories recursively or non-recursively
• write-dir-safe: Create directories and their parents recursively
• remove-dir-safe: Remove directories recursively or non-recursively

Changelog

1.0.10 (2020-10-05)

Bug Fixes

• export Args and ReturnValue (ef71108)