Skip to content

Commit

Permalink
Update docco docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@darach
darach committed Mar 18, 2014
1 parent 0d29f76 commit 1f5e157
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 12 deletions.
6 changes: 4 additions & 2 deletions docs/eep.clock_wall.html
View file
Expand Up @@ -27,6 +27,7 @@

<span class="nx">self</span><span class="p">.</span><span class="nx">init</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="nx">at</span> <span class="o">=</span> <span class="k">new</span> <span class="nb">Date</span><span class="p">().</span><span class="nx">getTime</span><span class="p">();</span>
<span class="nx">mark</span> <span class="o">=</span> <span class="nx">at</span> <span class="o">+</span> <span class="nx">interval</span><span class="p">;</span>
<span class="k">return</span> <span class="nx">at</span><span class="p">;</span>
<span class="p">};</span>

Expand All @@ -36,10 +37,11 @@

<span class="nx">self</span><span class="p">.</span><span class="nx">tick</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">mark</span> <span class="o">===</span> <span class="kc">null</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">mark</span> <span class="o">=</span> <span class="nx">at</span> <span class="o">+</span> <span class="nx">interval</span><span class="p">;</span>
<span class="k">throw</span> <span class="s2">&quot;clock was not initialized&quot;</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">self</span><span class="p">.</span><span class="nx">inc</span><span class="p">();</span>

<span class="k">return</span> <span class="p">((</span><span class="nx">at</span> <span class="o">-</span> <span class="nx">mark</span><span class="p">)</span> <span class="o">&gt;=</span> <span class="nx">interval</span><span class="p">);</span>
<span class="k">return</span> <span class="p">((</span><span class="nx">at</span> <span class="o">-</span> <span class="nx">mark</span><span class="p">)</span> <span class="o">&gt;=</span> <span class="mi">0</span><span class="p">);</span>
<span class="p">};</span>

<span class="nx">self</span><span class="p">.</span><span class="nx">tock</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">elapsed</span><span class="p">)</span> <span class="p">{</span>
Expand Down
4 changes: 2 additions & 2 deletions docs/eep.window_monotonic.html
View file
Expand Up @@ -33,10 +33,10 @@
<span class="p">};</span>

<span class="nx">self</span><span class="p">.</span><span class="nx">tick</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">&#182;</a> </div> <p>If time hasn't passed, we're done</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">clock</span><span class="p">.</span><span class="nx">tick</span><span class="p">())</span> <span class="k">return</span><span class="p">;</span></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">&#182;</a> </div> <p>Otherwise, emit</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">if</span> <span class="p">(</span><span class="nx">clock</span><span class="p">.</span><span class="nx">tock</span><span class="p">(</span><span class="nx">self</span><span class="p">.</span><span class="nx">fn</span><span class="p">.</span><span class="nx">at</span><span class="p">()))</span> <span class="p">{</span>
<span class="nx">self</span><span class="p">.</span><span class="nx">emit</span><span class="p">(</span><span class="s1">&#39;emit&#39;</span><span class="p">,</span> <span class="nx">self</span><span class="p">.</span><span class="nx">fn</span><span class="p">.</span><span class="nx">emit</span><span class="p">().</span><span class="nx">value</span><span class="p">());</span></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">&#182;</a> </div> <p>'close' current window and 'open' a new one</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">self</span><span class="p">.</span><span class="nx">fn</span><span class="p">.</span><span class="nx">init</span><span class="p">();</span>
<span class="nx">self</span><span class="p">.</span><span class="nx">emit</span><span class="p">(</span><span class="s1">&#39;emit&#39;</span><span class="p">,</span> <span class="nx">self</span><span class="p">.</span><span class="nx">fn</span><span class="p">.</span><span class="nx">emit</span><span class="p">().</span><span class="nx">value</span><span class="p">());</span></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">&#182;</a> </div> <p>for ordering, send a 'drop all' event</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">self</span><span class="p">.</span><span class="nx">emit</span><span class="p">(</span><span class="s1">&#39;clear&#39;</span><span class="p">);</span></pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">&#182;</a> </div> <p>'close' current window and 'open' a new one</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">self</span><span class="p">.</span><span class="nx">fn</span><span class="p">.</span><span class="nx">init</span><span class="p">();</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="p">};</span>
<span class="nx">util</span><span class="p">.</span><span class="nx">inherits</span><span class="p">(</span><span class="nx">MonotonicWindow</span><span class="p">,</span> <span class="nx">events</span><span class="p">.</span><span class="nx">EventEmitter</span><span class="p">);</span></pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">&#182;</a> </div> <p>Exports</p> </td> <td class="code"> <div class="highlight"><pre><span class="nx">module</span><span class="p">.</span><span class="nx">exports</span><span class="p">.</span><span class="nx">MonotonicWindow</span> <span class="o">=</span> <span class="nx">MonotonicWindow</span><span class="p">;</span>
<span class="nx">util</span><span class="p">.</span><span class="nx">inherits</span><span class="p">(</span><span class="nx">MonotonicWindow</span><span class="p">,</span> <span class="nx">events</span><span class="p">.</span><span class="nx">EventEmitter</span><span class="p">);</span></pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">&#182;</a> </div> <p>Exports</p> </td> <td class="code"> <div class="highlight"><pre><span class="nx">module</span><span class="p">.</span><span class="nx">exports</span><span class="p">.</span><span class="nx">MonotonicWindow</span> <span class="o">=</span> <span class="nx">MonotonicWindow</span><span class="p">;</span>

</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>
8 changes: 7 additions & 1 deletion docs/eep.window_ordered.html
View file
Expand Up @@ -75,11 +75,17 @@
<span class="nx">win</span><span class="p">.</span><span class="nx">max</span> <span class="o">=</span> <span class="nx">self</span><span class="p">.</span><span class="nx">max</span><span class="p">;</span>
<span class="nx">win</span><span class="p">.</span><span class="nx">size</span> <span class="o">=</span> <span class="nx">self</span><span class="p">.</span><span class="nx">size</span><span class="p">;</span>

<span class="k">if</span> <span class="p">(</span><span class="nx">win</span><span class="p">.</span><span class="nx">tick</span><span class="p">)</span> <span class="nx">self</span><span class="p">.</span><span class="nx">tick</span> <span class="o">=</span> <span class="nx">win</span><span class="p">.</span><span class="nx">tick</span><span class="p">;</span>

<span class="nx">win</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">&#39;drop&#39;</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">x</span><span class="p">)</span> <span class="p">{</span> <span class="nx">remove</span><span class="p">(</span><span class="nx">s</span><span class="p">,</span> <span class="nx">x</span><span class="p">);</span> <span class="p">});</span>
<span class="nx">win</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">&#39;clear&#39;</span><span class="p">,</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nx">i</span> <span class="o">&lt;</span> <span class="nx">s</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span> </pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">&#182;</a> </div> <p>emit drop event for each collected event</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">self</span><span class="p">.</span><span class="nx">emit</span><span class="p">(</span><span class="s1">&#39;drop&#39;</span><span class="p">,</span> <span class="nx">s</span><span class="p">[</span><span class="nx">i</span><span class="p">]);</span>
<span class="p">}</span></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">&#182;</a> </div> <p>clear array 'cheaply'</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">s</span><span class="p">.</span><span class="nx">length</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
<span class="p">});</span>
<span class="nx">win</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">&#39;emit&#39;</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">x</span><span class="p">)</span> <span class="p">{</span> <span class="nx">self</span><span class="p">.</span><span class="nx">emit</span><span class="p">(</span><span class="s1">&#39;emit&#39;</span><span class="p">,</span><span class="nx">x</span><span class="p">);</span> <span class="p">});</span>
<span class="nx">self</span><span class="p">.</span><span class="nx">enqueue</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">x</span><span class="p">)</span> <span class="p">{</span> <span class="nx">insert</span><span class="p">(</span><span class="nx">s</span><span class="p">,</span> <span class="nx">x</span><span class="p">);</span> <span class="nx">win</span><span class="p">.</span><span class="nx">enqueue</span><span class="p">(</span><span class="nx">x</span><span class="p">);</span> <span class="p">};</span>
<span class="p">};</span>
<span class="nx">util</span><span class="p">.</span><span class="nx">inherits</span><span class="p">(</span><span class="nx">OrderedWindow</span><span class="p">,</span> <span class="nx">events</span><span class="p">.</span><span class="nx">EventEmitter</span><span class="p">);</span></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">&#182;</a> </div> <p>Exports</p> </td> <td class="code"> <div class="highlight"><pre><span class="nx">module</span><span class="p">.</span><span class="nx">exports</span><span class="p">.</span><span class="nx">OrderedWindow</span> <span class="o">=</span> <span class="nx">OrderedWindow</span><span class="p">;</span></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">&#182;</a> </div> <p>For testing</p> </td> <td class="code"> <div class="highlight"><pre><span class="nx">module</span><span class="p">.</span><span class="nx">exports</span><span class="p">.</span><span class="nx">OrderedWindow</span><span class="p">.</span><span class="nx">indexOf</span> <span class="o">=</span> <span class="nx">indexOf</span><span class="p">;</span>
<span class="nx">util</span><span class="p">.</span><span class="nx">inherits</span><span class="p">(</span><span class="nx">OrderedWindow</span><span class="p">,</span> <span class="nx">events</span><span class="p">.</span><span class="nx">EventEmitter</span><span class="p">);</span></pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">&#182;</a> </div> <p>Exports</p> </td> <td class="code"> <div class="highlight"><pre><span class="nx">module</span><span class="p">.</span><span class="nx">exports</span><span class="p">.</span><span class="nx">OrderedWindow</span> <span class="o">=</span> <span class="nx">OrderedWindow</span><span class="p">;</span></pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">&#182;</a> </div> <p>For testing</p> </td> <td class="code"> <div class="highlight"><pre><span class="nx">module</span><span class="p">.</span><span class="nx">exports</span><span class="p">.</span><span class="nx">OrderedWindow</span><span class="p">.</span><span class="nx">indexOf</span> <span class="o">=</span> <span class="nx">indexOf</span><span class="p">;</span>
<span class="nx">module</span><span class="p">.</span><span class="nx">exports</span><span class="p">.</span><span class="nx">OrderedWindow</span><span class="p">.</span><span class="nx">remove</span> <span class="o">=</span> <span class="nx">remove</span><span class="p">;</span>
<span class="nx">module</span><span class="p">.</span><span class="nx">exports</span><span class="p">.</span><span class="nx">OrderedWindow</span><span class="p">.</span><span class="nx">insert</span> <span class="o">=</span> <span class="nx">insert</span><span class="p">;</span>

Expand Down

0 comments on commit 1f5e157

Please sign in to comment.