Document async await usage

README.md

@@ -17,7 +17,7 @@ This example is part of the knex mocha [tests](./index.mocha.spec.js). They
 can be run using using the following npm script.
 
 ```bash
-npm run test-mocha
+npm install npx -g && npx mocha ./index.mocha.spec.js
 ```
 
 ```js
@@ -52,6 +52,49 @@ describe('Mocha & Knest', () => {
 })
 ```
 
+You can consider using `async / await` syntax as the knex helper returns
+a promise.
+
+```bash
+node index.async.spec.js
+```
+
+```js
+const assert = require('assert')
+const {
+  mysql,
+  users,
+  resetDatabase,
+  findUsers,
+  createUsers,
+  createUser,
+} = require('./index.spec')
+
+const knest = require('./index').bind(null, mysql)
+
+async function tests() {
+  await resetDatabase(mysql)
+
+  await knest(async trx => {
+    const user = await createUser(trx, users[0])
+
+    assert.deepEqual(user, users[0])
+  })
+
+  knest(async trx => {
+    const created = await createUsers(trx, users)
+
+    assert.deepEqual(created, users)
+  })
+
+  const foundUsers = await findUsers(mysql)
+
+  assert.deepEqual(foundUsers, [])
+}
+
+tests().then(() => process.exit())
+```
+
 # Reference
 
 Knest exports a single function.
@@ -85,14 +128,14 @@ Knest is tested using MySQL. Make sure you have MySQL installed. The
 `./setup.sql` file makes it easy to setup a database and user for running the
 tests.
 
-```bash
-#!/bin/bash
-
-npm install
-sudo mysql -p < ./setup.sql
+```sql
+DROP DATABASE IF EXISTS knest;
+CREATE DATABASE knest;
+GRANT ALL PRIVILEGES ON knest.* TO knest@localhost IDENTIFIED BY 'knest';
+FLUSH PRIVILEGES;
 ```
 
-Once the test requirements are setup you can run the tests using `npm test`
+Once the test requirements are setup you can run the tests using `npm test`.
 
 # Changelog
 
@@ -115,3 +158,7 @@ Some suggestions for contributing to this library are:
 - Write tests for other databases knex supports.
 - Support for multiple connections/transactions
 - Contribute what you feel is important.
+
+# License
+
+[MIT License](./LICENSE)

doc/README.md

@@ -18,3 +18,5 @@ require ./doc/section/test.md
 require ./doc/section/changelog.md
 
 require ./doc/section/contribute.md
+
+require ./doc/section/license.md

doc/script/async-tests.sh

@@ -0,0 +1 @@
+node index.async.spec.js

doc/script/mocha-tests.sh

@@ -1 +1 @@
-npm run test-mocha
+npm install npx -g && npx mocha ./index.mocha.spec.js

doc/section/license.md

@@ -0,0 +1,3 @@
+# License
+
+require-run bash -c 'echo "[$(head -n 1 ./LICENSE)](./LICENSE)"'

doc/section/test.md

@@ -4,8 +4,8 @@ Knest is tested using MySQL. Make sure you have MySQL installed. The
 `./setup.sql` file makes it easy to setup a database and user for running the
 tests.
 
-```bash
-require ./doc/script/setup-test.sh
+```sql
+require ./setup.sql
 ```
 
-Once the test requirements are setup you can run the tests using `npm test`
+Once the test requirements are setup you can run the tests using `npm test`.

doc/section/usage.md

@@ -12,3 +12,14 @@ require ./doc/script/mocha-tests.sh
 ```js
 require ./index.mocha.spec.js
 ```
+
+You can consider using `async / await` syntax as the knex helper returns
+a promise.
+
+```bash
+require  ./doc/script/async-tests.sh
+```
+
+```js
+require ./index.async.spec.js
+```

index.async.spec.js

@@ -0,0 +1,33 @@
+const assert = require('assert')
+const {
+  mysql,
+  users,
+  resetDatabase,
+  findUsers,
+  createUsers,
+  createUser,
+} = require('./index.spec')
+
+const knest = require('./index').bind(null, mysql)
+
+async function tests() {
+  await resetDatabase(mysql)
+
+  await knest(async trx => {
+    const user = await createUser(trx, users[0])
+
+    assert.deepEqual(user, users[0])
+  })
+
+  knest(async trx => {
+    const created = await createUsers(trx, users)
+
+    assert.deepEqual(created, users)
+  })
+
+  const foundUsers = await findUsers(mysql)
+
+  assert.deepEqual(foundUsers, [])
+}
+
+tests().then(() => process.exit())