docs update for 0.5.2

2025-12-28 07:29:16 +00:00 · 2013-12-18 17:27:16 -05:00 · 2013-12-18 17:27:16 -05:00 · 373868cfbc
commit 373868cfbc
parent 5b5a6f62fd
5 changed files with 36 additions and 16 deletions
--- a/docs/assets/behavior.js
+++ b/docs/assets/behavior.js
@ -545,8 +545,8 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3
          "type": "heading",
          "data": {
            "level": 2,
-            "title": "Knex.js  0.5.1",
-            "slug": "knexjs-051"
+            "title": "Knex.js  0.5.2",
+            "slug": "knexjs-052"
          },
          "depth": 2
        }
--- a/docs/knex.html
+++ b/docs/knex.html
@ -1,4 +1,4 @@
-<!DOCTYPE html><html lang="en"><head><title>knex</title></head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0"><meta name="groc-relative-root" content=""><meta name="groc-document-path" content="knex"><meta name="groc-project-path" content="knex.js"><link rel="stylesheet" type="text/css" media="all" href="assets/style.css"><script type="text/javascript" src="assets/behavior.js"></script><body><div id="meta"><div class="file-path">knex.js</div></div><div id="document"><div class="segment"><div class="comments"><div class="wrapper"><h2 id="knexjs-051">Knex.js  0.5.1</h2></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><pre><code>(c) 2013 Tim Griesser
+<!DOCTYPE html><html lang="en"><head><title>knex</title></head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0"><meta name="groc-relative-root" content=""><meta name="groc-document-path" content="knex"><meta name="groc-project-path" content="knex.js"><link rel="stylesheet" type="text/css" media="all" href="assets/style.css"><script type="text/javascript" src="assets/behavior.js"></script><body><div id="meta"><div class="file-path">knex.js</div></div><div id="document"><div class="segment"><div class="comments"><div class="wrapper"><h2 id="knexjs-052">Knex.js  0.5.2</h2></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><pre><code>(c) 2013 Tim Griesser
 Knex may be freely distributed under the MIT license.
 For details and documentation:
 http://knexjs.org
@ -53,7 +53,7 @@ rather than wait on an async load of a client library.</p></div></div><div class
    <span class="p">};</span>
  <span class="p">});</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Method to run a new <code>Raw</code> query on the current client.</p></div></div><div class="code"><div class="wrapper">  <span class="nx">knex</span><span class="p">.</span><span class="nx">raw</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">sql</span><span class="p">,</span> <span class="nx">bindings</span><span class="p">)</span> <span class="p">{</span>
    <span class="k">return</span> <span class="k">new</span> <span class="nx">Raw</span><span class="p">(</span><span class="nx">knex</span><span class="p">).</span><span class="nx">query</span><span class="p">(</span><span class="nx">sql</span><span class="p">,</span> <span class="nx">bindings</span><span class="p">);</span>
-  <span class="p">};</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Keep a reference to the current client.</p></div></div><div class="code"><div class="wrapper">  <span class="nx">knex</span><span class="p">.</span><span class="nx">client</span> <span class="o">=</span> <span class="nx">client</span><span class="p">;</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Keep in sync with package.json</p></div></div><div class="code"><div class="wrapper">  <span class="nx">knex</span><span class="p">.</span><span class="nx">VERSION</span> <span class="o">=</span> <span class="s1">&#39;0.5.1&#39;</span><span class="p">;</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Runs a new transaction, taking a container and returning a promise
+  <span class="p">};</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Keep a reference to the current client.</p></div></div><div class="code"><div class="wrapper">  <span class="nx">knex</span><span class="p">.</span><span class="nx">client</span> <span class="o">=</span> <span class="nx">client</span><span class="p">;</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Keep in sync with package.json</p></div></div><div class="code"><div class="wrapper">  <span class="nx">knex</span><span class="p">.</span><span class="nx">VERSION</span> <span class="o">=</span> <span class="s1">&#39;0.5.2&#39;</span><span class="p">;</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Runs a new transaction, taking a container and returning a promise
 for when the transaction is resolved.</p></div></div><div class="code"><div class="wrapper">  <span class="nx">knex</span><span class="p">.</span><span class="nx">transaction</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">container</span><span class="p">)</span> <span class="p">{</span>
    <span class="k">return</span> <span class="k">new</span> <span class="nx">Transaction</span><span class="p">(</span><span class="nx">knex</span><span class="p">).</span><span class="nx">run</span><span class="p">(</span><span class="nx">container</span><span class="p">);</span>
  <span class="p">};</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Attach each of the <code>Migrate</code> "interface" methods directly onto to <code>knex.migrate</code> namespace, e.g.:
--- a/docs/lib/common.html
+++ b/docs/lib/common.html
@ -22,13 +22,7 @@ client adapter, we know to <code>log</code> the query.</p></div></div><div class
 Multiple calls to <code>exec</code> will resolve with the same value
 if called more than once. Any unhandled errors will be thrown
 after the last block.</p></div></div><div class="code"><div class="wrapper">  <span class="nx">exec</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">callback</span><span class="p">)</span> <span class="p">{</span>
-    <span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">resp</span><span class="p">)</span> <span class="p">{</span>
-      <span class="k">if</span> <span class="p">(</span><span class="nx">callback</span><span class="p">)</span> <span class="nx">callback</span><span class="p">(</span><span class="kc">null</span><span class="p">,</span> <span class="nx">resp</span><span class="p">);</span>
-    <span class="p">},</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">{</span>
-      <span class="k">if</span> <span class="p">(</span><span class="nx">callback</span><span class="p">)</span> <span class="nx">callback</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="kc">null</span><span class="p">);</span>
-    <span class="p">}).</span><span class="nx">caught</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">{</span>
-      <span class="nx">setTimeout</span><span class="p">(</span><span class="kd">function</span><span class="p">()</span> <span class="p">{</span> <span class="k">throw</span> <span class="nx">err</span><span class="p">;</span> <span class="p">},</span> <span class="mi">0</span><span class="p">);</span>
-    <span class="p">});</span>
+    <span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">then</span><span class="p">().</span><span class="nx">nodeify</span><span class="p">(</span><span class="nx">callback</span><span class="p">);</span>
  <span class="p">},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>The promise interface for the query builder.</p></div></div><div class="code"><div class="wrapper">  <span class="nx">then</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">onFulfilled</span><span class="p">,</span> <span class="nx">onRejected</span><span class="p">)</span> <span class="p">{</span>
    <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="k">this</span><span class="p">.</span><span class="nx">_promise</span><span class="p">)</span> <span class="p">{</span>
      <span class="k">this</span><span class="p">.</span><span class="nx">_promise</span> <span class="o">=</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="k">this</span><span class="p">);</span>
@ -37,7 +31,27 @@ after the last block.</p></div></div><div class="code"><div class="wrapper">  <s
      <span class="p">}).</span><span class="nx">bind</span><span class="p">();</span>
    <span class="p">}</span>
    <span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">_promise</span><span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">onFulfilled</span><span class="p">,</span> <span class="nx">onRejected</span><span class="p">);</span>
-  <span class="p">},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Passthrough to the convenient <code>tap</code> mechanism of when.js</p></div></div><div class="code"><div class="wrapper">  <span class="nx">tap</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">handler</span><span class="p">)</span> <span class="p">{</span>
+  <span class="p">},</span>
+
+  <span class="k">catch</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
+    <span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">caught</span><span class="p">.</span><span class="nx">apply</span><span class="p">(</span><span class="k">this</span><span class="p">,</span> <span class="nx">arguments</span><span class="p">);</span>
+  <span class="p">},</span>
+
+  <span class="nx">caught</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
+    <span class="kd">var</span> <span class="nx">promise</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">then</span><span class="p">();</span>
+    <span class="k">return</span> <span class="nx">promise</span><span class="p">.</span><span class="nx">caught</span><span class="p">.</span><span class="nx">apply</span><span class="p">(</span><span class="nx">promise</span><span class="p">,</span> <span class="nx">arguments</span><span class="p">);</span>
+  <span class="p">},</span>
+
+  <span class="nx">lastly</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
+    <span class="kd">var</span> <span class="nx">promise</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">then</span><span class="p">();</span>
+    <span class="k">return</span> <span class="nx">promise</span><span class="p">.</span><span class="nx">lastly</span><span class="p">.</span><span class="nx">apply</span><span class="p">(</span><span class="nx">promise</span><span class="p">,</span> <span class="nx">arguments</span><span class="p">);</span>
+  <span class="p">},</span>
+
+  <span class="k">finally</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
+    <span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">lastly</span><span class="p">.</span><span class="nx">apply</span><span class="p">(</span><span class="k">this</span><span class="p">,</span> <span class="nx">arguments</span><span class="p">);</span>
+  <span class="p">},</span>
+
+  <span class="nx">tap</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">handler</span><span class="p">)</span> <span class="p">{</span>
    <span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">then</span><span class="p">().</span><span class="nx">tap</span><span class="p">(</span><span class="nx">handler</span><span class="p">);</span>
  <span class="p">},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Returns an array of query strings filled out with the
 correct values based on bindings, etc. Useful for debugging.</p></div></div><div class="code"><div class="wrapper">  <span class="nx">toString</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>TODO: get rid of the need to clone the object here...</p></div></div><div class="code"><div class="wrapper">    <span class="kd">var</span> <span class="nx">builder</span> <span class="o">=</span> <span class="k">this</span><span class="p">,</span> <span class="nx">data</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">clone</span><span class="p">().</span><span class="nx">toSql</span><span class="p">();</span>
--- a/index.html
+++ b/index.html
@ -185,7 +185,7 @@
  <div id="sidebar" class="interface">

    <a class="toc_title" href="#">
-      Knex.js <span class="version">(0.5.1)</span>
+      Knex.js <span class="version">(0.5.2)</span>
    </a>
    <ul class="toc_section">
      <li>&raquo; <a href="https://github.com/tgriesser/knex">GitHub Repository</a></li>
@ -370,7 +370,7 @@
    </p>


-    <h2>Latest Release: 0.5.1 - <span class="small"><a href="#changelog">Change Log</a></span></h2>
+    <h2>Latest Release: 0.5.2 - <span class="small"><a href="#changelog">Change Log</a></span></h2>

    <p>
      Current Develop &mdash;
@ -1455,6 +1455,12 @@ process.stderr.on('data', function() {

    <h2 id="changelog">Change Log</h2>

+    <p>
+      <b class="header">0.5.2</b> &mdash; <small><i>Dec 18, 2013</i></small> &mdash; <a href="https://github.com/tgriesser/knex/compare/0.5.1...0.5.2">Diff</a><br />
+      Adding passthrough "catch", "finally" to bluebird implementations, use
+      bluebird's "nodeify" internally for exec.
+    </p>
+
    <p>
      <b class="header">0.5.1</b> &mdash; <small><i>Dec 12, 2013</i></small> &mdash; <a href="https://github.com/tgriesser/knex/compare/0.5.0...0.5.1">Diff</a><br />
      <ul>
--- a/knex.js
+++ b/knex.js
@ -1,4 +1,4 @@
-// Knex.js  0.5.1
+// Knex.js  0.5.2
 // --------------

 //     (c) 2013 Tim Griesser
@ -88,7 +88,7 @@ var Knex = function(config) {
  knex.client = client;

  // Keep in sync with package.json
-  knex.VERSION = '0.5.1';
+  knex.VERSION = '0.5.2';

  // Runs a new transaction, taking a container and returning a promise
  // for when the transaction is resolved.