mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed 83d2b12cca to master with MkDocs 1.4.2 and mike 1.1.2
This commit is contained in:
GitHub Action committed
1 parent
217ab84c57
commit
3cd3abd330
30 files changed
+144
-432
No files matched your search
@@ -745,13 +745,6 @@
|
||||
Properties
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#accessors" class="md-nav__link">
|
||||
Accessors
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -794,6 +787,13 @@
|
||||
<nav class="md-nav" aria-label="Properties">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dependencies" class="md-nav__link">
|
||||
dependencies
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#displayname" class="md-nav__link">
|
||||
displayName
|
||||
@@ -813,61 +813,6 @@
|
||||
params
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#storeconfig" class="md-nav__link">
|
||||
storeConfig
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#syncdisposers" class="md-nav__link">
|
||||
syncDisposers
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#accessors_1" class="md-nav__link">
|
||||
Accessors
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="Accessors">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#name" class="md-nav__link">
|
||||
name
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#path" class="md-nav__link">
|
||||
path
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#syncmainchannel" class="md-nav__link">
|
||||
syncMainChannel
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#syncrendererchannel" class="md-nav__link">
|
||||
syncRendererChannel
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@@ -883,32 +828,11 @@
|
||||
<nav class="md-nav" aria-label="Methods">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#applywithoutsync" class="md-nav__link">
|
||||
applyWithoutSync
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#cwd" class="md-nav__link">
|
||||
cwd
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#disablesync" class="md-nav__link">
|
||||
disableSync
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#enablesync" class="md-nav__link">
|
||||
enableSync
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -930,34 +854,6 @@
|
||||
loadExtension
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#onmodelchange" class="md-nav__link">
|
||||
onModelChange
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#onsync" class="md-nav__link">
|
||||
onSync
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#onsyncfrommain" class="md-nav__link">
|
||||
onSyncFromMain
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#savetofile" class="md-nav__link">
|
||||
saveToFile
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -965,13 +861,6 @@
|
||||
toJSON
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#unregisteripclistener" class="md-nav__link">
|
||||
unregisterIpcListener
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1043,41 +932,25 @@
|
||||
</ul>
|
||||
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
<li><a href="./#dependencies">dependencies</a></li>
|
||||
<li><a href="./#displayname">displayName</a></li>
|
||||
<li><a href="./#extension">extension</a></li>
|
||||
<li><a href="./#params">params</a></li>
|
||||
<li><a href="./#storeconfig">storeConfig</a></li>
|
||||
<li><a href="./#syncdisposers">syncDisposers</a></li>
|
||||
</ul>
|
||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
<li><a href="./#name">name</a></li>
|
||||
<li><a href="./#path">path</a></li>
|
||||
<li><a href="./#syncmainchannel">syncMainChannel</a></li>
|
||||
<li><a href="./#syncrendererchannel">syncRendererChannel</a></li>
|
||||
</ul>
|
||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
<li><a href="./#applywithoutsync">applyWithoutSync</a></li>
|
||||
<li><a href="./#cwd">cwd</a></li>
|
||||
<li><a href="./#disablesync">disableSync</a></li>
|
||||
<li><a href="./#enablesync">enableSync</a></li>
|
||||
<li><a href="./#fromstore">fromStore</a></li>
|
||||
<li><a href="./#load">load</a></li>
|
||||
<li><a href="./#loadextension">loadExtension</a></li>
|
||||
<li><a href="./#onmodelchange">onModelChange</a></li>
|
||||
<li><a href="./#onsync">onSync</a></li>
|
||||
<li><a href="./#onsyncfrommain">onSyncFromMain</a></li>
|
||||
<li><a href="./#savetofile">saveToFile</a></li>
|
||||
<li><a href="./#tojson">toJSON</a></li>
|
||||
<li><a href="./#unregisteripclistener">unregisterIpcListener</a></li>
|
||||
<li><a href="./#createinstance">createInstance</a></li>
|
||||
<li><a href="./#getinstance">getInstance</a></li>
|
||||
<li><a href="./#resetinstance">resetInstance</a></li>
|
||||
</ul>
|
||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <strong>new ExtensionStore</strong><<code>T</code>>(<code>params</code>)</p>
|
||||
<p>• <strong>new ExtensionStore</strong><<code>T</code>>(<code>__namedParameters</code>)</p>
|
||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1103,114 +976,45 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>params</code></td>
|
||||
<td align="left"><code>BaseStoreParams</code><<code>T</code>></td>
|
||||
<td align="left"><code>__namedParameters</code></td>
|
||||
<td align="left"><code>ExtensionStoreParams</code><<code>T</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore<T>.constructor</p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="displayname">displayName<a class="headerlink" href="#displayname" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>displayName</strong>: <code>"ExtensionStore<T>"</code></p>
|
||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore<T\>.constructor</p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="dependencies">dependencies<a class="headerlink" href="#dependencies" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>dependencies</strong>: <code>BaseStoreDependencies</code></p>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.dependencies</p>
|
||||
<hr />
|
||||
<h3 id="displayname">displayName<a class="headerlink" href="#displayname" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>displayName</strong>: <code>string</code></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.displayName</p>
|
||||
<hr />
|
||||
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Optional</code> <strong>extension</strong>: <code>LensExtension</code><<code>LensExtensionDependencies</code>></p>
|
||||
<hr />
|
||||
<h3 id="params">params<a class="headerlink" href="#params" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <strong>params</strong>: <code>BaseStoreParams</code><<code>T</code>></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.params</p>
|
||||
<hr />
|
||||
<h3 id="storeconfig">storeConfig<a class="headerlink" href="#storeconfig" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Optional</code> <strong>storeConfig</strong>: <code>Conf</code><<code>T</code>></p>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>params</strong>: <code>BaseStoreParams</code><<code>T</code>></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.storeConfig</p>
|
||||
<hr />
|
||||
<h3 id="syncdisposers">syncDisposers<a class="headerlink" href="#syncdisposers" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <strong>syncDisposers</strong>: <code>Disposer</code>[] = <code>[]</code></p>
|
||||
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.syncDisposers</p>
|
||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
|
||||
<p>• <code>get</code> <strong>name</strong>(): <code>string</code></p>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.name</p>
|
||||
<hr />
|
||||
<h3 id="path">path<a class="headerlink" href="#path" title="Permanent link">#</a></h3>
|
||||
<p>• <code>get</code> <strong>path</strong>(): <code>string</code></p>
|
||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.path</p>
|
||||
<hr />
|
||||
<h3 id="syncmainchannel">syncMainChannel<a class="headerlink" href="#syncmainchannel" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>get</code> <strong>syncMainChannel</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="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.syncMainChannel</p>
|
||||
<hr />
|
||||
<h3 id="syncrendererchannel">syncRendererChannel<a class="headerlink" href="#syncrendererchannel" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>get</code> <strong>syncRendererChannel</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="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.syncRendererChannel</p>
|
||||
<p>BaseStore.params</p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="applywithoutsync">applyWithoutSync<a class="headerlink" href="#applywithoutsync" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>applyWithoutSync</strong>(<code>callback</code>): <code>void</code></p>
|
||||
<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>callback</code></td>
|
||||
<td align="left">() => <code>void</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.applyWithoutSync</p>
|
||||
<hr />
|
||||
<h3 id="cwd">cwd<a class="headerlink" href="#cwd" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>cwd</strong>(): <code>string</code></p>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.cwd</p>
|
||||
<hr />
|
||||
<h3 id="disablesync">disableSync<a class="headerlink" href="#disablesync" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>disableSync</strong>(): <code>void</code></p>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.disableSync</p>
|
||||
<hr />
|
||||
<h3 id="enablesync">enableSync<a class="headerlink" href="#enablesync" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>enableSync</strong>(): <code>void</code></p>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.enableSync</p>
|
||||
<hr />
|
||||
<h3 id="fromstore">fromStore<a class="headerlink" href="#fromstore" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <code>Abstract</code> <strong>fromStore</strong>(<code>data</code>): <code>void</code></p>
|
||||
<p>fromStore is called internally when a child class syncs with the file
|
||||
system.</p>
|
||||
<p>Note: This function <strong>must</strong> be synchronous.</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1227,21 +1031,21 @@ system.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.fromStore</p>
|
||||
<hr />
|
||||
<h3 id="load">load<a class="headerlink" href="#load" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>load</strong>(): <code>void</code></p>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.load</p>
|
||||
<hr />
|
||||
<h3 id="loadextension">loadExtension<a class="headerlink" href="#loadextension" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>loadExtension</strong>(<code>extension</code>): <code>void</code></p>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1256,122 +1060,24 @@ system.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<hr />
|
||||
<h3 id="onmodelchange">onModelChange<a class="headerlink" href="#onmodelchange" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>onModelChange</strong>(<code>model</code>): <code>void</code></p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" 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>model</code></td>
|
||||
<td align="left"><code>T</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.onModelChange</p>
|
||||
<hr />
|
||||
<h3 id="onsync">onSync<a class="headerlink" href="#onsync" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>onSync</strong>(<code>model</code>): <code>void</code></p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" 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>model</code></td>
|
||||
<td align="left"><code>T</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.onSync</p>
|
||||
<hr />
|
||||
<h3 id="onsyncfrommain">onSyncFromMain<a class="headerlink" href="#onsyncfrommain" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>onSyncFromMain</strong>(<code>model</code>): <code>void</code></p>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" 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>model</code></td>
|
||||
<td align="left"><code>T</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.onSyncFromMain</p>
|
||||
<hr />
|
||||
<h3 id="savetofile">saveToFile<a class="headerlink" href="#savetofile" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>saveToFile</strong>(<code>model</code>): <code>void</code></p>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" 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>model</code></td>
|
||||
<td align="left"><code>T</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.saveToFile</p>
|
||||
<hr />
|
||||
<h3 id="tojson">toJSON<a class="headerlink" href="#tojson" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Abstract</code> <strong>toJSON</strong>(): <code>T</code></p>
|
||||
<p>toJSON is called when syncing the store to the filesystem. It should
|
||||
produce a JSON serializable object representation of the current state.</p>
|
||||
<p>It is recommended that a round trip is valid. Namely, calling
|
||||
<code>this.fromStore(this.toJSON())</code> shouldn't change the state.</p>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<p><code>T</code></p>
|
||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.toJSON</p>
|
||||
<hr />
|
||||
<h3 id="unregisteripclistener">unregisterIpcListener<a class="headerlink" href="#unregisteripclistener" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>unregisterIpcListener</strong>(): <code>void</code></p>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.unregisterIpcListener</p>
|
||||
<hr />
|
||||
<h3 id="createinstance">createInstance<a class="headerlink" href="#createinstance" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>createInstance</strong><<code>T</code>, <code>R</code>>(<code>this</code>, ...<code>args</code>): <code>T</code></p>
|
||||
<p>Creates the single instance of the child class if one was not already created.</p>
|
||||
<p>Multiple calls will return the same instance.
|
||||
Essentially throwing away the arguments to the subsequent calls.</p>
|
||||
<p>Note: this is a racy function, if two (or more) calls are racing to call this function
|
||||
only the first's arguments will be used.</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This is a form of global shared state. Just call <code>new Store(...)</code></p>
|
||||
<h4 id="type-parameters_2">Type parameters<a class="headerlink" href="#type-parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1383,7 +1089,7 @@ only the first's arguments will be used.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>T</code></td>
|
||||
<td align="left">extends <code>Singleton</code><<code>T</code>></td>
|
||||
<td align="left">extends <a href="./"><code>ExtensionStore</code></a><<code>object</code>, <code>T</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>R</code></td>
|
||||
@@ -1391,37 +1097,32 @@ only the first's arguments will be used.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<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>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>this</code></td>
|
||||
<td align="left"><code>StaticThis</code><<code>T</code>, <code>R</code>></td>
|
||||
<td align="left">Implicit argument that is the child class type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>...args</code></td>
|
||||
<td align="left"><code>R</code></td>
|
||||
<td align="left">The constructor arguments for the child class</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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>
|
||||
<p>An instance of the child class</p>
|
||||
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.createInstance</p>
|
||||
<hr />
|
||||
<h3 id="getinstance">getInstance<a class="headerlink" href="#getinstance" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>getInstance</strong><<code>T</code>, <code>R</code>>(<code>this</code>, <code>strict?</code>): <code>T</code></p>
|
||||
<p>Get the instance of the child class that was previously created.</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This is a form of global shared state. Just call <code>new Store(...)</code></p>
|
||||
<h4 id="type-parameters_3">Type parameters<a class="headerlink" href="#type-parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1441,33 +1142,27 @@ only the first's arguments will be used.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" 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>this</code></td>
|
||||
<td align="left"><code>StaticThis</code><<code>T</code>, <code>R</code>></td>
|
||||
<td align="left">Implicit argument that is the child class type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strict?</code></td>
|
||||
<td align="left"><code>true</code></td>
|
||||
<td align="left">If false will return <code>undefined</code> instead of throwing when an instance doesn't exist. Default: <code>true</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>T</code></p>
|
||||
<p>An instance of the child class</p>
|
||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.getInstance</p>
|
||||
<p>▸ <code>Static</code> <strong>getInstance</strong><<code>T</code>, <code>R</code>>(<code>this</code>, <code>strict</code>): <code>undefined</code> | <code>T</code></p>
|
||||
<h4 id="type-parameters_4">Type parameters<a class="headerlink" href="#type-parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@@ -1488,7 +1183,7 @@ only the first's arguments will be used.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1507,20 +1202,15 @@ only the first's arguments will be used.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>undefined</code> | <code>T</code></p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.getInstance</p>
|
||||
<hr />
|
||||
<h3 id="resetinstance">resetInstance<a class="headerlink" href="#resetinstance" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>resetInstance</strong>(): <code>void</code></p>
|
||||
<p>Delete the instance of the child class.</p>
|
||||
<p>Note: this doesn't prevent callers of <code>getInstance</code> from storing the result in a global.</p>
|
||||
<p>There is <em>no</em> way in JS or TS to prevent globals like that.</p>
|
||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This is a form of global shared state. Just call <code>new Store(...)</code></p>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
||||
<p>BaseStore.resetInstance</p>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in new issue
Block a user