mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed 4af796c532 to master with MkDocs 1.2.2 and mike 1.1.2
This commit is contained in:
parent
8b27c418b9
commit
2b7c2aca7c
@ -904,7 +904,7 @@
|
||||
<h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>[IpcPrefix]</strong>: <code>string</code></p>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>IpcRegistrar.__@IpcPrefix@44136</p>
|
||||
<p>IpcRegistrar.__@IpcPrefix@44189</p>
|
||||
<hr />
|
||||
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code></p>
|
||||
|
||||
@ -1007,7 +1007,7 @@
|
||||
<h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>[Disposers]</strong>: <code>ExtendableDisposer</code></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.__@Disposers@31571</p>
|
||||
<p>LensExtension.__@Disposers@31575</p>
|
||||
<hr />
|
||||
<h3 id="appmenus">appMenus<a class="headerlink" href="#appmenus" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>appMenus</strong>: <code>MenuRegistration</code>[] = []</p>
|
||||
|
||||
@ -786,6 +786,13 @@
|
||||
<nav class="md-nav" aria-label="Methods">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#addonbeforerun" class="md-nav__link">
|
||||
addOnBeforeRun
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#getbyid" class="md-nav__link">
|
||||
getById
|
||||
@ -840,6 +847,7 @@
|
||||
</ul>
|
||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
<li><a href="./#addonbeforerun">addOnBeforeRun</a></li>
|
||||
<li><a href="./#getbyid">getById</a></li>
|
||||
<li><a href="./#getitemsforapikind">getItemsForApiKind</a></li>
|
||||
<li><a href="./#getitemsforcategory">getItemsForCategory</a></li>
|
||||
@ -859,9 +867,38 @@
|
||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||
<p><code>Map</code><string, <a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a>, <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a>>></p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="addonbeforerun">addOnBeforeRun<a class="headerlink" href="#addonbeforerun" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>addOnBeforeRun</strong>(<code>entity</code>, <code>onBeforeRun</code>): <code>Disposer</code></p>
|
||||
<p>Add a onBeforeRun hook to a catalog entity. If <code>onBeforeRun</code> was previously added then it will not be added again</p>
|
||||
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>entity</code></td>
|
||||
<td align="left"><a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a>, <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a>></td>
|
||||
<td align="left">-</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>onBeforeRun</code></td>
|
||||
<td align="left"><code>CatalogEntityOnBeforeRun</code></td>
|
||||
<td align="left">The function that should return a boolean if the onRun of catalog entity should be triggered.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||
<p><code>Disposer</code></p>
|
||||
<p>A function to remove that hook</p>
|
||||
<hr />
|
||||
<h3 id="getbyid">getById<a class="headerlink" href="#getbyid" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getById</strong>(<code>id</code>): <a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a>, <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a>></p>
|
||||
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@ -876,7 +913,7 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||
<p><a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a>, <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a>></p>
|
||||
<hr />
|
||||
<h3 id="getitemsforapikind">getItemsForApiKind<a class="headerlink" href="#getitemsforapikind" title="Permanent link">#</a></h3>
|
||||
@ -896,45 +933,6 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>apiVersion</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>kind</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||
<p><code>T</code>[]</p>
|
||||
<hr />
|
||||
<h3 id="getitemsforcategory">getItemsForCategory<a class="headerlink" href="#getitemsforcategory" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getItemsForCategory</strong><T>(<code>category</code>): <code>T</code>[]</p>
|
||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>T</code></td>
|
||||
<td align="left"><code>T</code>: <a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a>, <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a>, T></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -945,12 +943,51 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>apiVersion</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>kind</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<p><code>T</code>[]</p>
|
||||
<hr />
|
||||
<h3 id="getitemsforcategory">getItemsForCategory<a class="headerlink" href="#getitemsforcategory" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getItemsForCategory</strong><T>(<code>category</code>): <code>T</code>[]</p>
|
||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>T</code></td>
|
||||
<td align="left"><code>T</code>: <a href="../common.catalog.catalogentity/">CatalogEntity</a><<a href="../../interfaces/common.catalog.catalogentitymetadata/">CatalogEntityMetadata</a>, <a href="../../interfaces/common.catalog.catalogentitystatus/">CatalogEntityStatus</a>, <a href="../../modules/common.catalog/#catalogentityspec">CatalogEntitySpec</a>, T></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>category</code></td>
|
||||
<td align="left"><a href="../common.catalog.catalogcategory/">CatalogCategory</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>T</code>[]</p>
|
||||
|
||||
|
||||
|
||||
@ -904,7 +904,7 @@
|
||||
<h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>[IpcPrefix]</strong>: <code>string</code></p>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>IpcRegistrar.__@IpcPrefix@44136</p>
|
||||
<p>IpcRegistrar.__@IpcPrefix@44189</p>
|
||||
<hr />
|
||||
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code></p>
|
||||
|
||||
@ -1448,7 +1448,7 @@
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>Generator</code><T, void, undefined></p>
|
||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||
<p>ItemStore.__@iterator@539</p>
|
||||
<p>ItemStore.__@iterator@541</p>
|
||||
<hr />
|
||||
<h3 id="bindwatcheventsupdater">bindWatchEventsUpdater<a class="headerlink" href="#bindwatcheventsupdater" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>bindWatchEventsUpdater</strong>(<code>delay?</code>): <code>void</code></p>
|
||||
|
||||
@ -1127,7 +1127,7 @@
|
||||
<h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>[Disposers]</strong>: <code>ExtendableDisposer</code></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.__@Disposers@31571</p>
|
||||
<p>LensExtension.__@Disposers@31575</p>
|
||||
<hr />
|
||||
<h3 id="apppreferences">appPreferences<a class="headerlink" href="#apppreferences" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>appPreferences</strong>: <a href="../../interfaces/common.types.apppreferenceregistration/">AppPreferenceRegistration</a>[] = []</p>
|
||||
@ -1216,7 +1216,7 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="addcatalogcategoryfilter">addCatalogCategoryFilter<a class="headerlink" href="#addcatalogcategoryfilter" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>addCatalogCategoryFilter</strong>(<code>fn</code>): <code>Disposer</code></p>
|
||||
<p>Add a filtering function for the catalog catogries. This will be removed if the extension is disabled.</p>
|
||||
<p>Add a filtering function for the catalog categories. This will be removed if the extension is disabled.</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
File diff suppressed because one or more lines are too long
Binary file not shown.
Loading…
Reference in New Issue
Block a user