read-file-string
v1.1.2
Published
Returns file content as a UTF-8 string. Returns null if file does not exist (or is a directory) instead of throwing an Error.
Downloads
67
Maintainers
Readme
read-file-string
Returns file content as a UTF-8 string. Returns null if file does not exist (or is a directory) instead of throwing an Error.
Installation
npm install --save read-file-string@^1.1.2
yarn add read-file-string@^1.1.2
(if configured properly)
npm install --save @jaid/read-file-string@^1.1.2
Example
import readFileString from "read-file-string"
readFileString("./existingFile.txt").then(result => {
})
readFileString("./doesNotExist.txt").then(result2 => {
})
Variable result
will be:
"the file contents"
Variable result2
will be:
null
Development
Setting up:
git clone [email protected]:jaid/read-file-string.git
cd read-file-string
npm install
Testing:
npm run test:dev
Testing in production environment:
npm run test
License
MIT License
Copyright © 2021, Jaid <[email protected]> (https://github.com/jaid)