Permalink
Browse files

API documentation for pause/resume (#618)

  • Loading branch information...
1 parent debaf40 commit 3040edf3367a833f088df4ef4252918dfaf0f95c @chdh chdh committed with arthurschreiber Oct 12, 2017
Showing with 25 additions and 0 deletions.
  1. +25 −0 api-request.html
View
@@ -20,6 +20,8 @@
<li><a href="#event_returnValue">Event: 'returnValue'</a></li>
<li><a href="#function_addParameter">request.addParameter(name, type, value, [options])</a></li>
<li><a href="#function_addOutputParameter">request.addOutputParameter(name, type, [value], [options])</a></li>
+ <li><a href="#function_pause">request.pause()</a></li>
+ <li><a href="#function_resume">request.resume()</a></li>
</ul>
<h2 id="function_newRequest">new Request(sql, callback)</h2>
@@ -488,3 +490,26 @@ <h2 id="function_addOutputParameter">request.addOutputParameter(name, type, [val
</p>
</div>
</div>
+
+<h2 id="function_pause">request.pause()</h2>
+<p>
+ Temporarily suspends the flow of data from the database.
+ No more <code>'row'</code> events will be emitted until <a href="#function_resume"><code>request.resume()</code></a> is called.
+</p>
+{% highlight javascript %}
+request.pause();
+{% endhighlight %}
+<p>
+ If this request is already in a paused state, calling <code>pause()</code> has no effect.
+</p>
+
+<h2 id="function_resume">request.resume()</h2>
+<p>
+ Resumes the flow of data from the database.
+</p>
+{% highlight javascript %}
+request.resume();
+{% endhighlight %}
+<p>
+ If this request is not in a paused state, calling <code>resume()</code> has no effect.
+</p>

0 comments on commit 3040edf

Please sign in to comment.