Why is fs.readFile returning a buffer?

Bryce Johnson picture Bryce Johnson · Oct 9, 2014 · Viewed 7.5k times · Source

I have referred to this question already. That is, I don't believe my problem lies in a misunderstanding of async.

Here is the relevant part of my module.

var fs = require('fs');
var q = require('q');
var u = require('../utils/json');

var indexFile = './data/index.json';

function getIndex() {
    var def = q.defer(),
        promise = def.promise,
        obj;

    fs.readFile(indexFile, function(err,data) {
        if (err) {
            throw err;
            def.reject(err);
        }
        console.log('data', data);

        def.resolve(obj);
    });

    return promise;
}

When I log 'data', I'm getting a buffer (below), rather than the JSON content of that file.

<Buffer 5b 7b 22 68 65 6c 6c 6f 22 3a 22 77 6f 72 6c 64 22 7d 5d>

Any thoughts on why?

Answer

aarosil picture aarosil · Oct 9, 2014

As per the Node.js API docs for 'fs' module, if the encoding option isn't passed, the read functions will return a buffer.

If you pass a value for encoding, it will return a string with that encoding:

fs.readFile('/etc/passwd', 'utf-8', callback)