What’s the yield keyword in JavaScript?

yield keyword is used to resume or pause a generator function asynchronously. A generator function is just like a normal function but the difference is that whenever the function is returning any value, it does it with the help of ‘yield’ keyword instead of return it. Yield can’t be called from nested functions or from callbacks.

The yield expression returns an object with two properties, “value” which is the actual value and “done” which is a boolean value, it returns true when generator function is full completed else it returns false.

If we pause the yield expression, the generator function will also get paused and resumes only when we call the next() method. When the next() method is encountered the function keeps on working until it faces another yield or returns expression.



Example 1:

filter_none

edit
close

play_arrow

link
brightness_4
code

function* showPrices(i) {
    while (i < 3) {
        yield i++;
    }
}
  
//creating an object for our function showPrices
const gfg = showPrices(0); 
  
//return 0 because 0 value is passed to the showPrices yield expression
console.log(gfg.next().value); 
  
// return 1
console.log(gfg.next().value); 
  
//return 2
console.log(gfg.next().value); 

chevron_right


Output:

Example 2:

filter_none

edit
close

play_arrow

link
brightness_4
code

function* geeksforGeeks() {
  
  /*expression paused here and return
  value is undefined as nothing is declared*/
    yield; 
    
    //wait for next() to finish
    gfg(yield "Welcome to GFG"); 
}
  
function gfg(x) {
    console.log("Hello World ", x)
}
  
var generator = geeksforGeeks();
  
//return undefined
console.log(generator.next()); 
  
//return Welcome to GFG 
console.log(generator.next()); 
  
/*done remains false as we have not called next 
so that "Hello World" is still left there to process*/

chevron_right


Output:



My Personal Notes arrow_drop_up

Check out this Author's contributed articles.

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.