From 0807847db383b2f08576a2b2aef5b3aaac755f77 Mon Sep 17 00:00:00 2001
From: Antony Gelberg <antony.gelberg@gmail.com>
Date: Wed, 24 Jan 2018 19:35:22 +0200
Subject: [PATCH] docs(page_objects): Add async / await example

---
 docs/page-objects.md | 52 ++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 48 insertions(+), 4 deletions(-)

diff --git a/docs/page-objects.md b/docs/page-objects.md
index 87da792ee..d4d69e72f 100644
--- a/docs/page-objects.md
+++ b/docs/page-objects.md
@@ -36,13 +36,42 @@ var AngularHomepage = function() {
   this.setName = function(name) {
     nameInput.sendKeys(name);
   };
-  
-  this.getGreeting = function() {
+
+  this.getGreetingText = function() {
     return greeting.getText();
   };
 };
 module.exports = new AngularHomepage();
 ```
+
+Or, if using `async / await`, something like this: (Note that functions
+that don't use `await` shouldn't have the `async` prefix.)
+
+```js
+var AngularHomepage = function() {
+  var nameInput = element(by.model('yourName'));
+  var greeting = element(by.binding('yourName'));
+
+  this.get = async function() {
+    await browser.get('http://www.angularjs.org');
+  };
+
+  this.setName = async function(name) {
+    await nameInput.sendKeys(name);
+  };
+
+  this.getGreetingText = async function() {
+    return await greeting.getText();
+  };
+
+  // Not async, returns the element
+  this.getGreeting = function() {
+    return greeting;
+  };
+};
+module.exports = new AngularHomepage();
+```
+
 The next thing you need to do is modify the test script to use the Page Object and its properties. Note that the _functionality_ of the test script itself does not change (nothing is added or deleted).
 
 In the test script, you'll `require` the Page Object as presented above. The path to the Page Object _will be relative_ to your spec, so adjust accordingly.
@@ -55,7 +84,22 @@ describe('angularjs homepage', function() {
 
     angularHomepage.setName('Julie');
 
-    expect(angularHomepage.getGreeting()).toEqual('Hello Julie!');
+    expect(angularHomepage.getGreetingText()).toEqual('Hello Julie!');
+  });
+});
+```
+
+If using `async / await`, that would turn into something like:
+
+```js
+var angularHomepage = require('./AngularHomepage');
+describe('angularjs homepage', function() {
+  it('should greet the named user', async function() {
+    await angularHomepage.get();
+
+    await angularHomepage.setName('Julie');
+
+    expect(await angularHomepage.getGreetingText()).toEqual('Hello Julie!');
   });
 });
 ```
@@ -63,7 +107,7 @@ describe('angularjs homepage', function() {
 Configuring Test Suites
 -----------------------
 
-It is possible to separate your tests into various test suites. In your config file, you could setup  the suites option as shown below. 
+It is possible to separate your tests into various test suites. In your config file, you could setup the suites option as shown below:
 
 ```js
 exports.config = {