Skip to content

Commit

Permalink
docs update.
Browse files Browse the repository at this point in the history
  • Loading branch information
vitaly-t committed Nov 26, 2015
1 parent 8755da1 commit c2dfdb2
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 13 deletions.
12 changes: 6 additions & 6 deletions API/txMode.md
Expand Up @@ -19,7 +19,7 @@
## txMode
Extends the default `BEGIN` with Transaction Mode parameters: - isolation level - access mode - deferrable mode

**See**: [BEGIN](http://www.postgresql.org/docs/9.4/static/sql-begin.html)
**See**: <a href="http://www.postgresql.org/docs/9.4/static/sql-begin.html">BEGIN</a>
**Author:** Vitaly Tomilov

* [txMode](#module_txMode)
Expand All @@ -29,7 +29,7 @@ Extends the default `BEGIN` with Transaction Mode parameters: - isolation level
<a name="module_txMode.TransactionMode"></a>
### txMode.TransactionMode
**Kind**: static class of <code>[txMode](#module_txMode)</code>
**See**: [BEGIN](http://www.postgresql.org/docs/9.4/static/sql-begin.html)
**See**: <a href="http://www.postgresql.org/docs/9.4/static/sql-begin.html">BEGIN</a>
<a name="new_module_txMode.TransactionMode_new"></a>
#### new TransactionMode([tiLevel], [readOnly], [deferrable])
**Alternative Syntax:** `TransactionMode({tiLevel, readOnly, deferrable})`Constructs a complete transaction opening command,based on Transaction Mode parameters: - isolation level - access mode - deferrable mode
Expand All @@ -48,16 +48,16 @@ Extends the default `BEGIN` with Transaction Mode parameters: - isolation level
<td>[readOnly]</td><td><code>Boolean</code></td><td><p>Sets transaction access mode based on the read-only flag:</p>
<ul>
<li><code>undefined</code> - access mode not specified (default)</li>
<li><code>true</code> - access mode is <code>READ ONLY</code></li>
<li><code>false</code> - access mode is <code>READ WRITE</code></li>
<li><code>true</code> - access mode is set as <code>READ ONLY</code></li>
<li><code>false</code> - access mode is set as <code>READ WRITE</code></li>
</ul>
</td>
</tr><tr>
<td>[deferrable]</td><td><code>Boolean</code></td><td><p>Sets transaction deferrable mode based on the boolean value:</p>
<ul>
<li><code>undefined</code> - deferrable mode not specified (default)</li>
<li><code>true</code> - mode set as <code>DEFERRABLE</code></li>
<li><code>false</code> - mode set as <code>NOT DEFERRABLE</code></li>
<li><code>true</code> - mode is set as <code>DEFERRABLE</code></li>
<li><code>false</code> - mode is set as <code>NOT DEFERRABLE</code></li>
</ul>
</td>
</tr> </tbody>
Expand Down
3 changes: 2 additions & 1 deletion gruntfile.js
Expand Up @@ -50,7 +50,8 @@ var links = {
"Result": "https://github.com/brianc/node-postgres/blob/master/lib/result.js#L6",
"pg-query-stream": "https://github.com/brianc/node-pg-query-stream",
"QueryStream": "https://github.com/brianc/node-pg-query-stream/blob/master/index.js#L5",
"pg.Client": "https://github.com/brianc/node-postgres/wiki/Client"
"pg.Client": "https://github.com/brianc/node-postgres/wiki/Client",
"BEGIN": "http://www.postgresql.org/docs/9.4/static/sql-begin.html"
};

var fs = require("fs");
Expand Down
12 changes: 6 additions & 6 deletions lib/txMode.js
Expand Up @@ -38,18 +38,18 @@ Object.freeze(isolationLevel);
* @param {Boolean} [readOnly]
* Sets transaction access mode based on the read-only flag:
* - `undefined` - access mode not specified (default)
* - `true` - access mode is `READ ONLY`
* - `false` - access mode is `READ WRITE`
* - `true` - access mode is set as `READ ONLY`
* - `false` - access mode is set as `READ WRITE`
*
* @param {Boolean} [deferrable]
* Sets transaction deferrable mode based on the boolean value:
* - `undefined` - deferrable mode not specified (default)
* - `true` - mode set as `DEFERRABLE`
* - `false` - mode set as `NOT DEFERRABLE`
* - `true` - mode is set as `DEFERRABLE`
* - `false` - mode is set as `NOT DEFERRABLE`
*
* @returns {TransactionMode}
*
* @see {@link http://www.postgresql.org/docs/9.4/static/sql-begin.html BEGIN}
* @see $[BEGIN]
*/
function TransactionMode(tiLevel, readOnly, deferrable) {

Expand Down Expand Up @@ -118,7 +118,7 @@ function TransactionMode(tiLevel, readOnly, deferrable) {
* - access mode
* - deferrable mode
*
* @see {@link http://www.postgresql.org/docs/9.4/static/sql-begin.html BEGIN}
* @see $[BEGIN]
*/
module.exports = {
isolationLevel: isolationLevel,
Expand Down

0 comments on commit c2dfdb2

Please sign in to comment.