Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 582 Bytes

README.md

File metadata and controls

27 lines (20 loc) · 582 Bytes

ez-file

No fuss utility for fetching the contents of a file.

Installation:

npm install ez-file
# or
yarn add ez-file

Works for relative paths, absolute paths, and module paths (node_modules folder).

Usage:

const { file } = require("ez-file");

const contents1 = file("./relative/path/to/file.txt");
const contents2 = file("/absolute/path/to/file.txt");
const contents3 = file("module/path/to/file.txt");
const contents4 = file("./path/to/file.txt", {
  // override options passed to fs.readFileSync()
  encoding: "base64", // defaults to "utf-8"
});