Skip to content

Commit

Permalink
Regenerate docs, experimental banner for methods and fields (#1026)
Browse files Browse the repository at this point in the history
  • Loading branch information
mischnic committed Jun 25, 2022
1 parent 8073551 commit ac13171
Show file tree
Hide file tree
Showing 18 changed files with 191 additions and 155 deletions.
28 changes: 14 additions & 14 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/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1057"><i>parcel/packages/core/types/index.js:1057</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/f9ac61299f703d03adae8471290511d4eef075f5/packages/core/types/index.js#L1068"><i>parcel/packages/core/types/index.js:1068</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/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1068"><i>parcel/packages/core/types/index.js:1068</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/f9ac61299f703d03adae8471290511d4eef075f5/packages/core/types/index.js#L1079"><i>parcel/packages/core/types/index.js:1079</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/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1081"><i>parcel/packages/core/types/index.js:1081</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/f9ac61299f703d03adae8471290511d4eef075f5/packages/core/types/index.js#L1092"><i>parcel/packages/core/types/index.js:1092</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/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1090"><i>parcel/packages/core/types/index.js:1090</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/f9ac61299f703d03adae8471290511d4eef075f5/packages/core/types/index.js#L1101"><i>parcel/packages/core/types/index.js:1101</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/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1097"><i>parcel/packages/core/types/index.js:1097</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/f9ac61299f703d03adae8471290511d4eef075f5/packages/core/types/index.js#L1108"><i>parcel/packages/core/types/index.js:1108</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/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1113"><i>parcel/packages/core/types/index.js:1113</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/f9ac61299f703d03adae8471290511d4eef075f5/packages/core/types/index.js#L1124"><i>parcel/packages/core/types/index.js:1124</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/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1197"><i>parcel/packages/core/types/index.js:1197</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/f9ac61299f703d03adae8471290511d4eef075f5/packages/core/types/index.js#L1208"><i>parcel/packages/core/types/index.js:1208</i></a>
</h4>
<p>A <a href="/plugin-system/bundler/#Bundle">Bundle</a> (a collection of assets)
<br></p>
Expand Down Expand Up @@ -205,7 +205,7 @@ <h4 class="title">
<div class="inline-method"><p>Returns whether the bundle includes the given asset.</p>
</div><pre class="interface"><code> hasDependency(<a href="/plugin-system/transformer/#Dependency">Dependency</a>): boolean,</code></pre>
<div class="inline-method"><p>Returns whether the bundle includes the given dependency.</p>
</div><pre class="interface"><code> traverseAssets&lt;TContext&gt;(visit: <a href="/plugin-system/bundler/#GraphVisitor">GraphVisitor</a>&lt;<a href="/plugin-system/transformer/#Asset">Asset</a>, TContext&gt;): ?TContext,</code></pre>
</div><pre class="interface"><code> traverseAssets&lt;TContext&gt;(visit: <a href="/plugin-system/bundler/#GraphVisitor">GraphVisitor</a>&lt;<a href="/plugin-system/transformer/#Asset">Asset</a>, TContext&gt;, startAsset?: <a href="/plugin-system/transformer/#Asset">Asset</a>): ?TContext,</code></pre>
<div class="inline-method"><p>Traverses the assets in the bundle.</p>
</div><pre class="interface"><code> traverse&lt;TContext&gt;(visit: <a href="/plugin-system/bundler/#GraphVisitor">GraphVisitor</a>&lt;<a href="/plugin-system/bundler/#BundleTraversable">BundleTraversable</a>, TContext&gt;): ?TContext,</code></pre>
<div class="inline-method"><p>Traverses assets and dependencies in the bundle.</p>
Expand All @@ -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/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1257"><i>parcel/packages/core/types/index.js:1257</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/f9ac61299f703d03adae8471290511d4eef075f5/packages/core/types/index.js#L1271"><i>parcel/packages/core/types/index.js:1271</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/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1280"><i>parcel/packages/core/types/index.js:1280</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/f9ac61299f703d03adae8471290511d4eef075f5/packages/core/types/index.js#L1294"><i>parcel/packages/core/types/index.js:1294</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,7 +251,7 @@ <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/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1292"><i>parcel/packages/core/types/index.js:1292</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/f9ac61299f703d03adae8471290511d4eef075f5/packages/core/types/index.js#L1306"><i>parcel/packages/core/types/index.js:1306</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>

Expand Down Expand Up @@ -281,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/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1325"><i>parcel/packages/core/types/index.js:1325</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/f9ac61299f703d03adae8471290511d4eef075f5/packages/core/types/index.js#L1339"><i>parcel/packages/core/types/index.js:1339</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 Down Expand Up @@ -370,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/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1435"><i>parcel/packages/core/types/index.js:1435</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/f9ac61299f703d03adae8471290511d4eef075f5/packages/core/types/index.js#L1449"><i>parcel/packages/core/types/index.js:1449</i></a>
</h4>

<pre class="interface"><code>type BundleResult = {|</code></pre>
Expand All @@ -385,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/c9264c4c5429b03d48b2f7699f511266db324c54/packages/core/types/index.js#L1496"><i>parcel/packages/core/types/index.js:1496</i></a>
<a href="https://github.com/parcel-bundler/parcel/blob/f9ac61299f703d03adae8471290511d4eef075f5/packages/core/types/index.js#L1512"><i>parcel/packages/core/types/index.js:1512</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
2 changes: 1 addition & 1 deletion api/compressor.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="Compressor">Compressor</span>
<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>
<a href="https://github.com/parcel-bundler/parcel/blob/f9ac61299f703d03adae8471290511d4eef075f5/packages/core/types/index.js#L1628"><i>parcel/packages/core/types/index.js:1628</i></a>
</h4>

<pre class="interface"><code>type Compressor = {|</code></pre>
Expand Down

1 comment on commit ac13171

@vercel
Copy link

@vercel vercel bot commented on ac13171 Jun 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.