fs-readfile-promise

WebJar for fs-readfile-promise

License	MIT
GroupId	org.webjars.npm
ArtifactId	fs-readfile-promise
Last Version	2.0.1
Release Date	Feb 9, 2020
Type	jar
Description	fs-readfile-promise WebJar for fs-readfile-promise
Project URL	https://www.webjars.org
Source Code Management	https://github.com/shinnn/fs-readfile-promise

Download fs-readfile-promise

Filename	Size
fs-readfile-promise-2.0.1.pom
fs-readfile-promise-2.0.1.jar	5 KB
fs-readfile-promise-2.0.1-sources.jar	22 bytes
fs-readfile-promise-2.0.1-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/fs-readfile-promise/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>fs-readfile-promise</artifactId>
    <version>2.0.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/fs-readfile-promise/
implementation 'org.webjars.npm:fs-readfile-promise:2.0.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/fs-readfile-promise/
implementation ("org.webjars.npm:fs-readfile-promise:2.0.1")

Apache Buildr

'org.webjars.npm:fs-readfile-promise:jar:2.0.1'

Apache Ivy

<dependency org="org.webjars.npm" name="fs-readfile-promise" rev="2.0.1">
  <artifact name="fs-readfile-promise" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='fs-readfile-promise', version='2.0.1')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "fs-readfile-promise" % "2.0.1"

Leiningen

[org.webjars.npm/fs-readfile-promise "2.0.1"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.webjars.npm : graceful-fs	jar	[4.1.2,5)

Project Modules

There are no modules declared in this project.

fs-readfile-promise

Promisified version of fs.readFile

const readFilePromise = require('fs-readfile-promise');

(async () => {
  const buffer = await readPromise('path/to/a/file');
  buffer.toString(); //=> '... file contents ...'
})();

Based on the principle of modular programming, this module has only one functionality readFile, unlike other Promise-based file system modules. If you'd like to use a bunch of other fs methods in the Promise way, choose other modules such as q-io and promise-fs.

Installation

Use npm.

npm install fs-readfile-promise

API

const readFilePromise = require('fs-readfile-promise');

readFile(path [, options])

path: string Buffer Uint8Array URL integer
options: Object (fs.readFile options) or string (encoding)
Return: Promise<Buffer|string>

(async () => {
  await readFilePromise('src.txt'); //=> <Buffer 48 69 2e>
  await readFilePromise('src.txt', 'utf8'); //=> 'Hi.'
  await readFilePromise('src.txt', {encoding: 'base64'}); //=> 'SGku'
})();

Related projects

• read-utf8-file — Promisified fs.readFile with automatic BOM stripping, encoding validation and stringification
• read-multiple-files — Read multiple files Observable way

License

ISC License © 2017 - 2018 Shinnosuke Watanabe

Versions

Version
2.0.1 Feb 9, 2020