Skip to content

Commit

Permalink
Regenerate api docs (parcel-bundler#1011)
Browse files Browse the repository at this point in the history
  • Loading branch information
mischnic authored Mar 11, 2022
1 parent fde40a0 commit 738131f
Show file tree
Hide file tree
Showing 14 changed files with 152 additions and 151 deletions.
31 changes: 16 additions & 15 deletions api/bundler.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
<div class="type">
<h4 class="title">
<span id="TraversalActions">TraversalActions</span>
<a href="https://github.com/parcel-bundler/parcel/blob/5afe766e637827ede728ec7a9fefcfea691dfa35/packages/core/types/index.js#L1052"><i>parcel/packages/core/types/index.js:1052</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1057"><i>parcel/packages/core/types/index.js:1057</i></a>
</h4>
<p>Used to control a traversal</p>

Expand All @@ -58,7 +58,7 @@ <h5>Referenced by:</h5>
</div><div class="type">
<h4 class="title">
<span id="GraphVisitor">GraphVisitor</span>
<a href="https://github.com/parcel-bundler/parcel/blob/5afe766e637827ede728ec7a9fefcfea691dfa35/packages/core/types/index.js#L1063"><i>parcel/packages/core/types/index.js:1063</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1068"><i>parcel/packages/core/types/index.js:1068</i></a>
</h4>
<p>Essentially <a href="/plugin-system/bundler/#GraphTraversalCallback">GraphTraversalCallback</a>, but allows adding specific node enter and exit callbacks.</p>

Expand All @@ -76,7 +76,7 @@ <h5>Referenced by:</h5>
</div><div class="type">
<h4 class="title">
<span id="GraphTraversalCallback">GraphTraversalCallback</span>
<a href="https://github.com/parcel-bundler/parcel/blob/5afe766e637827ede728ec7a9fefcfea691dfa35/packages/core/types/index.js#L1076"><i>parcel/packages/core/types/index.js:1076</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1081"><i>parcel/packages/core/types/index.js:1081</i></a>
</h4>
<p>A generic callback for graph traversals</p>

Expand All @@ -91,7 +91,7 @@ <h5>Referenced by:</h5>
</div><div class="type">
<h4 class="title">
<span id="BundleTraversable">BundleTraversable</span>
<a href="https://github.com/parcel-bundler/parcel/blob/5afe766e637827ede728ec7a9fefcfea691dfa35/packages/core/types/index.js#L1085"><i>parcel/packages/core/types/index.js:1085</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1090"><i>parcel/packages/core/types/index.js:1090</i></a>
</h4>


Expand All @@ -111,7 +111,7 @@ <h5>Referenced by:</h5>
</div><div class="type">
<h4 class="title">
<span id="BundleGraphTraversable">BundleGraphTraversable</span>
<a href="https://github.com/parcel-bundler/parcel/blob/5afe766e637827ede728ec7a9fefcfea691dfa35/packages/core/types/index.js#L1092"><i>parcel/packages/core/types/index.js:1092</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1097"><i>parcel/packages/core/types/index.js:1097</i></a>
</h4>


Expand All @@ -131,7 +131,7 @@ <h5>Referenced by:</h5>
</div><div class="type">
<h4 class="title">
<span id="CreateBundleOpts">CreateBundleOpts</span>
<a href="https://github.com/parcel-bundler/parcel/blob/5afe766e637827ede728ec7a9fefcfea691dfa35/packages/core/types/index.js#L1108"><i>parcel/packages/core/types/index.js:1108</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1113"><i>parcel/packages/core/types/index.js:1113</i></a>
</h4>
<p>Options for <a href="/plugin-system/bundler/#MutableBundleGraph">MutableBundleGraph</a>&#39;s <code>createBundle</code>.
<br>If an <code>entryAsset</code> is provided, <code>uniqueKey</code> (for the bundle id),
Expand Down Expand Up @@ -165,7 +165,7 @@ <h5>Referenced by:</h5>
</div><div class="type">
<h4 class="title">
<span id="Bundle">Bundle</span>
<a href="https://github.com/parcel-bundler/parcel/blob/5afe766e637827ede728ec7a9fefcfea691dfa35/packages/core/types/index.js#L1192"><i>parcel/packages/core/types/index.js:1192</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1197"><i>parcel/packages/core/types/index.js:1197</i></a>
</h4>
<p>A <a href="/plugin-system/bundler/#Bundle">Bundle</a> (a collection of assets)
<br></p>
Expand Down Expand Up @@ -216,7 +216,7 @@ <h5>Referenced by:</h5>
</div><div class="type">
<h4 class="title">
<span id="NamedBundle">NamedBundle</span>
<a href="https://github.com/parcel-bundler/parcel/blob/5afe766e637827ede728ec7a9fefcfea691dfa35/packages/core/types/index.js#L1252"><i>parcel/packages/core/types/index.js:1252</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1257"><i>parcel/packages/core/types/index.js:1257</i></a>
</h4>
<p>A <a href="/plugin-system/bundler/#Bundle">Bundle</a> that got named by a <a href="/plugin-system/namer/#Namer">Namer</a></p>

Expand All @@ -235,7 +235,7 @@ <h5>Referenced by:</h5>
</div><div class="type">
<h4 class="title">
<span id="BundleGroup">BundleGroup</span>
<a href="https://github.com/parcel-bundler/parcel/blob/5afe766e637827ede728ec7a9fefcfea691dfa35/packages/core/types/index.js#L1275"><i>parcel/packages/core/types/index.js:1275</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1280"><i>parcel/packages/core/types/index.js:1280</i></a>
</h4>
<p>A collection of sibling bundles (which are stored in the <a href="/plugin-system/bundler/#BundleGraph">BundleGraph</a>) that should be loaded together (in order).</p>

Expand All @@ -251,14 +251,15 @@ <h5>Referenced by:</h5>
</div><div class="type">
<h4 class="title">
<span id="MutableBundleGraph">MutableBundleGraph</span>
<a href="https://github.com/parcel-bundler/parcel/blob/5afe766e637827ede728ec7a9fefcfea691dfa35/packages/core/types/index.js#L1287"><i>parcel/packages/core/types/index.js:1287</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1292"><i>parcel/packages/core/types/index.js:1292</i></a>
</h4>
<p>A <a href="/plugin-system/bundler/#BundleGraph">BundleGraph</a> in the <a href="/plugin-system/bundler/#Bundler">Bundler</a> that can be modified</p>

<figure class="well warning"><div>Marked as experimental</div></figure><pre class="interface"><code>interface <a href="/plugin-system/bundler/#MutableBundleGraph">MutableBundleGraph</a> extends <a href="/plugin-system/bundler/#BundleGraph">BundleGraph</a>&lt;<a href="/plugin-system/bundler/#Bundle">Bundle</a>&gt; {</code></pre>
<pre class="interface"><code> addAssetGraphToBundle(<a href="/plugin-system/transformer/#Asset">Asset</a>, <a href="/plugin-system/bundler/#Bundle">Bundle</a>, shouldSkipDependency?: (<a href="/plugin-system/transformer/#Dependency">Dependency</a>) =&gt; boolean): void,</code></pre>
<div class="inline-method"><p>Add asset and all child nodes to the bundle.</p>
</div><pre class="interface"><code> addEntryToBundle(<a href="/plugin-system/transformer/#Asset">Asset</a>, <a href="/plugin-system/bundler/#Bundle">Bundle</a>, shouldSkipDependency?: (<a href="/plugin-system/transformer/#Dependency">Dependency</a>) =&gt; boolean): void,</code></pre>
</div><pre class="interface"><code> addAssetToBundle(<a href="/plugin-system/transformer/#Asset">Asset</a>, <a href="/plugin-system/bundler/#Bundle">Bundle</a>): void,</code></pre>
<pre class="interface"><code> addEntryToBundle(<a href="/plugin-system/transformer/#Asset">Asset</a>, <a href="/plugin-system/bundler/#Bundle">Bundle</a>, shouldSkipDependency?: (<a href="/plugin-system/transformer/#Dependency">Dependency</a>) =&gt; boolean): void,</code></pre>
<pre class="interface"><code> addBundleToBundleGroup(<a href="/plugin-system/bundler/#Bundle">Bundle</a>, <a href="/plugin-system/bundler/#BundleGroup">BundleGroup</a>): void,</code></pre>
<pre class="interface"><code> createAssetReference(<a href="/plugin-system/transformer/#Dependency">Dependency</a>, <a href="/plugin-system/transformer/#Asset">Asset</a>, <a href="/plugin-system/bundler/#Bundle">Bundle</a>): void,</code></pre>
<pre class="interface"><code> createBundleReference(<a href="/plugin-system/bundler/#Bundle">Bundle</a>, <a href="/plugin-system/bundler/#Bundle">Bundle</a>): void,</code></pre>
Expand All @@ -280,7 +281,7 @@ <h5>Referenced by:</h5>
</div><div class="type">
<h4 class="title">
<span id="BundleGraph">BundleGraph</span>
<a href="https://github.com/parcel-bundler/parcel/blob/5afe766e637827ede728ec7a9fefcfea691dfa35/packages/core/types/index.js#L1319"><i>parcel/packages/core/types/index.js:1319</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1325"><i>parcel/packages/core/types/index.js:1325</i></a>
</h4>
<p>A Graph that contains <a href="/plugin-system/bundler/#Bundle">Bundle</a>-s, <a href="/plugin-system/transformer/#Asset">Asset</a>-s, <a href="/plugin-system/transformer/#Dependency">Dependency</a>-s, <a href="/plugin-system/bundler/#BundleGroup">BundleGroup</a>-s</p>

Expand All @@ -293,7 +294,7 @@ <h4 class="title">
includeInline: boolean
|}): Array&lt;TBundle&gt;,</code></pre>
<div class="inline-method"><p>Returns a list of bundles in the bundle graph. By default, inline bundles are excluded.</p>
</div><pre class="interface"><code> traverse&lt;TContext&gt;(<a href="/plugin-system/bundler/#GraphVisitor">GraphVisitor</a>&lt;<a href="/plugin-system/bundler/#BundleGraphTraversable">BundleGraphTraversable</a>, TContext&gt;): ?TContext,</code></pre>
</div><pre class="interface"><code> traverse&lt;TContext&gt;(visit: <a href="/plugin-system/bundler/#GraphVisitor">GraphVisitor</a>&lt;<a href="/plugin-system/bundler/#BundleGraphTraversable">BundleGraphTraversable</a>, TContext&gt;, startAsset: ?<a href="/plugin-system/transformer/#Asset">Asset</a>): ?TContext,</code></pre>
<div class="inline-method"><p>Traverses the assets and dependencies in the bundle graph, in depth first order.</p>
</div><pre class="interface"><code> traverseBundles&lt;TContext&gt;(visit: <a href="/plugin-system/bundler/#GraphVisitor">GraphVisitor</a>&lt;TBundle, TContext&gt;, startBundle: ?<a href="/plugin-system/bundler/#Bundle">Bundle</a>): ?TContext,</code></pre>
<div class="inline-method"><p>Traverses all bundles in the bundle graph, including inline bundles, in depth first order.</p>
Expand Down Expand Up @@ -369,7 +370,7 @@ <h5>Referenced by:</h5>
</div><div class="type">
<h4 class="title">
<span id="BundleResult">BundleResult</span>
<a href="https://github.com/parcel-bundler/parcel/blob/5afe766e637827ede728ec7a9fefcfea691dfa35/packages/core/types/index.js#L1426"><i>parcel/packages/core/types/index.js:1426</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1435"><i>parcel/packages/core/types/index.js:1435</i></a>
</h4>

<pre class="interface"><code>type BundleResult = {|</code></pre>
Expand All @@ -384,7 +385,7 @@ <h5>Referenced by:</h5>
</div><div class="type">
<h4 class="title">
<span id="Bundler">Bundler</span>
<a href="https://github.com/parcel-bundler/parcel/blob/5afe766e637827ede728ec7a9fefcfea691dfa35/packages/core/types/index.js#L1487"><i>parcel/packages/core/types/index.js:1487</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1496"><i>parcel/packages/core/types/index.js:1496</i></a>
</h4>
<p>Turns an asset graph into a <a href="/plugin-system/bundler/#BundleGraph">BundleGraph</a>.
<br>bundle and optimize run in series and are functionally identitical.</p>
Expand Down
4 changes: 2 additions & 2 deletions api/compressor.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@
<div class="type">
<h4 class="title">
<span id="Compressor">Compressor</span>
<a href="https://github.com/parcel-bundler/parcel/blob/5afe766e637827ede728ec7a9fefcfea691dfa35/packages/core/types/index.js#L1603"><i>parcel/packages/core/types/index.js:1603</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1612"><i>parcel/packages/core/types/index.js:1612</i></a>
</h4>

<pre class="interface"><code>type Compressor = {|</code></pre>
<pre class="interface"><code> compress({|
stream: Readable,
options: <a href="/plugin-system/api/#PluginOptions">PluginOptions</a>,
logger: <a href="/plugin-system/logging/#PluginLogger">PluginLogger</a>,
|}): <a href="/plugin-system/api/#Async">Async</a>&lt;{|
|}): <a href="/plugin-system/api/#Async">Async</a>&lt;?{|
stream: Readable,
type?: string,
|}&gt;,</code></pre>
Expand Down
Loading

0 comments on commit 738131f

Please sign in to comment.