Best way to return values from async functions in javascript

Question

I'm using the twit library for nodejs which have async calls, and I made functions like this:

function getUserFromSearch(phrase) {
    T.get('search/tweets', { q: phrase+' lang:pt', count: 1 }, function(err, data, response) {
    data['statuses'].forEach(function(element) {
        var result = "maybe";
        say('getting user profile from search for '+phrase, result);
        console.log(element);
        return element['user']['screen_name'];
    }, this);
    })
}

Since T.get() is executed asynchonously, whenever I do

var username = getUserFromSearch('banana');

I get username=undefined because it takes time to return things. The obvious solution would be to implement a callback like this:

function getUserFromSearch(phrase, callback) {
    T.get('search/tweets', { q: phrase+' lang:pt', count: 1 }, function(err, data, response) {
    data['statuses'].forEach(function(element) {
        var result = "maybe";
        say('getting user profile from search for '+phrase, result);
        console.log(element);
        callback(element['user']['screen_name']);
    }, this);
    })
}

But I don't think this is the best solution, because I need to create a callback function just for this. Isn't there a way to pass the username 'pointer' like this: getUserFromSearch('banana', username); in such a way that the function alters the value of username? Is there even a better way?

T.J. Crowder · Accepted Answer · 2017-01-07 12:19:35Z

1

Isn't there a way to pass the username 'pointer'

No, there isn't. JavaScript doesn't have references to variables.

You could pass in an object with a username property and have it set that property, but that tightly couples getUserFromSearch to a specific object and isn't composable.

Promises are a great way to handle this situation. They're composable and offer clear semantics around success and failure:

function getUserFromSearch(phrase) {
    return new Promise(function(resolve, reject) {
        T.get('search/tweets', { q: phrase + ' lang:pt', count: 1 }, function(err, data, response) {
            if (err) {
                reject(err);
            } else {
                data['statuses'].forEach(function(element) {
                    var result = "maybe";
                    say('getting user profile from search for ' + phrase, result);
                    resolve(element['user']['screen_name']);
                }, this);
            }
        })
    });
}

Usage:

getUserFromSearch(phrase).then(function(result) {
    username = result;
});

Yes, there's still a callback, but it's a callback that's readily composed with others.

With ES2015 syntax:

function getUserFromSearch(phrase) {
    return new Promise((resolve, reject) => {
        T.get('search/tweets', { q: phrase + ' lang:pt', count: 1 }, function(err, data, response) {
            if (err) {
                reject(err);
            } else {
                data['statuses'].forEach(element => {
                    const result = "maybe";
                    say('getting user profile from search for ' + phrase, result);
                    resolve(element['user']['screen_name']);
                });
            }
        })
    });
}

Usage:

getUserFromSearch(phrase).then(result => {
    username = result;
});

answered Jan 7, 2017 at 12:19

T.J. Crowder

1.1m201 gold badges2k silver badges2k bronze badges

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

3 Comments

Gatonito Over a year ago

Can I use ES2015 syntax in nodejs?

T.J. Crowder Over a year ago

@Gatonito: Yes. Node v6.x has full support other than modules (and tail-call optimization unless you use a flag). v5.x and v4.x had partial support.

jib Over a year ago

Then you can use it like this: var username = await getUserFromSearch(phrase); once node supports async/await.

Ritik Saxena · Accepted Answer · 2017-01-07 13:16:54Z

1

Since JavaScript doesn't have the notion of pointers,you can create an object before calling the function and pass the object as the second parameter to the function. Assign the result of the function to the object's property.

Your code would look like:

function getUserFromSearch(phrase,obj) {
T.get('search/tweets', { q: phrase+' lang:pt', count: 1 }, function(err, data, response) {
data['statuses'].forEach(function(element) {
    var result = "maybe";
    say('getting user profile from search for '+phrase, result);
    console.log(element);
    obj.username = element['user']['screen_name'];
}, this);
})
}

var obj = {username:null}
getUserFromSearch('banana',obj);

answered Jan 7, 2017 at 13:16

Ritik Saxena

7241 gold badge13 silver badges26 bronze badges

Comments

Alex · Accepted Answer · 2017-01-07 12:18:41Z

0

This is the way javascript works.
Since this is an async function, you'll need to do it as you said.

getUserFromSearch('banana', function(username){
   //do something with username here
});

What you can do, is use something like async.js to reduce the nested callback hell...

answered Jan 7, 2017 at 12:18

Alex

38.6k55 gold badges217 silver badges340 bronze badges

3 Comments

Gatonito Over a year ago

What do you think of this idea: stackoverflow.com/questions/5292159/…

Gatonito Over a year ago

Instead of passing a callback I could pass a object that contains the 'username' property and make the function modify it.

Alex Over a year ago

would love it if people commented, not just fly-by downvoted

Collectives™ on Stack Overflow

Best way to return values from async functions in javascript

3 Answers 3

3 Comments

Comments

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

Comments

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related