Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

docs: Fix signature of fs.readFile to include encoding #558

Merged
alexandrtovmach merged 3 commits into from
Apr 25, 2020
Merged

docs: Fix signature of fs.readFile to include encoding #558

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9bb509b
Fix signature of fs.readFile to include encoding
dahmian Apr 16, 2020
6a9edcd
Merge branch 'master' into patch-1
alexandrtovmach Apr 25, 2020
2643334
Update src/documentation/0043-node-reading-files/index.md
alexandrtovmach Apr 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions src/documentation/0043-node-reading-files/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ authors: flaviocopes, MylesBorins, fhemberger, LaRuaNa, ahmadawais
section: Getting Started
---

The simplest way to read a file in Node.js is to use the `fs.readFile()` method, passing it the file path and a callback function that will be called with the file data (and the error):
The simplest way to read a file in Node.js is to use the `fs.readFile()` method, passing it the file path, encoding and a callback function that will be called with the file data (and the error):

```js
const fs = require('fs')

fs.readFile('/Users/joe/test.txt', (err, data) => {
fs.readFile('/Users/joe/test.txt', 'utf8' , (err, data) => {
if (err) {
console.error(err)
return
Expand All @@ -32,8 +32,6 @@ try {
}
```

The default encoding is utf8, but you can specify a custom encoding using a second parameter.

Both `fs.readFile()` and `fs.readFileSync()` read the full content of the file in memory before returning the data.

This means that big files are going to have a major impact on your memory consumption and speed of execution of the program.
Expand Down