Skip to content

Commit

Permalink
v3.0.3
Browse files Browse the repository at this point in the history
  • Loading branch information
@inikulin
inikulin committed Nov 5, 2017
1 parent 8d38fda commit 723d782
Show file tree
Hide file tree
Showing 36 changed files with 3,424 additions and 1,039 deletions.
7 changes: 5 additions & 2 deletions DOC_INDEX.md
View file
Expand Up @@ -132,12 +132,15 @@ will be parsed as
Just try it in the latest version of your browser before submitting an issue.

## Version history
### 3.0.3
* Fixed: Loosen the dependency version of `@types/node` (by [@gfx](https://github.com/gfx)).
* Fixed: Incorrect AST generated if empty string fed to `ParserStream` (GH [#195](https://github.com/inikulin/parse5/issues/195)) (by [@stevenvachon](https://github.com/stevenvachon)).

### 3.0.2
* Fixed: `location.startTag` is not available if end tag is missing (GH [#181](https://github.com/inikulin/parse5/issues/181));
* Fixed: `location.startTag` is not available if end tag is missing (GH [#181](https://github.com/inikulin/parse5/issues/181)).

### 3.0.1
* Fixed: `MarkupData.Location.col` description in TypeScript definition file (GH [#170](https://github.com/inikulin/parse5/issues/170));
* Fixed: `MarkupData.Location.col` description in TypeScript definition file (GH [#170](https://github.com/inikulin/parse5/issues/170)).

### 3.0.0
* Added: parse5 now ships with TypeScript definitions from which [new documentation website](http://inikulin.github.io/parse5/) is generated (GH [#125](https://github.com/inikulin/parse5/issues/125)).
Expand Down
3 changes: 2 additions & 1 deletion Gulpfile.js
View file
Expand Up @@ -22,7 +22,8 @@ gulp.task('docs', function () {
.pipe(typedoc({
includeDeclarations: true,
excludeExternals: true,
ignoreCompilerErrors: false,
ignoreCompilerErrors: true,
excludePrivate: true,
mode: 'file',
readme: './DOC_INDEX.md',
out: './docs'
Expand Down
10 changes: 5 additions & 5 deletions docs/assets/js/main.js
View file

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

634 changes: 514 additions & 120 deletions docs/classes/parserstream.html
View file

Large diffs are not rendered by default.

632 changes: 513 additions & 119 deletions docs/classes/plaintextconversionstream.html
View file

Large diffs are not rendered by default.

2,267 changes: 1,816 additions & 451 deletions docs/classes/saxparser.html
View file

Large diffs are not rendered by default.

487 changes: 354 additions & 133 deletions docs/classes/serializerstream.html
View file

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/globals.html
View file
Expand Up @@ -107,7 +107,7 @@ <h3>tree<wbr>Adapters</h3>
<div class="tsd-signature tsd-kind-icon">tree<wbr>Adapters<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L749">index.d.ts:749</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L749">index.d.ts:749</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -168,7 +168,7 @@ <h3>parse</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L781">index.d.ts:781</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L781">index.d.ts:781</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -217,7 +217,7 @@ <h3>parse<wbr>Fragment</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L805">index.d.ts:805</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L805">index.d.ts:805</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -267,7 +267,7 @@ <h4 class="tsd-returns-title">Returns <a href="modules/ast.html#documentfragment
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L806">index.d.ts:806</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L806">index.d.ts:806</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -293,7 +293,7 @@ <h3>serialize</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L830">index.d.ts:830</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L830">index.d.ts:830</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
17 changes: 11 additions & 6 deletions docs/index.html
View file
Expand Up @@ -82,7 +82,7 @@ <h2 id="table-of-contents">Table of contents</h2>
<li><a href="https://github.com/inikulin/parse5">GitHub repository</a></li>
</ul>
<h2 id="install">Install</h2>
<pre><code>$ npm <span class="hljs-keyword">install</span> parse5
<pre><code><span class="hljs-meta">$</span><span class="bash"> npm install parse5</span>
</code></pre><h2 id="which-api-should-i-use-">Which API should I use?</h2>
<h3 id="-i-need-to-parse-a-html-string-"><em>&quot;I need to parse a HTML string&quot;</em></h3>
<p>Use <a href="globals.html#parse">parse5.parse</a> method.</p>
Expand All @@ -109,15 +109,15 @@ <h2 id="typescript-definitions">TypeScript definitions</h2>
<p>parse5 package includes a TypeScript definition file. Therefore you don&#39;t need to install any typings to use parse5
in TypeScript files. Note that since parse5 supports multiple output tree formats you need to manually cast generic node interfaces to the
appropriate tree format to get access to the properties:</p>
<pre><code class="lang-typescript"><span class="hljs-keyword">import</span> * as parse5 from <span class="hljs-string">'parse5'</span>;
<pre><code class="lang-typescript"><span class="hljs-keyword">import</span> * <span class="hljs-keyword">as</span> parse5 <span class="hljs-keyword">from</span> <span class="hljs-string">'parse5'</span>;

<span class="hljs-comment">// Using default tree adapter.</span>
<span class="hljs-keyword">var</span> document1 = parse5.parse(<span class="hljs-string">'&lt;div&gt;&lt;/div&gt;'</span>) as parse5.AST.Default.Document;
<span class="hljs-keyword">var</span> document1 = parse5.parse(<span class="hljs-string">'&lt;div&gt;&lt;/div&gt;'</span>) <span class="hljs-keyword">as</span> parse5.AST.Default.Document;

<span class="hljs-comment">// Using htmlparser2 tree adapter.</span>
<span class="hljs-keyword">var</span> document2 = parse5.parse(<span class="hljs-string">'&lt;div&gt;&lt;/div&gt;'</span>, {
treeAdapter: parse5.TreeAdapters.htmlparser2
}) as parse5.AST.HtmlParser2.Document;
}) <span class="hljs-keyword">as</span> parse5.AST.HtmlParser2.Document;
</code></pre>
<p>You can find documentation for interfaces in <a href="globals.html">API reference</a>.</p>
<h2 id="faq">FAQ</h2>
Expand Down Expand Up @@ -156,13 +156,18 @@ <h3 id="q-i-have-some-weird-output-from-the-parser-seems-like-a-bug-">Q: I have
</code></pre>
<p>Just try it in the latest version of your browser before submitting an issue.</p>
<h2 id="version-history">Version history</h2>
<h3 id="3-0-3">3.0.3</h3>
<ul>
<li>Fixed: Loosen the dependency version of <code>@types/node</code> (by <a href="https://github.com/gfx">@gfx</a>).</li>
<li>Fixed: Incorrect AST generated if empty string fed to <code>ParserStream</code> (GH <a href="https://github.com/inikulin/parse5/issues/195">#195</a>) (by <a href="https://github.com/stevenvachon">@stevenvachon</a>).</li>
</ul>
<h3 id="3-0-2">3.0.2</h3>
<ul>
<li>Fixed: <code>location.startTag</code> is not available if end tag is missing (GH <a href="https://github.com/inikulin/parse5/issues/181">#181</a>);</li>
<li>Fixed: <code>location.startTag</code> is not available if end tag is missing (GH <a href="https://github.com/inikulin/parse5/issues/181">#181</a>).</li>
</ul>
<h3 id="3-0-1">3.0.1</h3>
<ul>
<li>Fixed: <code>MarkupData.Location.col</code> description in TypeScript definition file (GH <a href="https://github.com/inikulin/parse5/issues/170">#170</a>);</li>
<li>Fixed: <code>MarkupData.Location.col</code> description in TypeScript definition file (GH <a href="https://github.com/inikulin/parse5/issues/170">#170</a>).</li>
</ul>
<h3 id="3-0-0">3.0.0</h3>
<ul>
Expand Down
8 changes: 4 additions & 4 deletions docs/interfaces/ast.default.attribute.html
View file
Expand Up @@ -109,7 +109,7 @@ <h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<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/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L109">index.d.ts:109</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L109">index.d.ts:109</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -124,7 +124,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> namespace</h3>
<div class="tsd-signature tsd-kind-icon">namespace<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/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L117">index.d.ts:117</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L117">index.d.ts:117</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -139,7 +139,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> prefix</h3>
<div class="tsd-signature tsd-kind-icon">prefix<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/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L121">index.d.ts:121</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L121">index.d.ts:121</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -154,7 +154,7 @@ <h3>value</h3>
<div class="tsd-signature tsd-kind-icon">value<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/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L113">index.d.ts:113</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L113">index.d.ts:113</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
8 changes: 4 additions & 4 deletions docs/interfaces/ast.default.commentnode.html
View file
Expand Up @@ -114,7 +114,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ___location</h3>
<div class="tsd-signature tsd-kind-icon">___location<span class="tsd-signature-symbol">:</span> <a href="markupdata.location.html" class="tsd-signature-type">Location</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L239">index.d.ts:239</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L239">index.d.ts:239</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -129,7 +129,7 @@ <h3>data</h3>
<div class="tsd-signature tsd-kind-icon">data<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/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L231">index.d.ts:231</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L231">index.d.ts:231</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -145,7 +145,7 @@ <h3>node<wbr>Name</h3>
<aside class="tsd-sources">
<p>Overrides <a href="ast.default.node.html">Node</a>.<a href="ast.default.node.html#nodename">nodeName</a></p>
<ul>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L227">index.d.ts:227</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L227">index.d.ts:227</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -160,7 +160,7 @@ <h3>parent<wbr>Node</h3>
<div class="tsd-signature tsd-kind-icon">parent<wbr>Node<span class="tsd-signature-symbol">:</span> <a href="ast.default.parentnode.html" class="tsd-signature-type">ParentNode</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L235">index.d.ts:235</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L235">index.d.ts:235</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/ast.default.document.html
View file
Expand Up @@ -114,7 +114,7 @@ <h3>child<wbr>Nodes</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="ast.default.parentnode.html">ParentNode</a>.<a href="ast.default.parentnode.html#childnodes">childNodes</a></p>
<ul>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L141">index.d.ts:141</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L141">index.d.ts:141</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -129,7 +129,7 @@ <h3>mode</h3>
<div class="tsd-signature tsd-kind-icon">mode<span class="tsd-signature-symbol">:</span> <a href="../modules/ast.html#documentmode" class="tsd-signature-type">DocumentMode</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L177">index.d.ts:177</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L177">index.d.ts:177</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -144,7 +144,7 @@ <h3>node<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">node<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"#document"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L173">index.d.ts:173</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L173">index.d.ts:173</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/ast.default.documentfragment.html
View file
Expand Up @@ -113,7 +113,7 @@ <h3>child<wbr>Nodes</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="ast.default.parentnode.html">ParentNode</a>.<a href="ast.default.parentnode.html#childnodes">childNodes</a></p>
<ul>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L141">index.d.ts:141</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L141">index.d.ts:141</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -128,7 +128,7 @@ <h3>node<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">node<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"#document-fragment"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L187">index.d.ts:187</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L187">index.d.ts:187</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
8 changes: 4 additions & 4 deletions docs/interfaces/ast.default.documenttype.html
View file
Expand Up @@ -114,7 +114,7 @@ <h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<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/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L155">index.d.ts:155</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L155">index.d.ts:155</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -130,7 +130,7 @@ <h3>node<wbr>Name</h3>
<aside class="tsd-sources">
<p>Overrides <a href="ast.default.node.html">Node</a>.<a href="ast.default.node.html#nodename">nodeName</a></p>
<ul>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L151">index.d.ts:151</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L151">index.d.ts:151</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -145,7 +145,7 @@ <h3>public<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">public<wbr>Id<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/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L159">index.d.ts:159</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L159">index.d.ts:159</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -160,7 +160,7 @@ <h3>system<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">system<wbr>Id<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/inikulin/parse5/blob/f605e9b/lib/index.d.ts#L163">index.d.ts:163</a></li>
<li>Defined in <a href="https://github.com/inikulin/parse5/blob/8d38fda/lib/index.d.ts#L163">index.d.ts:163</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down

0 comments on commit 723d782

Please sign in to comment.