JavaScript | Generator.prototype.return() Method

The Generator.prototype.return() method is an inbuilt method in JavaScript which is used to return the given value and finishes the generator.

Syntax:

gen.return( value );

Parameters: This method accepts single parameter as mentioned above and described below:



  • value: This parameter holds the value which to be returned.

Return value: This method returns the value which is given to it as an argument.

Below examples illustrate the Generator.prototype.return() method in JavaScript:

Example 1:

filter_none

edit
close

play_arrow

link
brightness_4
code

function* GFG() { 
  yield "GeeksforGeeks";
  yield "JavaScript";
  yield "Generator.prototype.next()";
}
  
const geek = GFG(); 
console.log(geek.next()); 
console.log(geek.next());  
console.log(geek.return("Shubham  Singh"));      
console.log(geek.next());          

chevron_right


Output:

Object { value: "GeeksforGeeks", done: false }
Object { value: "JavaScript", done: false }
Object { value: "Shubham  Singh", done: true }
Object { value: undefined, done: true }

Example 2:

filter_none

edit
close

play_arrow

link
brightness_4
code

function* GFG(pageSize = 1, list) {
    let output = [];
    let index = 0;
  
    while (index < list.length) {
        output = [];
        for (let i = index; i < index + pageSize; i++) {
            if (list[i]) {
                output.push(list[i]);
            }
        }
  
        yield output;
        index += pageSize;
    }
}
list = [1, 2, 3, 4, 5, 6, 7, 8]
var geek = GFG(3, list);              
  
console.log(geek.next());      
console.log(geek.next());      
console.log(geek.next()); 
console.log(geek.next()); 
console.log(geek.return(list));

chevron_right


Output:

Object { value: Array [1, 2, 3], done: false }
Object { value: Array [4, 5, 6], done: false }
Object { value: Array [7, 8], done: false }
Object { value: undefined, done: true }
Object { value: Array [1, 2, 3, 4, 5, 6, 7, 8], done: true }

Supported Browsers: The browsers supported by Generator.prototype.return() method are listed below:

  • Google Chrome
  • Firefox
  • Opera
  • Safari
  • Edge

full-stack-img




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.