mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed 1a6b11525d to master with MkDocs 1.4.2 and mike 1.1.2
This commit is contained in:
parent
c41d051989
commit
4253b2cd3c
@ -723,6 +723,13 @@
|
||||
Hierarchy
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#implements" class="md-nav__link">
|
||||
Implements
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@ -981,6 +988,10 @@
|
||||
</ul>
|
||||
<p>↳ <a href="../Main.LensExtension/"><code>LensExtension</code></a></p>
|
||||
<p>↳ <a href="../Renderer.LensExtension/"><code>LensExtension</code></a></p>
|
||||
<h2 id="implements">Implements<a class="headerlink" href="#implements" title="Permanent link">#</a></h2>
|
||||
<ul>
|
||||
<li><code>LegacyLensExtension</code></li>
|
||||
</ul>
|
||||
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
|
||||
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
@ -1048,15 +1059,23 @@
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="id">id<a class="headerlink" href="#id" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>id</strong>: <code>string</code></p>
|
||||
<h4 id="implementation-of">Implementation of<a class="headerlink" href="#implementation-of" title="Permanent link">#</a></h4>
|
||||
<p>LegacyLensExtension.id</p>
|
||||
<hr />
|
||||
<h3 id="isbundled">isBundled<a class="headerlink" href="#isbundled" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>isBundled</strong>: <code>boolean</code></p>
|
||||
<h4 id="implementation-of_1">Implementation of<a class="headerlink" href="#implementation-of_1" title="Permanent link">#</a></h4>
|
||||
<p>LegacyLensExtension.isBundled</p>
|
||||
<hr />
|
||||
<h3 id="manifest">manifest<a class="headerlink" href="#manifest" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>manifest</strong>: <a href="../../interfaces/Common.LensExtensionManifest/"><code>LensExtensionManifest</code></a></p>
|
||||
<h4 id="implementation-of_2">Implementation of<a class="headerlink" href="#implementation-of_2" title="Permanent link">#</a></h4>
|
||||
<p>LegacyLensExtension.manifest</p>
|
||||
<hr />
|
||||
<h3 id="manifestpath">manifestPath<a class="headerlink" href="#manifestpath" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>manifestPath</strong>: <code>string</code></p>
|
||||
<h4 id="implementation-of_3">Implementation of<a class="headerlink" href="#implementation-of_3" title="Permanent link">#</a></h4>
|
||||
<p>LegacyLensExtension.manifestPath</p>
|
||||
<hr />
|
||||
<h3 id="protocolhandlers">protocolHandlers<a class="headerlink" href="#protocolhandlers" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>protocolHandlers</strong>: <a href="../../interfaces/Common.Types.ProtocolHandlerRegistration/"><code>ProtocolHandlerRegistration</code></a>[]</p>
|
||||
@ -1065,6 +1084,8 @@
|
||||
<p>• <code>get</code> <strong>description</strong>(): <code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="implementation-of_4">Implementation of<a class="headerlink" href="#implementation-of_4" title="Permanent link">#</a></h4>
|
||||
<p>LegacyLensExtension.description</p>
|
||||
<hr />
|
||||
<h3 id="isenabled">isEnabled<a class="headerlink" href="#isenabled" title="Permanent link">#</a></h3>
|
||||
<p>• <code>get</code> <strong>isEnabled</strong>(): <code>boolean</code></p>
|
||||
@ -1075,36 +1096,50 @@
|
||||
<p>• <code>get</code> <strong>name</strong>(): <code>string</code></p>
|
||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="implementation-of_5">Implementation of<a class="headerlink" href="#implementation-of_5" title="Permanent link">#</a></h4>
|
||||
<p>LegacyLensExtension.name</p>
|
||||
<hr />
|
||||
<h3 id="sanitizedextensionid">sanitizedExtensionId<a class="headerlink" href="#sanitizedextensionid" title="Permanent link">#</a></h3>
|
||||
<p>• <code>get</code> <strong>sanitizedExtensionId</strong>(): <code>string</code></p>
|
||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="implementation-of_6">Implementation of<a class="headerlink" href="#implementation-of_6" title="Permanent link">#</a></h4>
|
||||
<p>LegacyLensExtension.sanitizedExtensionId</p>
|
||||
<hr />
|
||||
<h3 id="storename">storeName<a class="headerlink" href="#storename" title="Permanent link">#</a></h3>
|
||||
<p>• <code>get</code> <strong>storeName</strong>(): <code>string</code></p>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="implementation-of_7">Implementation of<a class="headerlink" href="#implementation-of_7" title="Permanent link">#</a></h4>
|
||||
<p>LegacyLensExtension.storeName</p>
|
||||
<hr />
|
||||
<h3 id="version">version<a class="headerlink" href="#version" title="Permanent link">#</a></h3>
|
||||
<p>• <code>get</code> <strong>version</strong>(): <code>string</code></p>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="implementation-of_8">Implementation of<a class="headerlink" href="#implementation-of_8" title="Permanent link">#</a></h4>
|
||||
<p>LegacyLensExtension.version</p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="activate">activate<a class="headerlink" href="#activate" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>activate</strong>(): <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="implementation-of_9">Implementation of<a class="headerlink" href="#implementation-of_9" title="Permanent link">#</a></h4>
|
||||
<p>LegacyLensExtension.activate</p>
|
||||
<hr />
|
||||
<h3 id="disable">disable<a class="headerlink" href="#disable" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>disable</strong>(): <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="implementation-of_10">Implementation of<a class="headerlink" href="#implementation-of_10" title="Permanent link">#</a></h4>
|
||||
<p>LegacyLensExtension.disable</p>
|
||||
<hr />
|
||||
<h3 id="enable">enable<a class="headerlink" href="#enable" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>enable</strong>(): <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="implementation-of_11">Implementation of<a class="headerlink" href="#implementation-of_11" title="Permanent link">#</a></h4>
|
||||
<p>LegacyLensExtension.enable</p>
|
||||
<hr />
|
||||
<h3 id="getextensionfilefolder">getExtensionFileFolder<a class="headerlink" href="#getextensionfilefolder" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getExtensionFileFolder</strong>(): <code>Promise</code><<code>string</code>></p>
|
||||
@ -1114,6 +1149,8 @@ folder is for the sole use of this extension.</p>
|
||||
folder name.</p>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>string</code>></p>
|
||||
<h4 id="implementation-of_12">Implementation of<a class="headerlink" href="#implementation-of_12" title="Permanent link">#</a></h4>
|
||||
<p>LegacyLensExtension.getExtensionFileFolder</p>
|
||||
<hr />
|
||||
<h3 id="onactivate">onActivate<a class="headerlink" href="#onactivate" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>onActivate</strong>(): <code>void</code> | <code>Promise</code><<code>void</code>></p>
|
||||
|
||||
@ -841,6 +841,7 @@
|
||||
<hr />
|
||||
<h3 id="manifestpath">manifestPath<a class="headerlink" href="#manifestpath" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>manifestPath</strong>: <code>string</code></p>
|
||||
<p>Absolute to the symlinked package.json file</p>
|
||||
|
||||
|
||||
|
||||
|
||||
@ -711,13 +711,6 @@
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#hierarchy" class="md-nav__link">
|
||||
Hierarchy
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#table-of-contents" class="md-nav__link">
|
||||
Table of contents
|
||||
@ -746,6 +739,13 @@
|
||||
<nav class="md-nav" aria-label="Properties">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#description" class="md-nav__link">
|
||||
description
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#engines" class="md-nav__link">
|
||||
engines
|
||||
@ -809,14 +809,10 @@
|
||||
|
||||
<h1 id="interface-lensextensionmanifest">Interface: LensExtensionManifest<a class="headerlink" href="#interface-lensextensionmanifest" title="Permanent link">#</a></h1>
|
||||
<p><a href="../../modules/Common/">Common</a>.LensExtensionManifest</p>
|
||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
||||
<ul>
|
||||
<li><code>PackageJson</code></li>
|
||||
</ul>
|
||||
<p>↳ <strong><code>LensExtensionManifest</code></strong></p>
|
||||
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
|
||||
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
<li><a href="./#description">description</a></li>
|
||||
<li><a href="./#engines">engines</a></li>
|
||||
<li><a href="./#main">main</a></li>
|
||||
<li><a href="./#name">name</a></li>
|
||||
@ -825,6 +821,9 @@
|
||||
<li><a href="./#version">version</a></li>
|
||||
</ul>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="description">description<a class="headerlink" href="#description" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>description</strong>: <code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="engines">engines<a class="headerlink" href="#engines" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>engines</strong>: <code>Object</code></p>
|
||||
<p>Supported Lens version engine by extension could be defined in <code>manifest.engines.lens</code>
|
||||
@ -852,29 +851,23 @@ Only MAJOR.MINOR version is taken in consideration.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||
<p>PackageJson.engines</p>
|
||||
<hr />
|
||||
<h3 id="main">main<a class="headerlink" href="#main" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>main</strong>: <code>string</code></p>
|
||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||
<p>PackageJson.main</p>
|
||||
<hr />
|
||||
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>name</strong>: <code>string</code></p>
|
||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||
<p>PackageJson.name</p>
|
||||
<hr />
|
||||
<h3 id="renderer">renderer<a class="headerlink" href="#renderer" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>renderer</strong>: <code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="storename">storeName<a class="headerlink" href="#storename" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>storeName</strong>: <code>string</code></p>
|
||||
<p>Specify extension name used for persisting data.
|
||||
Useful if extension is renamed but the data should not be lost.</p>
|
||||
<hr />
|
||||
<h3 id="version">version<a class="headerlink" href="#version" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>version</strong>: <code>string</code></p>
|
||||
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
||||
<p>PackageJson.version</p>
|
||||
|
||||
|
||||
|
||||
|
||||
File diff suppressed because one or more lines are too long
Binary file not shown.
Loading…
Reference in New Issue
Block a user