mirror of
https://github.com/harttle/liquidjs.git
synced 2026-09-15 12:20:40 -07:00
Deploying to gh-pages from @ harttle/liquidjs@822ba0be0f 🚀
This commit is contained in:
@@ -95,7 +95,7 @@
|
||||
<li><strong>Loader</strong></li>
|
||||
</ul>
|
||||
<h2 id="Constructors" class="article-heading"><a href="#Constructors" class="headerlink" title="Constructors"></a>Constructors<a class="article-anchor" href="#Constructors" aria-hidden="true"></a></h2><h3 id="constructor-NaN" class="article-heading"><a href="#constructor-NaN" class="headerlink" title="constructor"></a>constructor<a class="article-anchor" href="#constructor-NaN" aria-hidden="true"></a></h3><p>+ <strong>new Loader</strong>(<code>options</code>: <a href="../interfaces/fs_loader_.loaderoptions.html">LoaderOptions</a>): <em><a href="fs_loader_.loader.html">Loader</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/fs/loader.ts#L16">fs/loader.ts:16</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/fs/loader.ts#L17">fs/loader.ts:17</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -111,9 +111,9 @@
|
||||
</tbody></table>
|
||||
<p><strong>Returns:</strong> <em><a href="fs_loader_.loader.html">Loader</a></em></p>
|
||||
<h2 id="Properties" class="article-heading"><a href="#Properties" class="headerlink" title="Properties"></a>Properties<a class="article-anchor" href="#Properties" aria-hidden="true"></a></h2><h3 id="Private-options" class="article-heading"><a href="#Private-options" class="headerlink" title="Private options"></a><code>Private</code> options<a class="article-anchor" href="#Private-options" aria-hidden="true"></a></h3><p>• <strong>options</strong>: <em><a href="../interfaces/fs_loader_.loaderoptions.html">LoaderOptions</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/fs/loader.ts#L16">fs/loader.ts:16</a></em></p>
|
||||
<h2 id="Methods" class="article-heading"><a href="#Methods" class="headerlink" title="Methods"></a>Methods<a class="article-anchor" href="#Methods" aria-hidden="true"></a></h2><h3 id="Private-candidates" class="article-heading"><a href="#Private-candidates" class="headerlink" title="Private candidates"></a><code>Private</code> candidates<a class="article-anchor" href="#Private-candidates" aria-hidden="true"></a></h3><p>▸ <strong>candidates</strong>(<code>file</code>: string, <code>dirs</code>: string[]): <em>IterableIterator‹string›</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/fs/loader.ts#L31">fs/loader.ts:31</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/fs/loader.ts#L17">fs/loader.ts:17</a></em></p>
|
||||
<h2 id="Methods" class="article-heading"><a href="#Methods" class="headerlink" title="Methods"></a>Methods<a class="article-anchor" href="#Methods" aria-hidden="true"></a></h2><h3 id="candidates" class="article-heading"><a href="#candidates" class="headerlink" title="candidates"></a>candidates<a class="article-anchor" href="#candidates" aria-hidden="true"></a></h3><p>▸ <strong>candidates</strong>(<code>file</code>: string, <code>dirs</code>: string[], <code>currentFile?</code>: undefined | string, <code>enforceRoot?</code>: undefined | false | true): <em>IterableIterator‹string›</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/fs/loader.ts#L40">fs/loader.ts:40</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -130,11 +130,53 @@
|
||||
<td><code>dirs</code></td>
|
||||
<td>string[]</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>currentFile?</code></td>
|
||||
<td>undefined | string</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>enforceRoot?</code></td>
|
||||
<td>undefined | false | true</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<p><strong>Returns:</strong> <em>IterableIterator‹string›</em></p>
|
||||
<hr>
|
||||
<h3 id="lookup" class="article-heading"><a href="#lookup" class="headerlink" title="lookup"></a>lookup<a class="article-anchor" href="#lookup" aria-hidden="true"></a></h3><p>▸ <strong>lookup</strong>(<code>file</code>: string, <code>type</code>: <a href="../enums/fs_loader_.lookuptype.html">LookupType</a>, <code>sync?</code>: undefined | false | true): <em>IterableIterator‹string | Promise‹boolean››</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/fs/loader.ts#L22">fs/loader.ts:22</a></em></p>
|
||||
<h3 id="Private-dirname" class="article-heading"><a href="#Private-dirname" class="headerlink" title="Private dirname"></a><code>Private</code> dirname<a class="article-anchor" href="#Private-dirname" aria-hidden="true"></a></h3><p>▸ <strong>dirname</strong>(<code>path</code>: string): <em>string</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/fs/loader.ts#L64">fs/loader.ts:64</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr>
|
||||
<td><code>path</code></td>
|
||||
<td>string</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<p><strong>Returns:</strong> <em>string</em></p>
|
||||
<hr>
|
||||
<h3 id="isRelativePath" class="article-heading"><a href="#isRelativePath" class="headerlink" title="isRelativePath"></a>isRelativePath<a class="article-anchor" href="#isRelativePath" aria-hidden="true"></a></h3><p>▸ <strong>isRelativePath</strong>(<code>path</code>: string): <em>boolean</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/fs/loader.ts#L36">fs/loader.ts:36</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr>
|
||||
<td><code>path</code></td>
|
||||
<td>string</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<p><strong>Returns:</strong> <em>boolean</em></p>
|
||||
<hr>
|
||||
<h3 id="lookup" class="article-heading"><a href="#lookup" class="headerlink" title="lookup"></a>lookup<a class="article-anchor" href="#lookup" aria-hidden="true"></a></h3><p>▸ <strong>lookup</strong>(<code>file</code>: string, <code>type</code>: <a href="../enums/fs_loader_.lookuptype.html">LookupType</a>, <code>sync?</code>: undefined | false | true, <code>currentFile?</code>: undefined | string): <em>IterableIterator‹string | Promise‹boolean››</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/fs/loader.ts#L23">fs/loader.ts:23</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -155,11 +197,15 @@
|
||||
<td><code>sync?</code></td>
|
||||
<td>undefined | false | true</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>currentFile?</code></td>
|
||||
<td>undefined | string</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<p><strong>Returns:</strong> <em>IterableIterator‹string | Promise‹boolean››</em></p>
|
||||
<hr>
|
||||
<h3 id="Private-lookupError" class="article-heading"><a href="#Private-lookupError" class="headerlink" title="Private lookupError"></a><code>Private</code> lookupError<a class="article-anchor" href="#Private-lookupError" aria-hidden="true"></a></h3><p>▸ <strong>lookupError</strong>(<code>file</code>: string, <code>roots</code>: string[]): <em>any</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/fs/loader.ts#L42">fs/loader.ts:42</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/fs/loader.ts#L70">fs/loader.ts:70</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -178,10 +224,27 @@
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<p><strong>Returns:</strong> <em>any</em></p>
|
||||
<hr>
|
||||
<h3 id="shouldLoadRelative" class="article-heading"><a href="#shouldLoadRelative" class="headerlink" title="shouldLoadRelative"></a>shouldLoadRelative<a class="article-anchor" href="#shouldLoadRelative" aria-hidden="true"></a></h3><p>▸ <strong>shouldLoadRelative</strong>(<code>currentFile</code>: string): <em>boolean</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/fs/loader.ts#L32">fs/loader.ts:32</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr>
|
||||
<td><code>currentFile</code></td>
|
||||
<td>string</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<p><strong>Returns:</strong> <em>boolean</em></p>
|
||||
|
||||
</div>
|
||||
<footer class="article-footer">
|
||||
<time class="article-footer-updated" datetime="2021-10-04T13:37:40.644Z" itemprop="dateModified">Last updated: 2021-10-04</time>
|
||||
<time class="article-footer-updated" datetime="2021-10-06T10:44:42.839Z" itemprop="dateModified">Last updated: 2021-10-06</time>
|
||||
<a href="../classes/liquid_.liquid.html" class="article-footer-next" title="sidebar.api.Liquid"><span>Next</span><i class="icon-chevron-right"></i></a>
|
||||
</footer>
|
||||
</div>
|
||||
@@ -190,7 +253,7 @@
|
||||
<div id="article-toc-inner">
|
||||
<div id="article-toc-inner-list">
|
||||
<strong class="sidebar-title">Contents</strong>
|
||||
<ol class="toc"><li class="toc-item toc-level-2"><a class="toc-link" href="#Hierarchy"><span class="toc-text">Hierarchy</span></a></li><li class="toc-item toc-level-2"><a class="toc-link" href="#Constructors"><span class="toc-text">Constructors</span></a><ol class="toc-child"><li class="toc-item toc-level-3"><a class="toc-link" href="#constructor-NaN"><span class="toc-text">constructor</span></a></li></ol></li><li class="toc-item toc-level-2"><a class="toc-link" href="#Properties"><span class="toc-text">Properties</span></a><ol class="toc-child"><li class="toc-item toc-level-3"><a class="toc-link" href="#Private-options"><span class="toc-text">Private options</span></a></li></ol></li><li class="toc-item toc-level-2"><a class="toc-link" href="#Methods"><span class="toc-text">Methods</span></a><ol class="toc-child"><li class="toc-item toc-level-3"><a class="toc-link" href="#Private-candidates"><span class="toc-text">Private candidates</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#lookup"><span class="toc-text">lookup</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Private-lookupError"><span class="toc-text">Private lookupError</span></a></li></ol></li></ol>
|
||||
<ol class="toc"><li class="toc-item toc-level-2"><a class="toc-link" href="#Hierarchy"><span class="toc-text">Hierarchy</span></a></li><li class="toc-item toc-level-2"><a class="toc-link" href="#Constructors"><span class="toc-text">Constructors</span></a><ol class="toc-child"><li class="toc-item toc-level-3"><a class="toc-link" href="#constructor-NaN"><span class="toc-text">constructor</span></a></li></ol></li><li class="toc-item toc-level-2"><a class="toc-link" href="#Properties"><span class="toc-text">Properties</span></a><ol class="toc-child"><li class="toc-item toc-level-3"><a class="toc-link" href="#Private-options"><span class="toc-text">Private options</span></a></li></ol></li><li class="toc-item toc-level-2"><a class="toc-link" href="#Methods"><span class="toc-text">Methods</span></a><ol class="toc-child"><li class="toc-item toc-level-3"><a class="toc-link" href="#candidates"><span class="toc-text">candidates</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Private-dirname"><span class="toc-text">Private dirname</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#isRelativePath"><span class="toc-text">isRelativePath</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#lookup"><span class="toc-text">lookup</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Private-lookupError"><span class="toc-text">Private lookupError</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#shouldLoadRelative"><span class="toc-text">shouldLoadRelative</span></a></li></ol></li></ol>
|
||||
</div>
|
||||
<a href="#" id="article-toc-top">Back to Top</a>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user