Skip to content

Commit

Permalink
v1.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@dzungvpham
dzungvpham committed Mar 6, 2019
1 parent a3245c7 commit cda7611
Show file tree
Hide file tree
Showing 11 changed files with 70 additions and 72 deletions.
38 changes: 19 additions & 19 deletions docs/classes/_lib_charstream_.charutil.charstream.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,13 +123,13 @@ <h2>Constructors</h2>
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Char<wbr>Stream<span class="tsd-signature-symbol">(</span>s<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">String</span>, furthestFailure<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, startpos<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, endpos<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, hasEOF<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_lib_charstream_.charutil.charstream.html" class="tsd-signature-type">CharStream</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Char<wbr>Stream<span class="tsd-signature-symbol">(</span>s<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">String</span>, furthestFailure<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, startpos<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, endpos<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, hasEOF<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_lib_charstream_.charutil.charstream.html" class="tsd-signature-type">CharStream</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L7">lib/charstream.ts:7</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L7">lib/charstream.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -147,7 +147,7 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> startpos: <span class
<h5><span class="tsd-flag ts-flagOptional">Optional</span> endpos: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> hasEOF: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></h5>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> hasEOF: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_lib_charstream_.charutil.charstream.html" class="tsd-signature-type">CharStream</a></h4>
Expand All @@ -163,7 +163,7 @@ <h3>endpos</h3>
<div class="tsd-signature tsd-kind-icon">endpos<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L5">lib/charstream.ts:5</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L5">lib/charstream.ts:5</a></li>
</ul>
</aside>
</section>
Expand All @@ -173,7 +173,7 @@ <h3>furthest<wbr>Failure</h3>
<div class="tsd-signature tsd-kind-icon">furthest<wbr>Failure<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L7">lib/charstream.ts:7</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L7">lib/charstream.ts:7</a></li>
</ul>
</aside>
</section>
Expand All @@ -183,7 +183,7 @@ <h3>hasEOF</h3>
<div class="tsd-signature tsd-kind-icon">hasEOF<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L6">lib/charstream.ts:6</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L6">lib/charstream.ts:6</a></li>
</ul>
</aside>
</section>
Expand All @@ -193,7 +193,7 @@ <h3>input</h3>
<div class="tsd-signature tsd-kind-icon">input<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">String</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L3">lib/charstream.ts:3</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L3">lib/charstream.ts:3</a></li>
</ul>
</aside>
</section>
Expand All @@ -203,7 +203,7 @@ <h3>startpos</h3>
<div class="tsd-signature tsd-kind-icon">startpos<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L4">lib/charstream.ts:4</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L4">lib/charstream.ts:4</a></li>
</ul>
</aside>
</section>
Expand All @@ -220,7 +220,7 @@ <h3>concat</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L153">lib/charstream.ts:153</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L153">lib/charstream.ts:153</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -255,7 +255,7 @@ <h3>head</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L92">lib/charstream.ts:92</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L92">lib/charstream.ts:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -279,7 +279,7 @@ <h3>isEOF</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L46">lib/charstream.ts:46</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L46">lib/charstream.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -301,7 +301,7 @@ <h3>is<wbr>Empty</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L120">lib/charstream.ts:120</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L120">lib/charstream.ts:120</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -326,7 +326,7 @@ <h3>length</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L128">lib/charstream.ts:128</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L128">lib/charstream.ts:128</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -349,7 +349,7 @@ <h3>peek</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L65">lib/charstream.ts:65</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L65">lib/charstream.ts:65</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -382,7 +382,7 @@ <h3>seek</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L79">lib/charstream.ts:79</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L79">lib/charstream.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -413,7 +413,7 @@ <h3>substring</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L138">lib/charstream.ts:138</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L138">lib/charstream.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -451,7 +451,7 @@ <h3>tail</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L106">lib/charstream.ts:106</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L106">lib/charstream.ts:106</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -475,7 +475,7 @@ <h3>to<wbr>String</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L54">lib/charstream.ts:54</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L54">lib/charstream.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -498,7 +498,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> concat</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/charstream.ts#L163">lib/charstream.ts:163</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/charstream.ts#L163">lib/charstream.ts:163</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
6 changes: 3 additions & 3 deletions docs/classes/_lib_primitives_.primitives.eofmark.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/primitives.ts#L5">lib/primitives.ts:5</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/primitives.ts#L5">lib/primitives.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="_lib_primitives_.primitives.eofmark.html" class="tsd-signature-type">EOFMark</a></h4>
Expand All @@ -131,7 +131,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-
<div class="tsd-signature tsd-kind-icon">_instance<span class="tsd-signature-symbol">:</span> <a href="_lib_primitives_.primitives.eofmark.html" class="tsd-signature-type">EOFMark</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/primitives.ts#L5">lib/primitives.ts:5</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/primitives.ts#L5">lib/primitives.ts:5</a></li>
</ul>
</aside>
</section>
Expand All @@ -148,7 +148,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> Instance</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/primitives.ts#L7">lib/primitives.ts:7</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/primitives.ts#L7">lib/primitives.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="_lib_primitives_.primitives.eofmark.html" class="tsd-signature-type">EOFMark</a></h4>
Expand Down
6 changes: 3 additions & 3 deletions docs/classes/_lib_primitives_.primitives.failure.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/primitives.ts#L37">lib/primitives.ts:37</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/primitives.ts#L37">lib/primitives.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -149,7 +149,7 @@ <h3>inputstream</h3>
<div class="tsd-signature tsd-kind-icon">inputstream<span class="tsd-signature-symbol">:</span> <a href="_lib_charstream_.charutil.charstream.html" class="tsd-signature-type">CharStream</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/primitives.ts#L37">lib/primitives.ts:37</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/primitives.ts#L37">lib/primitives.ts:37</a></li>
</ul>
</aside>
</section>
Expand All @@ -159,7 +159,7 @@ <h3>tag</h3>
<div class="tsd-signature tsd-kind-icon">tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"failure"</span><span class="tsd-signature-symbol"> =&nbsp;&quot;failure&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/primitives.ts#L36">lib/primitives.ts:36</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/primitives.ts#L36">lib/primitives.ts:36</a></li>
</ul>
</aside>
</section>
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/_lib_primitives_.primitives.success.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/primitives.ts#L20">lib/primitives.ts:20</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/primitives.ts#L20">lib/primitives.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -166,7 +166,7 @@ <h3>inputstream</h3>
<div class="tsd-signature tsd-kind-icon">inputstream<span class="tsd-signature-symbol">:</span> <a href="_lib_charstream_.charutil.charstream.html" class="tsd-signature-type">CharStream</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/primitives.ts#L20">lib/primitives.ts:20</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/primitives.ts#L20">lib/primitives.ts:20</a></li>
</ul>
</aside>
</section>
Expand All @@ -176,7 +176,7 @@ <h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/primitives.ts#L19">lib/primitives.ts:19</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/primitives.ts#L19">lib/primitives.ts:19</a></li>
</ul>
</aside>
</section>
Expand All @@ -186,7 +186,7 @@ <h3>tag</h3>
<div class="tsd-signature tsd-kind-icon">tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"success"</span><span class="tsd-signature-symbol"> =&nbsp;&quot;success&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/primitives.ts#L18">lib/primitives.ts:18</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/primitives.ts#L18">lib/primitives.ts:18</a></li>
</ul>
</aside>
</section>
Expand Down
6 changes: 2 additions & 4 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,10 @@ <h2 id="documentation">documentation</h2>
<p><a href="https://williams-cs.github.io/pants/">Typedoc documentation can be found here</a></p>
<h2 id="installing-development-dependencies">installing development dependencies</h2>
<p>To install package dependencies for <code>pants</code> you will need to run:</p>
<pre><code><span class="hljs-meta">$</span><span class="bash"> npm install</span>
</code></pre><p>in the pants repository directory.</p>
<pre><code>$ npm <span class="hljs-keyword">install</span></code></pre><p>in the pants repository directory.</p>
<h2 id="running-tests">running tests</h2>
<p>Run:</p>
<pre><code>$ npm <span class="hljs-keyword">run</span><span class="bash"> <span class="hljs-built_in">test</span></span>
</code></pre>
<pre><code>$ npm <span class="hljs-keyword">run</span><span class="bash"> <span class="hljs-built_in">test</span></span></code></pre>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/_lib_primitives_.primitives.iparser.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ <h3 class="tsd-before-signature">Callable</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a768e53/lib/primitives.ts#L55">lib/primitives.ts:55</a></li>
<li>Defined in <a href="https://github.com/williams-cs/pants/blob/a3245c7/lib/primitives.ts#L55">lib/primitives.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit cda7611

Please sign in to comment.