Update docs
This commit is contained in:
parent
5a7d0b9934
commit
5576737caf
789
API.md
789
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
|
||||
- `where` **[Object]** Where clause for delete statement
|
||||
- `callback` **[Function]** Callback for handling response from the database
|
||||
- `sql` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The sql to execute
|
||||
- `params` **\[[array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)]** The query parameters
|
||||
- `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
|
||||
- `limit` **[Number]** A limit for the query
|
||||
- `offset` **[Number]** An offset for the query
|
||||
- `callback` **[Function]** A callback for receiving the result
|
||||
- `table` **\[[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** The table to select from
|
||||
- `limit` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** A limit 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](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
|
||||
|
||||
## 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
|
||||
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
|
||||
|
||||
## insert
|
||||
|
||||
|
@ -198,11 +480,11 @@ Run the generated insert query
|
|||
|
||||
**Parameters**
|
||||
|
||||
- `table` **String** The table to insert into
|
||||
- `data` **[Object]** Data to insert, if not already added with the 'set' method
|
||||
- `callback` **[Function]** Callback for handling response from the database
|
||||
- `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert into
|
||||
- `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](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
|
||||
- `data` **Array** The array of objects containing data rows to insert
|
||||
- `callback` **[Function]** Callback for handling database response
|
||||
- `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert into
|
||||
- `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](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
|
||||
|
||||
## 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
|
||||
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
|
||||
|
||||
## update
|
||||
|
||||
|
@ -463,64 +515,67 @@ Run the generated update query
|
|||
|
||||
**Parameters**
|
||||
|
||||
- `table` **String** The table to insert into
|
||||
- `data` **[Object]** Data to insert, if not already added with the 'set' method
|
||||
- `callback` **[Function]** Callback for handling response from the database
|
||||
- `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert into
|
||||
- `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](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
|
||||
- `val` **[String or Number]** The value to compare if the value of key is a string
|
||||
- `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert into
|
||||
- `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
|
||||
- `values` **Array** the array of items to search in
|
||||
- `table` **\[[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** the name of the table to retrieve from
|
||||
- `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
|
||||
- `values` **Array** the array of items to search in
|
||||
- `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the name of the table to delete from
|
||||
- `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
|
||||
- `columns` **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
|
||||
- `rows` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** the data rows of the result
|
||||
- `columns` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** the column names 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
|
||||
|
|
|
@ -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)
|
||||
|
||||
|
|
|
@ -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;
|
||||
}
|
File diff suppressed because it is too large
Load Diff
Binary file not shown.
Binary file not shown.
|
@ -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.
|
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
@ -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');
|
||||
}
|
|
@ -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');
|
||||
document.getElementById('filter-input').addEventListener('keyup', function(e) {
|
||||
var tocElements = document.getElementById('toc')
|
||||
.getElementsByTagName('li');
|
||||
|
||||
var i, element;
|
||||
document.getElementById('filter-input')
|
||||
.addEventListener('keyup', function (e) {
|
||||
|
||||
// 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')) {
|
||||
location.replace(element.href);
|
||||
return e.preventDefault();
|
||||
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('display-none')) {
|
||||
location.replace(element.firstChild.href);
|
||||
return e.preventDefault();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
var match = function() { return true; },
|
||||
value = this.value.toLowerCase();
|
||||
var match = function () {
|
||||
return true;
|
||||
};
|
||||
|
||||
if (!value.match(/^\s*$/)) {
|
||||
match = function(text) { return text.toLowerCase().indexOf(value) !== -1; };
|
||||
}
|
||||
var value = this.value.toLowerCase();
|
||||
|
||||
for (i = 0; i < tocElements.length; i++) {
|
||||
element = tocElements[i];
|
||||
if (match(element.innerHTML)) {
|
||||
element.classList.remove('hide');
|
||||
} else {
|
||||
element.classList.add('hide');
|
||||
if (!value.match(/^\s*$/)) {
|
||||
match = function (element) {
|
||||
return element.firstChild.innerHTML.toLowerCase().indexOf(value) !== -1;
|
||||
};
|
||||
}
|
||||
|
||||
for (i = 0; i < tocElements.length; i++) {
|
||||
element = tocElements[i];
|
||||
children = Array.from(element.getElementsByTagName('li'));
|
||||
if (match(element) || children.some(match)) {
|
||||
element.classList.remove('display-none');
|
||||
} else {
|
||||
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));
|
||||
}
|
||||
|
|
|
@ -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 {
|
||||
margin:0;
|
||||
.documentation a[href]:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
.force-inline, .force-inline p {
|
||||
display: inline;
|
||||
color: #222;
|
||||
a:hover {
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.container-small {
|
||||
max-width: 58rem;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
.py1-ul li {
|
||||
padding: 5px 0;
|
||||
}
|
||||
|
||||
.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 {
|
||||
display:none;
|
||||
}
|
||||
|
||||
.collapsible:target .collapser {
|
||||
display: block;
|
||||
.fix-3 {
|
||||
width: 25%;
|
||||
max-width: 244px;
|
||||
}
|
||||
|
||||
.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;
|
||||
}
|
||||
|
|
6124
docs/index.html
6124
docs/index.html
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue