Update docs

API.md

@@ -1,10 +1,63 @@
+# limit
+
+Set the limit clause
+
+**Parameters**
+
+-   `sql` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** SQL statement to modify
+-   `limit` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum number of rows to fetch
+-   `offset` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** Number of rows to skip
+
+Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Modified SQL statement
+
+# quoteTable
+
+Quote database table name, and set prefix
+
+**Parameters**
+
+-   `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Table name to quote
+
+Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Quoted table name
+
+# quoteIdentifiers
+
+Use the driver's escape character to quote identifiers
+
+**Parameters**
+
+-   `str` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array))** String or array of strings to quote identifiers
+
+Returns **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array))** Quoted identifier(s)
+
+# truncate
+
+Generate SQL to truncate the passed table
+
+**Parameters**
+
+-   `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Table to truncate
+
+Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Truncation SQL
+
+# insertBatch
+
+Generate SQL to insert a group of rows
+
+**Parameters**
+
+-   `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert to
+-   `data` **\[[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)]** The array of object containing data to insert
+
+Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Query and data to insert
+
 # NodeQuery
 
 Class for connection management
 
 **Parameters**
 
--   `config` **object** connection parameters
+-   `config` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** connection parameters
 
 ## constructor
 
@@ -12,7 +65,7 @@ Constructor
 
 **Parameters**
 
--   `config` **object** connection parameters
+-   `config` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** connection parameters
 
 **Examples**
 
@@ -39,10 +92,12 @@ let nodeQuery = require('ci-node-query')({
 
 Return an existing query builder instance
 
-Returns **QueryBuilder** The Query Builder object
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object
 
 # QueryBuilder
 
+**Extends QueryBuilderBase**
+
 Main object that builds SQL queries.
 
 **Parameters**
@@ -50,17 +105,34 @@ Main object that builds SQL queries.
 -   `Driver` **Driver** The syntax driver for the database
 -   `Adapter` **Adapter** The database module adapter for running queries
 
-## delete
+## query
 
-Run the generated delete query
+Run an arbitrary sql query. Run as a prepared statement.
 
 **Parameters**
 
--   `table` **String** The table to insert into
+-   `sql` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The sql to execute
--   `where` **[Object]** Where clause for delete statement
+-   `params` **\[[array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)]** The query parameters
--   `callback` **[Function]** Callback for handling response from the database
+-   `callback` **\[[function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** Optional callback
 
-Returns **void or Promise** If no callback is passed, a promise is returned
+Returns **(void | [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise))** Returns a promise if no callback is supplied
+
+## resetQuery
+
+Reset the object state for a new query
+
+Returns **void** 
+
+## truncate
+
+Empties the selected database table
+
+**Parameters**
+
+-   `table` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the name of the table to truncate
+-   `callback` **\[[function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** Optional callback
+
+Returns **(void | [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise))** Returns a promise if no callback is supplied
 
 ## end
 
@@ -68,13 +140,33 @@ Closes the database connection for the current adapter
 
 Returns **void** 
 
+## select
+
+Specify rows to select in the query
+
+**Parameters**
+
+-   `fields` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array))** The fields to select from the current table
+
+**Examples**
+
+```javascript
+query.select('foo, bar'); // Select multiple fields with a string
+```
+
+```javascript
+query.select(['foo', 'bar']); // Select multiple fileds with an array
+```
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
 ## from
 
 Specify the database table to select from
 
 **Parameters**
 
--   `tableName` **String** The table to use for the current query
+-   `tableName` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to use for the current query
 
 **Examples**
 
@@ -86,7 +178,274 @@ query.from('tableName');
 query.from('tableName t'); // Select the table with an alias
 ```
 
-Returns **QueryBuilder** The Query Builder object, for chaining
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## like
+
+Add a 'like/ and like' clause to the query
+
+**Parameters**
+
+-   `field` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the field  to compare to
+-   `val` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The value to compare to
+-   `pos` **\[[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** The placement of the wildcard character(s): before, after, or both (optional, default `both`)
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## notLike
+
+Add a 'not like/ and not like' clause to the query
+
+**Parameters**
+
+-   `field` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the field  to compare to
+-   `val` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The value to compare to
+-   `pos` **\[[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** The placement of the wildcard character(s): before, after, or both (optional, default `both`)
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## orLike
+
+Add an 'or like' clause to the query
+
+**Parameters**
+
+-   `field` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the field  to compare to
+-   `val` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The value to compare to
+-   `pos` **\[[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** The placement of the wildcard character(s): before, after, or both (optional, default `both`)
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## orNotLike
+
+Add an 'or not like' clause to the query
+
+**Parameters**
+
+-   `field` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the field  to compare to
+-   `val` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The value to compare to
+-   `pos` **\[[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** The placement of the wildcard character(s): before, after, or both (optional, default `both`)
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## having
+
+Add a 'having' clause
+
+**Parameters**
+
+-   `key` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** The name of the field and the comparision operator, or an object
+-   `val` **\[([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))]** The value to compare if the value of key is a string
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## orHaving
+
+Add an 'or having' clause
+
+**Parameters**
+
+-   `key` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** The name of the field and the comparision operator, or an object
+-   `val` **\[([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))]** The value to compare if the value of key is a string
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## where
+
+Set a 'where' clause
+
+**Parameters**
+
+-   `key` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** The name of the field and the comparision operator, or an object
+-   `val` **\[([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))]** The value to compare if the value of key is a string
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## orWhere
+
+Set a 'or where' clause
+
+**Parameters**
+
+-   `key` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** The name of the field and the comparision operator, or an object
+-   `val` **\[([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))]** The value to compare if the value of key is a string
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## whereIsNull
+
+Select a field that is Null
+
+**Parameters**
+
+-   `field` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the field that has a NULL value
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## whereIsNotNull
+
+Specify that a field IS NOT NULL
+
+**Parameters**
+
+-   `field` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name so the field that is not to be null
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## orWhereIsNull
+
+Field is null prefixed with 'OR'
+
+**Parameters**
+
+-   `field` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the field
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## orWhereIsNotNull
+
+Field is not null prefixed with 'OR'
+
+**Parameters**
+
+-   `field` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the field
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## whereIn
+
+Set a 'where in' clause
+
+**Parameters**
+
+-   `key` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the field to search
+-   `values` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** the array of items to search in
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## orWhereIn
+
+Set a 'or where in' clause
+
+**Parameters**
+
+-   `key` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the field to search
+-   `values` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** the array of items to search in
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## whereNotIn
+
+Set a 'where not in' clause
+
+**Parameters**
+
+-   `key` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the field to search
+-   `values` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** the array of items to search in
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## orWhereNotIn
+
+Set a 'or where not in' clause
+
+**Parameters**
+
+-   `key` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the field to search
+-   `values` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** the array of items to search in
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## set
+
+Set values for insertion or updating
+
+**Parameters**
+
+-   `key` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** The key or object to use
+-   `val` **\[[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** The value if using a scalar key
+
+**Examples**
+
+```javascript
+query.set('foo', 'bar'); // Set a key, value pair
+```
+
+```javascript
+query.set({foo:'bar'}); // Set with an object
+```
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## join
+
+Add a join clause to the query
+
+**Parameters**
+
+-   `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table you are joining
+-   `cond` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The join condition.
+-   `type` **\[[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** The type of join, which defaults to inner (optional, default `'inner'`)
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## groupBy
+
+Group the results by the selected field(s)
+
+**Parameters**
+
+-   `field` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array))** The name of the field to group by
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## orderBy
+
+Order the results by the selected field(s)
+
+**Parameters**
+
+-   `field` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The field(s) to order by
+-   `type` **\[[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** The order direction, ASC or DESC (optional, default `'ASC'`)
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## limit
+
+Put a limit on the query
+
+**Parameters**
+
+-   `limit` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The maximum number of rows to fetch
+-   `offset` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** The row number to start from
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## groupStart
+
+Adds an open paren to the current query for logical grouping
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## orGroupStart
+
+Adds an open paren to the current query for logical grouping,
+prefixed with 'OR'
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## orNotGroupStart
+
+Adds an open paren to the current query for logical grouping,
+prefixed with 'OR NOT'
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
+
+## groupEnd
+
+Ends a logical grouping started with one of the groupStart methods
+
+Returns **[QueryBuilder](#querybuilder)** The Query Builder object, for chaining
 
 ## get
 
@@ -94,10 +453,10 @@ Get the results of the compiled query
 
 **Parameters**
 
--   `table` **[String]** The table to select from
+-   `table` **\[[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** The table to select from
--   `limit` **[Number]** A limit for the query
+-   `limit` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** A limit for the query
--   `offset` **[Number]** An offset for the query
+-   `offset` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** An offset for the query
--   `callback` **[Function]** A callback for receiving the result
+-   `callback` **\[[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** A callback for receiving the result
 
 **Examples**
 
@@ -113,84 +472,7 @@ query.get('table_name', 5, callback); // Get 5 rows from the table
 query.get(callback); // Get the results of a query generated with other methods
 ```
 
-Returns **void or Promise** If no callback is passed, a promise is returned
+Returns **(void | [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise))** If no callback is passed, a promise is returned
-
-## getCompiledDelete
-
-Return generated delete query SQL
-
-**Parameters**
-
--   `table` **String** the name of the table to delete from
--   `reset` **[Boolean]** Whether to reset the query builder so another query can be built (optional, default `true`)
-
-Returns **String** The compiled sql statement
-
-## getCompiledInsert
-
-Return generated insert query SQL
-
-**Parameters**
-
--   `table` **String** the name of the table to insert into
--   `reset` **[Boolean]** Whether to reset the query builder so another query can be built (optional, default `true`)
-
-Returns **String** The compiled sql statement
-
-## getCompiledSelect
-
-Return generated select query SQL
-
-**Parameters**
-
--   `table` **[String]** the name of the table to retrieve from
--   `reset` **[Boolean]** Whether to reset the query builder so another query can be built (optional, default `true`)
-
-Returns **String** The compiled sql statement
-
-## getCompiledUpdate
-
-Return generated update query SQL
-
-**Parameters**
-
--   `table` **String** the name of the table to update
--   `reset` **[Boolean]** Whether to reset the query builder so another query can be built (optional, default `true`)
-
-Returns **String** The compiled sql statement
-
-## groupBy
-
-Group the results by the selected field(s)
-
-**Parameters**
-
--   `field` **String or Array** The name of the field to group by
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## groupEnd
-
-Ends a logical grouping started with one of the groupStart methods
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## groupStart
-
-Adds an open paren to the current query for logical grouping
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## having
-
-Add a 'having' clause
-
-**Parameters**
-
--   `key` **String or Object** The name of the field and the comparision operator, or an object
--   `val` **[String or Number]** The value to compare if the value of key is a string
-
-Returns **QueryBuilder** The Query Builder object, for chaining
 
 ## insert
 
@@ -198,11 +480,11 @@ Run the generated insert query
 
 **Parameters**
 
--   `table` **String** The table to insert into
+-   `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert into
--   `data` **[Object]** Data to insert, if not already added with the 'set' method
+-   `data` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** Data to insert, if not already added with the 'set' method
--   `callback` **[Function]** Callback for handling response from the database
+-   `callback` **\[[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** Callback for handling response from the database
 
-Returns **void or Promise** If no callback is passed, a promise is returned
+Returns **(void | [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise))** If no callback is passed, a promise is returned
 
 ## insertBatch
 
@@ -210,9 +492,9 @@ Insert multiple sets of rows at a time
 
 **Parameters**
 
--   `table` **String** The table to insert into
+-   `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert into
--   `data` **Array** The array of objects containing data rows to insert
+-   `data` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** The array of objects containing data rows to insert
--   `callback` **[Function]** Callback for handling database response
+-   `callback` **\[[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** Callback for handling database response
 
 **Examples**
 
@@ -225,237 +507,7 @@ query.insertBatch('foo',[{id:1,val:'bar'},{id:2,val:'baz'}])
 .then(promiseCallback);
 ```
 
-Returns **void or Promise** If no callback is passed, a promise is returned
+Returns **(void | [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise))** If no callback is passed, a promise is returned
-
-## join
-
-Add a join clause to the query
-
-**Parameters**
-
--   `table` **String** The table you are joining
--   `cond` **String** The join condition.
--   `type` **[String]** The type of join, which defaults to inner (optional, default `'inner'`)
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## like
-
-Add a 'like/ and like' clause to the query
-
-**Parameters**
-
--   `field` **String** The name of the field  to compare to
--   `val` **String** The value to compare to
--   `pos` **[String]** The placement of the wildcard character(s): before, after, or both (optional, default `both`)
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## limit
-
-Put a limit on the query
-
-**Parameters**
-
--   `limit` **Number** The maximum number of rows to fetch
--   `offset` **[Number]** The row number to start from
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## notLike
-
-Add a 'not like/ and not like' clause to the query
-
-**Parameters**
-
--   `field` **String** The name of the field  to compare to
--   `val` **String** The value to compare to
--   `pos` **[String]** The placement of the wildcard character(s): before, after, or both (optional, default `both`)
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## orGroupStart
-
-Adds an open paren to the current query for logical grouping,
-prefixed with 'OR'
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## orHaving
-
-Add an 'or having' clause
-
-**Parameters**
-
--   `key` **String or Object** The name of the field and the comparision operator, or an object
--   `val` **[String or Number]** The value to compare if the value of key is a string
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## orLike
-
-Add an 'or like' clause to the query
-
-**Parameters**
-
--   `field` **String** The name of the field  to compare to
--   `val` **String** The value to compare to
--   `pos` **[String]** The placement of the wildcard character(s): before, after, or both (optional, default `both`)
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## orNotGroupStart
-
-Adds an open paren to the current query for logical grouping,
-prefixed with 'OR NOT'
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## orNotLike
-
-Add an 'or not like' clause to the query
-
-**Parameters**
-
--   `field` **String** The name of the field  to compare to
--   `val` **String** The value to compare to
--   `pos` **[String]** The placement of the wildcard character(s): before, after, or both (optional, default `both`)
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## orWhere
-
-Set a 'or where' clause
-
-**Parameters**
-
--   `key` **String or Object** The name of the field and the comparision operator, or an object
--   `val` **[String or Number]** The value to compare if the value of key is a string
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## orWhereIn
-
-Set a 'or where in' clause
-
-**Parameters**
-
--   `key` **String** the field to search
--   `values` **Array** the array of items to search in
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## orWhereIsNotNull
-
-Field is not null prefixed with 'OR'
-
-**Parameters**
-
--   `field` **String** The name of the field
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## orWhereIsNull
-
-Field is null prefixed with 'OR'
-
-**Parameters**
-
--   `field` **String** The name of the field
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## orWhereNotIn
-
-Set a 'or where not in' clause
-
-**Parameters**
-
--   `key` **String** the field to search
--   `values` **Array** the array of items to search in
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## orderBy
-
-Order the results by the selected field(s)
-
-**Parameters**
-
--   `field` **String** The field(s) to order by
--   `type` **[String]** The order direction, ASC or DESC (optional, default `'ASC'`)
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## query
-
-Run an arbitrary sql query. Run as a prepared statement.
-
-**Parameters**
-
--   `sql` **string** The sql to execute
--   `params` **[array]** The query parameters
--   `callback` **[function]** Optional callback
-
-Returns **void or Promise** Returns a promise if no callback is supplied
-
-## resetQuery
-
-Reset the object state for a new query
-
-Returns **void** 
-
-## select
-
-Specify rows to select in the query
-
-**Parameters**
-
--   `fields` **String or Array** The fields to select from the current table
-
-**Examples**
-
-```javascript
-query.select('foo, bar'); // Select multiple fields with a string
-```
-
-```javascript
-query.select(['foo', 'bar']); // Select multiple fileds with an array
-```
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## set
-
-Set values for insertion or updating
-
-**Parameters**
-
--   `key` **String or Object** The key or object to use
--   `val` **[String]** The value if using a scalar key
-
-**Examples**
-
-```javascript
-query.set('foo', 'bar'); // Set a key, value pair
-```
-
-```javascript
-query.set({foo:'bar'}); // Set with an object
-```
-
-Returns **QueryBuilder** The Query Builder object, for chaining
-
-## truncate
-
-Empties the selected database table
-
-**Parameters**
-
--   `table` **string** the name of the table to truncate
--   `callback` **[function]** Optional callback
-
-Returns **void or Promise** Returns a promise if no callback is supplied
 
 ## update
 
@@ -463,64 +515,67 @@ Run the generated update query
 
 **Parameters**
 
--   `table` **String** The table to insert into
+-   `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert into
--   `data` **[Object]** Data to insert, if not already added with the 'set' method
+-   `data` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** Data to insert, if not already added with the 'set' method
--   `callback` **[Function]** Callback for handling response from the database
+-   `callback` **\[[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** Callback for handling response from the database
 
-Returns **void or Promise** If no callback is passed, a promise is returned
+Returns **(void | [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise))** If no callback is passed, a promise is returned
 
-## where
+## delete
 
-Set a 'where' clause
+Run the generated delete query
 
 **Parameters**
 
--   `key` **String or Object** The name of the field and the comparision operator, or an object
+-   `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert into
--   `val` **[String or Number]** The value to compare if the value of key is a string
+-   `where` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** Where clause for delete statement
+-   `callback` **\[[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** Callback for handling response from the database
 
-Returns **QueryBuilder** The Query Builder object, for chaining
+Returns **(void | [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise))** If no callback is passed, a promise is returned
 
-## whereIn
+## getCompiledSelect
 
-Set a 'where in' clause
+Return generated select query SQL
 
 **Parameters**
 
--   `key` **String** the field to search
+-   `table` **\[[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** the name of the table to retrieve from
--   `values` **Array** the array of items to search in
+-   `reset` **\[[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** Whether to reset the query builder so another query can be built (optional, default `true`)
 
-Returns **QueryBuilder** The Query Builder object, for chaining
+Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The compiled sql statement
 
-## whereIsNotNull
+## getCompiledInsert
 
-Specify that a field IS NOT NULL
+Return generated insert query SQL
 
 **Parameters**
 
--   `field` **String** The name so the field that is not to be null
+-   `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the name of the table to insert into
+-   `reset` **\[[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** Whether to reset the query builder so another query can be built (optional, default `true`)
 
-Returns **QueryBuilder** The Query Builder object, for chaining
+Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The compiled sql statement
 
-## whereIsNull
+## getCompiledUpdate
 
-Select a field that is Null
+Return generated update query SQL
 
 **Parameters**
 
--   `field` **String** The name of the field that has a NULL value
+-   `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the name of the table to update
+-   `reset` **\[[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** Whether to reset the query builder so another query can be built (optional, default `true`)
 
-Returns **QueryBuilder** The Query Builder object, for chaining
+Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The compiled sql statement
 
-## whereNotIn
+## getCompiledDelete
 
-Set a 'where not in' clause
+Return generated delete query SQL
 
 **Parameters**
 
--   `key` **String** the field to search
+-   `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the name of the table to delete from
--   `values` **Array** the array of items to search in
+-   `reset` **\[[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** Whether to reset the query builder so another query can be built (optional, default `true`)
 
-Returns **QueryBuilder** The Query Builder object, for chaining
+Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The compiled sql statement
 
 # Result
 
@@ -528,17 +583,17 @@ Query result object
 
 **Parameters**
 
--   `rows` **Array** the data rows of the result
+-   `rows` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** the data rows of the result
--   `columns` **Array** the column names in the result
+-   `columns` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** the column names in the result
-
-## columnCount
-
-Get the number of columns returned by the query
-
-Returns **Number** the number of columns in the result
 
 ## rowCount
 
 Get the number of rows returned by the query
 
-Returns **Number** the number of rows in the result
+Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** the number of rows in the result
+
+## columnCount
+
+Get the number of columns returned by the query
+
+Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** the number of columns in the result

README.md

@@ -50,7 +50,7 @@ query.select('foo')
 	});
 
 // As of version 3.1.0, you can also get promises
-var queryPromise = query.select('foo')
+const queryPromise = query.select('foo')
 	.from('bar')
 	.where('x', 3)
 	.orWhere({y: 2})
@@ -93,5 +93,5 @@ As of version 2, `where` and `having` type methods parse the values passed to lo
 * Generated documentation is in the docs/ folder
 * The API is documented in [API.md](./API.md)
 * The `tests/adapters` folder contains examples of how to set up a connection for the appropriate database library
-* The documentation generated for the latest dev build is also [Available](https://github.timshomepage.net/node-query/docs/)
+* The documentation generated for the latest dev build is also [Available](https://github.timshomepage.net/node-query/docs/index.html)
 

docs/assets/bass-addons.css

@@ -0,0 +1,12 @@
+.input {
+  font-family: inherit;
+  display: block;
+  width: 100%;
+  height: 2rem;
+  padding: .5rem;
+  margin-bottom: 1rem;
+  border: 1px solid #ccc;
+  font-size: .875rem;
+  border-radius: 3px;
+  box-sizing: border-box;
+}

docs/assets/bass.css

@@ -1,306 +1,4 @@
-/*
+/*! Basscss | http://basscss.com | MIT License */
-
-    Basscss v7.0.3
-    Low-level CSS toolkit
-    http://basscss.com
-
-    14.88 kB
-    3.38 kB Gzipped
-    286 Rules
-    328 Selectors
-    441 Declarations
-    95 Properties
-
-*/
-
-
-
-body { margin: 0 }
-img { max-width: 100% }
-svg { max-height: 100% }
-
-input,
-select,
-textarea,
-fieldset {
-  font-family: inherit;
-  font-size: 1rem;
-  box-sizing: border-box;
-  margin-top: 0;
-  margin-bottom: 0;
-}
-
-label {
-  vertical-align: middle;
-}
-
-input[type=text],
-input[type=date],
-input[type=datetime],
-input[type=datetime-local],
-input[type=email],
-input[type=month],
-input[type=number],
-input[type=password],
-input[type=search],
-input[type=tel],
-input[type=time],
-input[type=url],
-input[type=week] {
-  height: 2.25rem;
-  padding: .5rem .5rem;
-  vertical-align: middle;
-  -webkit-appearance: none;
-}
-
-select {
-  line-height: 1.75;
-  padding: .5rem .5rem;
-}
-
-select:not([multiple]) {
-  height: 2.25rem;
-  vertical-align: middle;
-}
-
-textarea {
-  line-height: 1.75;
-  padding: .5rem .5rem;
-}
-
-table {
-  border-collapse: separate;
-  border-spacing: 0;
-  max-width: 100%;
-  width: 100%;
-}
-
-th {
-  text-align: left;
-  font-weight: bold;
-}
-
-th,
-td {
-  padding: .25rem 1rem;
-  line-height: inherit;
-}
-
-th { vertical-align: bottom }
-td { vertical-align: top }
-
-body {
-  font-family: 'Helvetica Neue', Helvetica, sans-serif;
-  line-height: 1.5;
-  font-size: 100%;
-}
-
-h1, h2, h3, h4, h5, h6 {
-  font-family: 'Helvetica Neue', Helvetica, sans-serif;
-  font-weight: bold;
-  line-height: 1.25;
-  margin-top: 1em;
-  margin-bottom: .5em;
-}
-
-p {
-  margin-top: 0;
-  margin-bottom: 1rem;
-}
-
-dl, ol, ul {
-  margin-top: 0;
-  margin-bottom: 1rem;
-}
-
-pre, code, samp {
-  font-family: 'Source Code Pro', Consolas, monospace;
-  font-size: inherit;
-}
-
-pre {
-  margin-top: 0;
-  margin-bottom: 1rem;
-  overflow-x: scroll;
-}
-
-h1 { font-size: 2rem }
-h2 { font-size: 1.5rem }
-h3 { font-size: 1.25rem }
-h4 { font-size: 1rem }
-h5 { font-size: .875rem }
-h6 { font-size: .75rem }
-
-body {
-  color: #111;
-  background-color: #fff;
-}
-
-a {
-  color: #0074d9;
-  text-decoration: none;
-}
-
-a:hover {
-  text-decoration: underline;
-}
-
-pre, code {
-  background-color: transparent;
-  border-radius: 3px;
-}
-
-hr {
-  border: 0;
-  border-bottom-style: solid;
-  border-bottom-width: 1px;
-  border-bottom-color: rgba(0,0,0,.125);
-}
-
-.field {
-  border-style: solid;
-  border-width: 1px;
-  border-color: rgba(0,0,0,.125);
-  border-radius: 3px;
-}
-
-.field:focus,
-.field.is-focused {
-  outline: none;
-  border-color: #0074d9;
-  box-shadow: 0 0 0 2px rgba(0, 116, 217, 0.5);
-}
-
-.field:disabled,
-.field.is-disabled {
-  background-color: rgba(0,0,0,.125);
-  opacity: .5;
-}
-
-.field:read-only:not(select),
-.field.is-read-only {
-  background-color: rgba(0,0,0,.125);
-}
-
-
-.field.is-success {
-  border-color: #2ecc40;
-}
-
-.field.is-success:focus,
-.field.is-success.is-focused {
-  box-shadow: 0 0 0 2px rgba(46, 204, 64, 0.5);
-}
-
-.field.is-warning {
-  border-color: #ffdc00;
-}
-
-.field.is-warning:focus,
-.field.is-warning.is-focused {
-  box-shadow: 0 0 0 2px rgba(255, 220, 0, 0.5);
-}
-
-.field:invalid,
-.field.is-error {
-  border-color: #ff4136;
-}
-
-.field:invalid:focus,
-.field:invalid.is-focused,
-.field.is-error:focus,
-.field.is-error.is-focused {
-  box-shadow: 0 0 0 2px rgba(255, 65, 54, 0.5);
-}
-
-.table-light th,
-.table-light td {
-  border-bottom-width: 1px;
-  border-bottom-style: solid;
-  border-bottom-color: rgba(0,0,0,.125);
-}
-
-.table-light tr:last-child td {
-  border-bottom: 0;
-}
-
-.btn {
-  font-family: inherit;
-  font-size: inherit;
-  font-weight: bold;
-  text-decoration: none;
-  cursor: pointer;
-  display: inline-block;
-  line-height: 1.125rem;
-  padding: .5rem 1rem;
-  margin: 0;
-  height: auto;
-  border: 1px solid transparent;
-  vertical-align: middle;
-  -webkit-appearance: none;
-  color: inherit;
-  background-color: transparent;
-}
-
-.btn:hover {
-  text-decoration: none;
-}
-
-.btn:focus {
-  outline: none;
-  border-color: rgba(0,0,0,.125);
-  box-shadow: 0 0 0 3px rgba(0,0,0,.25);
-}
-
-::-moz-focus-inner {
-  border: 0;
-  padding: 0;
-}
-
-.btn-primary {
-  color: #fff;
-  background-color: #0074d9;
-  border-radius: 3px;
-}
-
-.btn-primary:hover {
-  box-shadow: inset 0 0 0 20rem rgba(0,0,0,.0625);
-}
-
-.btn-primary:active {
-  box-shadow: inset 0 0 0 20rem rgba(0,0,0,.125),
-    inset 0 3px 4px 0 rgba(0,0,0,.25),
-    0 0 1px rgba(0,0,0,.125);
-}
-
-.btn-primary:disabled,
-.btn-primary.is-disabled {
-  opacity: .5;
-}
-
-.btn-outline,
-.btn-outline:hover {
-  border-color: currentcolor;
-}
-
-.btn-outline {
-  border-radius: 3px;
-}
-
-.btn-outline:hover {
-  box-shadow: inset 0 0 0 20rem rgba(0,0,0,.0625);
-}
-
-.btn-outline:active {
-  box-shadow: inset 0 0 0 20rem rgba(0,0,0,.125),
-    inset 0 3px 4px 0 rgba(0,0,0,.25),
-    0 0 1px rgba(0,0,0,.125);
-}
-
-.btn-outline:disabled,
-.btn-outline.is-disabled {
-  opacity: .5;
-}
 
 .h1{ font-size: 2rem }
 .h2{ font-size: 1.5rem }
@@ -309,7 +7,11 @@ hr {
 .h5{ font-size: .875rem }
 .h6{ font-size: .75rem }
 
-.bold    { font-weight: bold }
+.font-family-inherit{ font-family:inherit }
+.font-size-inherit{ font-size:inherit }
+.text-decoration-none{ text-decoration:none }
+
+.bold{ font-weight: bold; font-weight: bold }
 .regular{ font-weight:normal }
 .italic{ font-style:italic }
 .caps{ text-transform:uppercase; letter-spacing: .2em; }
@@ -322,6 +24,14 @@ hr {
 .nowrap{ white-space:nowrap }
 .break-word{ word-wrap:break-word }
 
+.line-height-1{ line-height: 1 }
+.line-height-2{ line-height: 1.125 }
+.line-height-3{ line-height: 1.25 }
+.line-height-4{ line-height: 1.5 }
+
+.list-style-none{ list-style:none }
+.underline{ text-decoration:underline }
+
 .truncate{
   max-width:100%;
   overflow:hidden;
@@ -356,6 +66,11 @@ hr {
 
 .fit{ max-width:100% }
 
+.max-width-1{ max-width: 24rem }
+.max-width-2{ max-width: 32rem }
+.max-width-3{ max-width: 48rem }
+.max-width-4{ max-width: 64rem }
+
 .border-box{ box-sizing:border-box }
 
 .align-baseline{ vertical-align:baseline }
@@ -368,113 +83,90 @@ hr {
 .mr0{ margin-right:0 }
 .mb0{ margin-bottom:0 }
 .ml0{ margin-left:0 }
+.mx0{ margin-left:0; margin-right:0 }
+.my0{ margin-top:0; margin-bottom:0 }
 
 .m1{ margin: .5rem }
 .mt1{ margin-top: .5rem }
 .mr1{ margin-right: .5rem }
 .mb1{ margin-bottom: .5rem }
 .ml1{ margin-left: .5rem }
+.mx1{ margin-left: .5rem; margin-right: .5rem }
+.my1{ margin-top: .5rem; margin-bottom: .5rem }
 
 .m2{ margin: 1rem }
 .mt2{ margin-top: 1rem }
 .mr2{ margin-right: 1rem }
 .mb2{ margin-bottom: 1rem }
 .ml2{ margin-left: 1rem }
+.mx2{ margin-left: 1rem; margin-right: 1rem }
+.my2{ margin-top: 1rem; margin-bottom: 1rem }
 
 .m3{ margin: 2rem }
 .mt3{ margin-top: 2rem }
 .mr3{ margin-right: 2rem }
 .mb3{ margin-bottom: 2rem }
 .ml3{ margin-left: 2rem }
+.mx3{ margin-left: 2rem; margin-right: 2rem }
+.my3{ margin-top: 2rem; margin-bottom: 2rem }
 
 .m4{ margin: 4rem }
 .mt4{ margin-top: 4rem }
 .mr4{ margin-right: 4rem }
 .mb4{ margin-bottom: 4rem }
 .ml4{ margin-left: 4rem }
+.mx4{ margin-left: 4rem; margin-right: 4rem }
+.my4{ margin-top: 4rem; margin-bottom: 4rem }
 
 .mxn1{ margin-left: -.5rem; margin-right: -.5rem; }
 .mxn2{ margin-left: -1rem; margin-right: -1rem; }
 .mxn3{ margin-left: -2rem; margin-right: -2rem; }
 .mxn4{ margin-left: -4rem; margin-right: -4rem; }
 
+.ml-auto{ margin-left:auto }
+.mr-auto{ margin-right:auto }
 .mx-auto{ margin-left:auto; margin-right:auto; }
+
 .p0{ padding:0 }
+.pt0{ padding-top:0 }
+.pr0{ padding-right:0 }
+.pb0{ padding-bottom:0 }
+.pl0{ padding-left:0 }
+.px0{ padding-left:0; padding-right:0 }
+.py0{ padding-top:0;  padding-bottom:0 }
 
 .p1{ padding: .5rem }
+.pt1{ padding-top: .5rem }
+.pr1{ padding-right: .5rem }
+.pb1{ padding-bottom: .5rem }
+.pl1{ padding-left: .5rem }
 .py1{ padding-top: .5rem; padding-bottom: .5rem }
 .px1{ padding-left: .5rem; padding-right: .5rem }
 
 .p2{ padding: 1rem }
+.pt2{ padding-top: 1rem }
+.pr2{ padding-right: 1rem }
+.pb2{ padding-bottom: 1rem }
+.pl2{ padding-left: 1rem }
 .py2{ padding-top: 1rem; padding-bottom: 1rem }
 .px2{ padding-left: 1rem; padding-right: 1rem }
 
 .p3{ padding: 2rem }
+.pt3{ padding-top: 2rem }
+.pr3{ padding-right: 2rem }
+.pb3{ padding-bottom: 2rem }
+.pl3{ padding-left: 2rem }
 .py3{ padding-top: 2rem; padding-bottom: 2rem }
 .px3{ padding-left: 2rem; padding-right: 2rem }
 
 .p4{ padding: 4rem }
+.pt4{ padding-top: 4rem }
+.pr4{ padding-right: 4rem }
+.pb4{ padding-bottom: 4rem }
+.pl4{ padding-left: 4rem }
 .py4{ padding-top: 4rem; padding-bottom: 4rem }
 .px4{ padding-left: 4rem; padding-right: 4rem }
 
-.relative { position: relative }
-.absolute { position: absolute }
-.fixed    { position: fixed }
-
-.top-0    { top: 0 }
-.right-0  { right: 0 }
-.bottom-0 { bottom: 0 }
-.left-0   { left: 0 }
-
-.z1 { z-index: 1 }
-.z2 { z-index: 2 }
-.z3 { z-index: 3 }
-.z4 { z-index: 4 }
-
-.sm-show, .md-show, .lg-show {
-  display: none !important
-}
-
-@media (min-width: 40em) {
-  .sm-show { display: block !important }
-}
-
-@media (min-width: 52em) {
-  .md-show { display: block !important }
-}
-
-@media (min-width: 64em) {
-  .lg-show { display: block !important }
-}
-
-
-@media (min-width: 40em) {
-  .sm-hide { display: none !important }
-}
-
-@media (min-width: 52em) {
-  .md-hide { display: none !important }
-}
-
-@media (min-width: 64em) {
-  .lg-hide { display: none !important }
-}
-
-.display-none { display: none !important }
-
-.hide {
-  position: absolute !important;
-  height: 1px;
-  width: 1px;
-  overflow: hidden;
-  clip: rect(1px, 1px, 1px, 1px);
-}
-
-.container {
-  max-width: 64em;
-  margin-left: auto;
-  margin-right: auto;
-}
 .col{
   float:left;
   box-sizing:border-box;
@@ -715,20 +407,47 @@ hr {
   }
 
 }
-
 .flex{ display:-webkit-box; display:-webkit-flex; display:-ms-flexbox; display:flex }
 
+@media (min-width: 40em){
+  .sm-flex{ display:-webkit-box; display:-webkit-flex; display:-ms-flexbox; display:flex }
+}
+
+@media (min-width: 52em){
+  .md-flex{ display:-webkit-box; display:-webkit-flex; display:-ms-flexbox; display:flex }
+}
+
+@media (min-width: 64em){
+  .lg-flex{ display:-webkit-box; display:-webkit-flex; display:-ms-flexbox; display:flex }
+}
+
 .flex-column{ -webkit-box-orient:vertical; -webkit-box-direction:normal; -webkit-flex-direction:column; -ms-flex-direction:column; flex-direction:column }
 .flex-wrap{ -webkit-flex-wrap:wrap; -ms-flex-wrap:wrap; flex-wrap:wrap }
 
-.flex-center   { -webkit-box-align: center; -webkit-align-items: center; -ms-flex-align: center; align-items: center }
+.items-start{ -webkit-box-align:start; -webkit-align-items:flex-start; -ms-flex-align:start; -ms-grid-row-align:flex-start; align-items:flex-start }
-.flex-baseline { -webkit-box-align: baseline; -webkit-align-items: baseline; -ms-flex-align: baseline; align-items: baseline }
+.items-end{ -webkit-box-align:end; -webkit-align-items:flex-end; -ms-flex-align:end; -ms-grid-row-align:flex-end; align-items:flex-end }
-.flex-stretch  { -webkit-box-align: stretch; -webkit-align-items: stretch; -ms-flex-align: stretch; align-items: stretch }
+.items-center{ -webkit-box-align:center; -webkit-align-items:center; -ms-flex-align:center; -ms-grid-row-align:center; align-items:center }
-.flex-start    { -webkit-box-align: start; -webkit-align-items: flex-start; -ms-flex-align: start; align-items: flex-start }
+.items-baseline{ -webkit-box-align:baseline; -webkit-align-items:baseline; -ms-flex-align:baseline; -ms-grid-row-align:baseline; align-items:baseline }
-.flex-end      { -webkit-box-align: end; -webkit-align-items: flex-end; -ms-flex-align: end; align-items: flex-end }
+.items-stretch{ -webkit-box-align:stretch; -webkit-align-items:stretch; -ms-flex-align:stretch; -ms-grid-row-align:stretch; align-items:stretch }
 
-.flex-justify  { -webkit-box-pack: justify; -webkit-justify-content: space-between; -ms-flex-pack: justify; justify-content: space-between }
+.self-start{ -webkit-align-self:flex-start; -ms-flex-item-align:start; align-self:flex-start }
+.self-end{ -webkit-align-self:flex-end; -ms-flex-item-align:end; align-self:flex-end }
+.self-center{ -webkit-align-self:center; -ms-flex-item-align:center; align-self:center }
+.self-baseline{ -webkit-align-self:baseline; -ms-flex-item-align:baseline; align-self:baseline }
+.self-stretch{ -webkit-align-self:stretch; -ms-flex-item-align:stretch; align-self:stretch }
 
+.justify-start{ -webkit-box-pack:start; -webkit-justify-content:flex-start; -ms-flex-pack:start; justify-content:flex-start }
+.justify-end{ -webkit-box-pack:end; -webkit-justify-content:flex-end; -ms-flex-pack:end; justify-content:flex-end }
+.justify-center{ -webkit-box-pack:center; -webkit-justify-content:center; -ms-flex-pack:center; justify-content:center }
+.justify-between{ -webkit-box-pack:justify; -webkit-justify-content:space-between; -ms-flex-pack:justify; justify-content:space-between }
+.justify-around{ -webkit-justify-content:space-around; -ms-flex-pack:distribute; justify-content:space-around }
+
+.content-start{ -webkit-align-content:flex-start; -ms-flex-line-pack:start; align-content:flex-start }
+.content-end{ -webkit-align-content:flex-end; -ms-flex-line-pack:end; align-content:flex-end }
+.content-center{ -webkit-align-content:center; -ms-flex-line-pack:center; align-content:center }
+.content-between{ -webkit-align-content:space-between; -ms-flex-line-pack:justify; align-content:space-between }
+.content-around{ -webkit-align-content:space-around; -ms-flex-line-pack:distribute; align-content:space-around }
+.content-stretch{ -webkit-align-content:stretch; -ms-flex-line-pack:stretch; align-content:stretch }
 .flex-auto{
   -webkit-box-flex:1;
   -webkit-flex:1 1 auto;
@@ -737,49 +456,51 @@ hr {
   min-width:0;
   min-height:0;
 }
-.flex-grow { -webkit-box-flex: 1; -webkit-flex: 1 0 auto; -ms-flex: 1 0 auto; flex: 1 0 auto }
 .flex-none{ -webkit-box-flex:0; -webkit-flex:none; -ms-flex:none; flex:none }
 
-.flex-first { -webkit-box-ordinal-group: 0; -webkit-order: -1; -ms-flex-order: -1; order: -1 }
+.order-0{ -webkit-box-ordinal-group:1; -webkit-order:0; -ms-flex-order:0; order:0 }
-.flex-last  { -webkit-box-ordinal-group: 100000; -webkit-order: 99999; -ms-flex-order: 99999; order: 99999 }
+.order-1{ -webkit-box-ordinal-group:2; -webkit-order:1; -ms-flex-order:1; order:1 }
-@media (min-width: 40em) {
+.order-2{ -webkit-box-ordinal-group:3; -webkit-order:2; -ms-flex-order:2; order:2 }
-  .sm-flex { display: -webkit-box; display: -webkit-flex; display: -ms-flexbox; display: flex }
+.order-3{ -webkit-box-ordinal-group:4; -webkit-order:3; -ms-flex-order:3; order:3 }
-}
+.order-last{ -webkit-box-ordinal-group:100000; -webkit-order:99999; -ms-flex-order:99999; order:99999 }
-@media (min-width: 52em) {
+
-  .md-flex { display: -webkit-box; display: -webkit-flex; display: -ms-flexbox; display: flex }
+.relative{ position:relative }
-}
+.absolute{ position:absolute }
-@media (min-width: 64em) {
+.fixed{ position:fixed }
-  .lg-flex { display: -webkit-box; display: -webkit-flex; display: -ms-flexbox; display: flex }
+
-}
+.top-0{ top:0 }
+.right-0{ right:0 }
+.bottom-0{ bottom:0 }
+.left-0{ left:0 }
+
+.z1{ z-index: 1 }
+.z2{ z-index: 2 }
+.z3{ z-index: 3 }
+.z4{ z-index: 4 }
 
 .border{
   border-style:solid;
   border-width: 1px;
-  border-color: rgba(0,0,0,.125);
 }
 
 .border-top{
   border-top-style:solid;
   border-top-width: 1px;
-  border-top-color: rgba(0,0,0,.125);
 }
 
 .border-right{
   border-right-style:solid;
   border-right-width: 1px;
-  border-right-color: rgba(0,0,0,.125);
 }
 
 .border-bottom{
   border-bottom-style:solid;
   border-bottom-width: 1px;
-  border-bottom-color: rgba(0,0,0,.125);
 }
 
 .border-left{
   border-left-style:solid;
   border-left-width: 1px;
-  border-left-color: rgba(0,0,0,.125);
 }
 
 .border-none{ border:0 }
@@ -794,57 +515,29 @@ hr {
 
 .not-rounded{ border-radius:0 }
 
-.black  { color: #111 }
+.hide{
-.gray   { color: #aaa }
+  position:absolute !important;
-.silver { color: #ddd }
+  height:1px;
-.white  { color: #fff }
+  width:1px;
+  overflow:hidden;
+  clip:rect(1px, 1px, 1px, 1px);
+}
 
-.aqua  { color: #7fdbff }
+@media (max-width: 40em){
-.blue  { color: #0074d9 }
+  .xs-hide{ display:none !important }
-.navy  { color: #001f3f }
+}
-.teal  { color: #39cccc }
-.green { color: #2ecc40 }
-.olive { color: #3d9970 }
-.lime  { color: #01ff70 }
 
-.yellow  { color: #ffdc00 }
+@media (min-width: 40em) and (max-width: 52em){
-.orange  { color: #ff851b }
+  .sm-hide{ display:none !important }
-.red     { color: #ff4136 }
+}
-.fuchsia { color: #f012be }
-.purple  { color: #b10dc9 }
-.maroon  { color: #85144b }
 
-.color-inherit { color: inherit }
+@media (min-width: 52em) and (max-width: 64em){
-.muted { opacity: .5 }
+  .md-hide{ display:none !important }
+}
 
-.bg-black  { background-color: #111 }
+@media (min-width: 64em){
-.bg-gray   { background-color: #aaa }
+  .lg-hide{ display:none !important }
-.bg-silver { background-color: #ddd }
+}
-.bg-white  { background-color: #fff }
-
-.bg-aqua  { background-color: #7fdbff }
-.bg-blue  { background-color: #0074d9 }
-.bg-navy  { background-color: #001f3f }
-.bg-teal  { background-color: #39cccc }
-.bg-green { background-color: #2ecc40 }
-.bg-olive { background-color: #3d9970 }
-.bg-lime  { background-color: #01ff70 }
-
-.bg-yellow  { background-color: #ffdc00 }
-.bg-orange  { background-color: #ff851b }
-.bg-red     { background-color: #ff4136 }
-.bg-fuchsia { background-color: #f012be }
-.bg-purple  { background-color: #b10dc9 }
-.bg-maroon  { background-color: #85144b }
-
-.bg-darken-1 { background-color: rgba(0,0,0,.0625) }
-.bg-darken-2 { background-color: rgba(0,0,0,.125) }
-.bg-darken-3 { background-color: rgba(0,0,0,.25) }
-.bg-darken-4 { background-color: rgba(0,0,0,.5) }
-
-.bg-lighten-1 { background-color: rgba(255,255,255,.0625) }
-.bg-lighten-2 { background-color: rgba(255,255,255,.125) }
-.bg-lighten-3 { background-color: rgba(255,255,255,.25) }
-.bg-lighten-4 { background-color: rgba(255,255,255,.5) }
 
+.display-none{ display:none !important }
 

docs/assets/fonts/LICENSE.txt

@@ -0,0 +1,93 @@
+Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+
+This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

docs/assets/fonts/source-code-pro.css

@@ -0,0 +1,23 @@
+@font-face{
+    font-family: 'Source Code Pro';
+    font-weight: 400;
+    font-style: normal;
+    font-stretch: normal;
+    src: url('EOT/SourceCodePro-Regular.eot') format('embedded-opentype'),
+         url('WOFF2/TTF/SourceCodePro-Regular.ttf.woff2') format('woff2'),
+         url('WOFF/OTF/SourceCodePro-Regular.otf.woff') format('woff'),
+         url('OTF/SourceCodePro-Regular.otf') format('opentype'),
+         url('TTF/SourceCodePro-Regular.ttf') format('truetype');
+}
+
+@font-face{
+    font-family: 'Source Code Pro';
+    font-weight: 700;
+    font-style: normal;
+    font-stretch: normal;
+    src: url('EOT/SourceCodePro-Bold.eot') format('embedded-opentype'),
+         url('WOFF2/TTF/SourceCodePro-Bold.ttf.woff2') format('woff2'),
+         url('WOFF/OTF/SourceCodePro-Bold.otf.woff') format('woff'),
+         url('OTF/SourceCodePro-Bold.otf') format('opentype'),
+         url('TTF/SourceCodePro-Bold.ttf') format('truetype');
+}

docs/assets/site.js

@@ -2,39 +2,107 @@
 
 // add anchor links to headers
 anchors.options.placement = 'left';
-anchors.add().remove('.no-anchor');
+anchors.add('h3');
 
 // Filter UI
-var tocElements = document.getElementById('toc').getElementsByTagName('a');
+var tocElements = document.getElementById('toc')
-document.getElementById('filter-input').addEventListener('keyup', function(e) {
+  .getElementsByTagName('li');
 
-  var i, element;
+document.getElementById('filter-input')
+  .addEventListener('keyup', function (e) {
+
+    var i, element, children;
 
     // enter key
     if (e.keyCode === 13) {
       // go to the first displayed item in the toc
       for (i = 0; i < tocElements.length; i++) {
         element = tocElements[i];
-      if (!element.classList.contains('hide')) {
+        if (!element.classList.contains('display-none')) {
-        location.replace(element.href);
+          location.replace(element.firstChild.href);
           return e.preventDefault();
         }
       }
     }
 
-  var match = function() { return true; },
+    var match = function () {
-    value = this.value.toLowerCase();
+      return true;
+    };
+
+    var value = this.value.toLowerCase();
 
     if (!value.match(/^\s*$/)) {
-    match = function(text) { return text.toLowerCase().indexOf(value) !== -1; };
+      match = function (element) {
+        return element.firstChild.innerHTML.toLowerCase().indexOf(value) !== -1;
+      };
     }
 
     for (i = 0; i < tocElements.length; i++) {
       element = tocElements[i];
-    if (match(element.innerHTML)) {
+      children = Array.from(element.getElementsByTagName('li'));
-      element.classList.remove('hide');
+      if (match(element) || children.some(match)) {
+        element.classList.remove('display-none');
       } else {
-      element.classList.add('hide');
+        element.classList.add('display-none');
       }
     }
   });
+
+var toggles = document.getElementsByClassName('toggle-step-sibling');
+for (var i = 0; i < toggles.length; i++) {
+  toggles[i].addEventListener('click', toggleStepSibling);
+}
+
+function toggleStepSibling() {
+  var stepSibling = this.parentNode.parentNode.parentNode.getElementsByClassName('toggle-target')[0];
+  var klass = 'display-none';
+  if (stepSibling.classList.contains(klass)) {
+    stepSibling.classList.remove(klass);
+    stepSibling.innerHTML = '▾';
+  } else {
+    stepSibling.classList.add(klass);
+    stepSibling.innerHTML = '▸';
+  }
+}
+
+var items = document.getElementsByClassName('toggle-sibling');
+for (var j = 0; j < items.length; j++) {
+  items[j].addEventListener('click', toggleSibling);
+}
+
+function toggleSibling() {
+  var stepSibling = this.parentNode.getElementsByClassName('toggle-target')[0];
+  var icon = this.getElementsByClassName('icon')[0];
+  var klass = 'display-none';
+  if (stepSibling.classList.contains(klass)) {
+    stepSibling.classList.remove(klass);
+    icon.innerHTML = '▾';
+  } else {
+    stepSibling.classList.add(klass);
+    icon.innerHTML = '▸';
+  }
+}
+
+function showHashTarget(targetId) {
+  var hashTarget = document.getElementById(targetId);
+  // new target is hidden
+  if (hashTarget && hashTarget.offsetHeight === 0 &&
+    hashTarget.parentNode.parentNode.classList.contains('display-none')) {
+    hashTarget.parentNode.parentNode.classList.remove('display-none');
+  }
+}
+
+window.addEventListener('hashchange', function() {
+  showHashTarget(location.hash.substring(1));
+});
+
+showHashTarget(location.hash.substring(1));
+
+var toclinks = document.getElementsByClassName('pre-open');
+for (var k = 0; k < toclinks.length; k++) {
+  toclinks[k].addEventListener('mousedown', preOpen, false);
+}
+
+function preOpen() {
+  showHashTarget(this.hash.substring(1));
+}

docs/assets/style.css

@@ -1,68 +1,55 @@
-.documentation a {
+.documentation {
+  font-family: Helvetica, sans-serif;
+  color: #666;
+  line-height: 1.5;
+  background: #f5f5f5;
+}
+
+.black {
+  color: #666;
+}
+
+.bg-white {
+  background-color: #fff;
+}
+
+h4 {
+  margin: 20px 0 10px 0;
+}
+
+.documentation h3 {
+  color: #000;
+}
+
+.border-bottom {
+  border-color: #ddd;
+}
+
+a {
   color: #1184CE;
+  text-decoration: none;
 }
 
-.documentation .suppress-p-margin p {
+.documentation a[href]:hover {
-  margin:0;
+  text-decoration: underline;
 }
 
-.force-inline, .force-inline p {
+a:hover {
-  display: inline;
+  cursor: pointer;
-  color: #222;
 }
 
-.container-small {
+.py1-ul li {
-  max-width: 58rem;
+  padding: 5px 0;
-  margin-left: auto;
-  margin-right: auto;
 }
 
 .max-height-100 {
   max-height: 100%;
 }
 
-.fade {
-  opacity:0.50;
-}
-
-.button-indent {
-  padding: .25rem 1.5rem;
-  font-size: 90%;
-}
-
-.section-indent {
-  border-left: 2px solid #eee;
-}
-
-.bg-cloudy {
-  background: #fafafa;
-}
-
-.force-inline * {
-  display:inline;
-}
-
 section:target h3 {
   font-weight:700;
 }
 
-.documentation,
-.documentation h1,
-.documentation h2,
-.documentation h3,
-.documentation h4,
-.documentation h5,
-.documentation h6 {
-    font-family: 'Source Sans Pro', Helvetica, sans-serif;
-}
-
-.documentation pre,
-.documentation code,
-.documentation samp {
-  font-family: 'Source Code Pro', monospace;
-  font-size: 90%;
-}
-
 .documentation td,
 .documentation th {
     padding: .25rem .25rem;
@@ -75,12 +62,9 @@ h4:hover .anchorjs-link {
   opacity: 1;
 }
 
-.collapsible .collapser {
+.fix-3 {
-  display:none;
+  width: 25%;
-}
+  max-width: 244px;
-
-.collapsible:target .collapser {
-  display: block;
 }
 
 .fix-3 {
@@ -93,3 +77,60 @@ h4:hover .anchorjs-link {
     margin-left: 25%;
   }
 }
+
+.pre, pre, code, .code {
+  font-family: Source Code Pro,Menlo,Consolas,Liberation Mono,monospace;
+  font-size: 14px;
+}
+
+.fill-light {
+  background: #F9F9F9;
+}
+
+.width2 {
+  width: 1rem;
+}
+
+.input {
+  font-family: inherit;
+  display: block;
+  width: 100%;
+  height: 2rem;
+  padding: .5rem;
+  margin-bottom: 1rem;
+  border: 1px solid #ccc;
+  font-size: .875rem;
+  border-radius: 3px;
+  box-sizing: border-box;
+}
+
+table {
+  border-collapse: collapse;
+}
+
+.prose table th,
+.prose table td {
+  text-align: left;
+  padding:8px;
+  border:1px solid #ddd;
+}
+
+.prose table th:nth-child(1) { border-right: none; }
+.prose table th:nth-child(2) { border-left: none; }
+
+.prose table {
+  border:1px solid #ddd;
+}
+
+.prose-big {
+  font-size: 18px;
+  line-height: 30px;
+}
+
+.quiet {
+  opacity: 0.7;
+}
+
+.minishadow {
+  box-shadow: 2px 2px 10px #f3f3f3;
+}