JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 67
  • Score
    100M100P100Q59007F

Returns file content as a UTF-8 string. Returns null if file does not exist (or is a directory) instead of throwing an Error.

Package Exports

  • read-file-string

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (read-file-string) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

read-file-string

License Sponsor read-file-string
Build status Commits since v1.1.2 Last commit Issues
Latest version on npm Dependents Downloads

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

read-file-string on npm

npm install --save read-file-string@^1.1.2

read-file-string on Yarn

yarn add read-file-string@^1.1.2

@jaid/read-file-string on GitHub Packages
(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 git@github.com: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 <jaid.jsx@gmail.com> (https://github.com/jaid)