🚀 Socket Launch Week 🚀 Day 2: Introducing Repository Labels and Security Policies.Learn More
Socket
Sign inDemoInstall
Socket

read-file-safe

Package Overview
Dependencies
Maintainers
1
Versions
14
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

read-file-safe

Read files without try catch

2.1.1
latest
Source
npm
Version published
Weekly downloads
11K
-10.51%
Maintainers
1
Weekly downloads
 
Created
Source

read-file-safe

NPM TypeScript Coverage Status

Read files without try catch.

If I should maintain this repo, please ⭐️ GitHub stars

DM me on Twitter if you have questions or suggestions. Twitter

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>

Dev Dependencies

  • autorepo: Autorepo abstracts away your dev dependencies, providing a single command to run all of your scripts.

License license

MIT - MIT License


Keywords

read

FAQs

Package last updated on 19 Sep 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts