return values with async function in nodejs

Question

I have this function:

exports.readPartial = function(html, values, response) {
  fs.readFile(__dirname + "/../html/partials/" + html, function(error, file) {
  if(error) { this.loadError(response, error); }
  else {
   console.log("\t--> partial found: " + file);
   return file; // FILE VALUE
  }
  });
}

When that function is called it should return the value of "file". However, when calling return file; im actually returning the value in the anonymous function I passed as an argument. What is the right way to return this value on async programming with nodejs? Using var that = this; ?

Got confused pretty confused with this style of programming.

Golo Roden · Accepted Answer · 2012-09-23 17:21:59Z

1

Your readPartial functions relies on an asynchronous function readFile. So it gets asynchronous, too.

Now you have several options on how to solve this problem:

Use the synchronous version of fs.readFile, which is fs.readFileSync (see http://nodejs.org/api/fs.html#fs_fs_readfilesync_filename_encoding). Then you are able to return the result as usual.
Change your function to use a callback, too.

So, basically this means: Either both functions have to be asynchronous, or both need to be synchronous.

Of these two options, I'd prefer the asynchronous one to use a callback as well: This is exactly what is Node.js' core competency - asynchronous, non-blocking I/O. So if you do not have strong reasons against it, stick with the asynchronous version and use callbacks.

Of course, you may be interested in what other options exist. So, here they are (ALTHOUGH I WOULD NOT RECOMMEND IT):

Call fs.readFile and "wait" for its callback to return. This basically means active waiting with a while(true) loop, and is definitely considered bad practice. Anyway, technically it is viable. For the rare case you really want to do this, or you are simply interested in how one might implement something like this, check out syncasync.js.

edited Sep 23, 2012 at 17:21

answered Sep 23, 2012 at 17:16

Golo Roden

152k102 gold badges318 silver badges445 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

jviotti Over a year ago

so, is recommended to read files in Sync mode? What about if multiple host are using the nodejs application? some large file will interrupt the other hosts. Is still recommended to use readFileSync?

Golo Roden Over a year ago

No, the favorite choice would be to go the asynchronous way and use a callback. That's what Node.js is especially good at: Asynchronous I/O. (Updated my answer)

Collectives™ on Stack Overflow

return values with async function in nodejs

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related