Skip to content

Commit 769ce76

Browse files
committed
0.3.4
- updates duplex lib to fix cork, uncork and add some chaining - adds extensive docs to Git, Util and Service - adds named function to events to trace errors more easily
1 parent 07f0f48 commit 769ce76

File tree

5 files changed

+143
-73
lines changed

5 files changed

+143
-73
lines changed

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
# Unreleased
1+
# 0.3.4 (11/10/2017)
22

3+
- updates duplex lib to fix cork, uncork and add some chaining
34
- adds extensive docs to Git, Util and Service
45
- adds named function to events to trace errors more easily
56

docs/code/Git.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1882,7 +1882,7 @@ <h4 class="name" id="event:info">info</h4>
18821882

18831883
<dt class="tag-source">Source:</dt>
18841884
<dd class="tag-source"><ul class="dummy"><li>
1885-
<a href="git.js.html">git.js</a>, <a href="git.js.html#line65">line 65</a>
1885+
<a href="git.js.html">git.js</a>, <a href="git.js.html#line80">line 80</a>
18861886
</li></ul></dd>
18871887

18881888

@@ -2082,7 +2082,7 @@ <h4 class="name" id="event:info">info</h4>
20822082

20832083
<dt class="tag-source">Source:</dt>
20842084
<dd class="tag-source"><ul class="dummy"><li>
2085-
<a href="git.js.html">git.js</a>, <a href="git.js.html#line80">line 80</a>
2085+
<a href="git.js.html">git.js</a>, <a href="git.js.html#line65">line 65</a>
20862086
</li></ul></dd>
20872087

20882088

docs/code/HttpDuplex.html

Lines changed: 82 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1528,7 +1528,7 @@ <h4 class="name" id="addTrailers"><span class="type-signature"></span>addTrailer
15281528

15291529
<dt class="tag-source">Source:</dt>
15301530
<dd class="tag-source"><ul class="dummy"><li>
1531-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line323">line 323</a>
1531+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line378">line 378</a>
15321532
</li></ul></dd>
15331533

15341534

@@ -1663,7 +1663,7 @@ <h5>Parameters:</h5>
16631663

16641664

16651665

1666-
<h4 class="name" id="cork"><span class="type-signature"></span>cork<span class="signature">()</span><span class="type-signature"></span></h4>
1666+
<h4 class="name" id="cork"><span class="type-signature"></span>cork<span class="signature">()</span><span class="type-signature"> &rarr; {this}</span></h4>
16671667

16681668

16691669

@@ -1675,7 +1675,7 @@ <h4 class="name" id="cork"><span class="type-signature"></span>cork<span class="
16751675

16761676
<dt class="tag-source">Source:</dt>
16771677
<dd class="tag-source"><ul class="dummy"><li>
1678-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line337">line 337</a>
1678+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line257">line 257</a>
16791679
</li></ul></dd>
16801680

16811681

@@ -1757,6 +1757,24 @@ <h5>Example</h5>
17571757

17581758

17591759

1760+
<h5>Returns:</h5>
1761+
1762+
1763+
1764+
1765+
<dl class="param-type">
1766+
<dt>
1767+
Type
1768+
</dt>
1769+
<dd>
1770+
1771+
<span class="param-type">this</span>
1772+
1773+
1774+
</dd>
1775+
</dl>
1776+
1777+
17601778

17611779

17621780

@@ -1776,7 +1794,7 @@ <h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span c
17761794

17771795
<dt class="tag-source">Source:</dt>
17781796
<dd class="tag-source"><ul class="dummy"><li>
1779-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line253">line 253</a>
1797+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line308">line 308</a>
17801798
</li></ul></dd>
17811799

17821800

@@ -1860,7 +1878,7 @@ <h4 class="name" id="end"><span class="type-signature"></span>end<span class="si
18601878

18611879
<dt class="tag-source">Source:</dt>
18621880
<dd class="tag-source"><ul class="dummy"><li>
1863-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line351">line 351</a>
1881+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line392">line 392</a>
18641882
</li></ul></dd>
18651883

18661884

@@ -2052,7 +2070,7 @@ <h4 class="name" id="getHeader"><span class="type-signature"></span>getHeader<sp
20522070

20532071
<dt class="tag-source">Source:</dt>
20542072
<dd class="tag-source"><ul class="dummy"><li>
2055-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line365">line 365</a>
2073+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line406">line 406</a>
20562074
</li></ul></dd>
20572075

20582076

@@ -2215,7 +2233,7 @@ <h4 class="name" id="pause"><span class="type-signature"></span>pause<span class
22152233

22162234
<dt class="tag-source">Source:</dt>
22172235
<dd class="tag-source"><ul class="dummy"><li>
2218-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line377">line 377</a>
2236+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line418">line 418</a>
22192237
</li></ul></dd>
22202238

22212239

@@ -2307,7 +2325,7 @@ <h4 class="name" id="removeHeader"><span class="type-signature"></span>removeHea
23072325

23082326
<dt class="tag-source">Source:</dt>
23092327
<dd class="tag-source"><ul class="dummy"><li>
2310-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line386">line 386</a>
2328+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line427">line 427</a>
23112329
</li></ul></dd>
23122330

23132331

@@ -2452,7 +2470,7 @@ <h4 class="name" id="resume"><span class="type-signature"></span>resume<span cla
24522470

24532471
<dt class="tag-source">Source:</dt>
24542472
<dd class="tag-source"><ul class="dummy"><li>
2455-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line397">line 397</a>
2473+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line438">line 438</a>
24562474
</li></ul></dd>
24572475

24582476

@@ -2544,7 +2562,7 @@ <h4 class="name" id="setDefaultEncoding"><span class="type-signature"></span>set
25442562

25452563
<dt class="tag-source">Source:</dt>
25462564
<dd class="tag-source"><ul class="dummy"><li>
2547-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line406">line 406</a>
2565+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line447">line 447</a>
25482566
</li></ul></dd>
25492567

25502568

@@ -2689,7 +2707,7 @@ <h4 class="name" id="setEncoding"><span class="type-signature"></span>setEncodin
26892707

26902708
<dt class="tag-source">Source:</dt>
26912709
<dd class="tag-source"><ul class="dummy"><li>
2692-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line416">line 416</a>
2710+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line457">line 457</a>
26932711
</li></ul></dd>
26942712

26952713

@@ -2834,7 +2852,7 @@ <h4 class="name" id="setHeader"><span class="type-signature"></span>setHeader<sp
28342852

28352853
<dt class="tag-source">Source:</dt>
28362854
<dd class="tag-source"><ul class="dummy"><li>
2837-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line426">line 426</a>
2855+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line467">line 467</a>
28382856
</li></ul></dd>
28392857

28402858

@@ -3002,7 +3020,7 @@ <h5>Parameters:</h5>
30023020

30033021

30043022

3005-
<h4 class="name" id="uncork"><span class="type-signature"></span>uncork<span class="signature">()</span><span class="type-signature"></span></h4>
3023+
<h4 class="name" id="uncork"><span class="type-signature"></span>uncork<span class="signature">()</span><span class="type-signature"> &rarr; {this}</span></h4>
30063024

30073025

30083026

@@ -3014,7 +3032,7 @@ <h4 class="name" id="uncork"><span class="type-signature"></span>uncork<span cla
30143032

30153033
<dt class="tag-source">Source:</dt>
30163034
<dd class="tag-source"><ul class="dummy"><li>
3017-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line442">line 442</a>
3035+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line276">line 276</a>
30183036
</li></ul></dd>
30193037

30203038

@@ -3088,6 +3106,24 @@ <h4 class="name" id="uncork"><span class="type-signature"></span>uncork<span cla
30883106

30893107

30903108

3109+
<h5>Returns:</h5>
3110+
3111+
3112+
3113+
3114+
<dl class="param-type">
3115+
<dt>
3116+
Type
3117+
</dt>
3118+
<dd>
3119+
3120+
<span class="param-type">this</span>
3121+
3122+
3123+
</dd>
3124+
</dl>
3125+
3126+
30913127

30923128

30933129

@@ -3107,7 +3143,7 @@ <h4 class="name" id="write"><span class="type-signature"></span>write<span class
31073143

31083144
<dt class="tag-source">Source:</dt>
31093145
<dd class="tag-source"><ul class="dummy"><li>
3110-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line451">line 451</a>
3146+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line483">line 483</a>
31113147
</li></ul></dd>
31123148

31133149

@@ -3371,7 +3407,7 @@ <h4 class="name" id="writeContinue"><span class="type-signature"></span>writeCon
33713407

33723408
<dt class="tag-source">Source:</dt>
33733409
<dd class="tag-source"><ul class="dummy"><li>
3374-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line470">line 470</a>
3410+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line502">line 502</a>
33753411
</li></ul></dd>
33763412

33773413

@@ -3451,7 +3487,7 @@ <h4 class="name" id="writeContinue"><span class="type-signature"></span>writeCon
34513487

34523488

34533489

3454-
<h4 class="name" id="writeHead"><span class="type-signature"></span>writeHead<span class="signature">(statusCode, statusMessage<span class="signature-attributes">opt</span>, headers<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
3490+
<h4 class="name" id="writeHead"><span class="type-signature"></span>writeHead<span class="signature">(statusCode, statusMessage<span class="signature-attributes">opt</span>, headers<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {this}</span></h4>
34553491

34563492

34573493

@@ -3463,7 +3499,7 @@ <h4 class="name" id="writeHead"><span class="type-signature"></span>writeHead<sp
34633499

34643500
<dt class="tag-source">Source:</dt>
34653501
<dd class="tag-source"><ul class="dummy"><li>
3466-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line479">line 479</a>
3502+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line235">line 235</a>
34673503
</li></ul></dd>
34683504

34693505

@@ -3526,7 +3562,7 @@ <h5>Example</h5>
35263562
<pre class="prettyprint"><code>var content = 'Under Construction...';
35273563
response.writeHead(200, {
35283564
'Content-Length': Buffer.byteLength(content),
3529-
'Content-Type': 'text/plain'
3565+
'Content-Type': 'text/plain'
35303566
});
35313567
response.end(content);</code></pre>
35323568

@@ -3566,7 +3602,7 @@ <h5>Parameters:</h5>
35663602
<td class="type">
35673603

35683604

3569-
<span class="param-type">Number</span>
3605+
<span class="param-type">number</span>
35703606

35713607

35723608

@@ -3597,7 +3633,7 @@ <h5>Parameters:</h5>
35973633
<td class="type">
35983634

35993635

3600-
<span class="param-type">String</span>
3636+
<span class="param-type">string</span>
36013637

36023638

36033639

@@ -3630,7 +3666,7 @@ <h5>Parameters:</h5>
36303666
<td class="type">
36313667

36323668

3633-
<span class="param-type">Object</span>
3669+
<span class="param-type">object</span>
36343670

36353671

36363672

@@ -3670,6 +3706,24 @@ <h5>Parameters:</h5>
36703706

36713707

36723708

3709+
<h5>Returns:</h5>
3710+
3711+
3712+
3713+
3714+
<dl class="param-type">
3715+
<dt>
3716+
Type
3717+
</dt>
3718+
<dd>
3719+
3720+
<span class="param-type">this</span>
3721+
3722+
3723+
</dd>
3724+
</dl>
3725+
3726+
36733727

36743728

36753729

@@ -3689,7 +3743,7 @@ <h4 class="name" id="writeHeader"><span class="type-signature"></span>writeHeade
36893743

36903744
<dt class="tag-source">Source:</dt>
36913745
<dd class="tag-source"><ul class="dummy"><li>
3692-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line496">line 496</a>
3746+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line511">line 511</a>
36933747
</li></ul></dd>
36943748

36953749

@@ -3791,7 +3845,7 @@ <h4 class="name" id="event:close">close</h4>
37913845

37923846
<dt class="tag-source">Source:</dt>
37933847
<dd class="tag-source"><ul class="dummy"><li>
3794-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line266">line 266</a>
3848+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line321">line 321</a>
37953849
</li></ul></dd>
37963850

37973851

@@ -3884,7 +3938,7 @@ <h4 class="name" id="event:data">data</h4>
38843938

38853939
<dt class="tag-source">Source:</dt>
38863940
<dd class="tag-source"><ul class="dummy"><li>
3887-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line275">line 275</a>
3941+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line330">line 330</a>
38883942
</li></ul></dd>
38893943

38903944

@@ -4035,7 +4089,7 @@ <h4 class="name" id="event:drain">drain</h4>
40354089

40364090
<dt class="tag-source">Source:</dt>
40374091
<dd class="tag-source"><ul class="dummy"><li>
4038-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line289">line 289</a>
4092+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line344">line 344</a>
40394093
</li></ul></dd>
40404094

40414095

@@ -4127,7 +4181,7 @@ <h4 class="name" id="event:end">end</h4>
41274181

41284182
<dt class="tag-source">Source:</dt>
41294183
<dd class="tag-source"><ul class="dummy"><li>
4130-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line298">line 298</a>
4184+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line353">line 353</a>
41314185
</li></ul></dd>
41324186

41334187

@@ -4219,7 +4273,7 @@ <h4 class="name" id="event:error">error</h4>
42194273

42204274
<dt class="tag-source">Source:</dt>
42214275
<dd class="tag-source"><ul class="dummy"><li>
4222-
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line307">line 307</a>
4276+
<a href="http-duplex.js.html">http-duplex.js</a>, <a href="http-duplex.js.html#line362">line 362</a>
42234277
</li></ul></dd>
42244278

42254279

0 commit comments

Comments
 (0)