read-file-safe
v2.1.1
Published
Read files without try catch
Downloads
30,589
Maintainers
Readme
If I should maintain this repo, please ⭐️
DM me on Twitter if you have questions or suggestions.
This package handles filesystem errors for you. If a file does not exist or cannot be accessed, undefined
is returned instead of throwing an error.
Installation
yarn add read-file-safe
npm install read-file-safe
pnpm add read-file-safe
Usage
By default, readFile
and readFileSync
return a string:
import { readFile, readFileSync } from "read-file-safe";
const path = "./path/to/file.ext";
const file = readFile(path); // Promise<string | undefined>
const file = readFileSync(path); // string | undefined
Return Type
Setting the buffer
option to true
will return a Buffer
instead of a string:
import { readFile, readFileSync } from "read-file-safe";
const file = readFile(path, { buffer: true }); // Promise<Buffer | undefined>
const file = readFileSync(path, { buffer: true }); // Buffer | undefined
Decompression
Setting the compression
option will decompress the file before returning it. Both gzip
and brotli
are supported:
import { readFile, readFileSync } from "read-file-safe";
const file = readFile(path, { compression: "gzip" }); // Promise<string | undefined>
const file = readFile(path, { compression: "brotli" }); // Promise<string | undefined>
- autorepo: Autorepo abstracts away your dev dependencies, providing a single command to run all of your scripts.
MIT - MIT License
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