hendrik/lens
1
0 Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

Deployed 2c3b510997 to master with MkDocs 1.1.2 and mike 1.0.0

Browse Source
This commit is contained in:
GitHub Action committed 2021-05-25 07:32:05 +00:00
1 parent f7ce2870dc
commit 328f593cbf
233 files changed
+6071 -5743
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

master/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html
+62 -129
View File
@@ -856,6 +856,13 @@
Properties
</a>
</li>
<li class="md-nav__item">
<a href="#accessors" class="md-nav__link">
Accessors
</a>
</li>
<li class="md-nav__item">
@@ -899,15 +906,8 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#protected-history" class="md-nav__link">
Protected history
</a>
</li>
<li class="md-nav__item">
<a href="#init" class="md-nav__link">
init
<a href="#ismulti" class="md-nav__link">
isMulti
</a>
</li>
@@ -919,16 +919,22 @@
</li>
<li class="md-nav__item">
<a href="#urlname" class="md-nav__link">
urlName
</a>
</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="#static-system_prefix" class="md-nav__link">
Static SYSTEM_PREFIX
<a href="#defaultvalue" class="md-nav__link">
defaultValue
</a>
</li>
@@ -958,13 +964,6 @@
get
</a>
</li>
<li class="md-nav__item">
<a href="#getdefaultvalue" class="md-nav__link">
getDefaultValue
</a>
</li>
<li class="md-nav__item">
@@ -972,13 +971,6 @@
getRaw
</a>
</li>
<li class="md-nav__item">
<a href="#isempty" class="md-nav__link">
isEmpty
</a>
</li>
<li class="md-nav__item">
@@ -1010,15 +1002,8 @@
</li>
<li class="md-nav__item">
<a href="#toobjectparam" class="md-nav__link">
toObjectParam
</a>
</li>
<li class="md-nav__item">
<a href="#tosearchstring" class="md-nav__link">
toSearchString
<a href="#tostring" class="md-nav__link">
toString
</a>
</li>
@@ -1056,30 +1041,28 @@
</ul>
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
<ul>
<li><a href="./#protected-history">history</a></li>
<li><a href="./#init">init</a></li>
<li><a href="./#ismulti">isMulti</a></li>
<li><a href="./#name">name</a></li>
<li><a href="./#urlname">urlName</a></li>
<li><a href="./#static-system_prefix">SYSTEM_PREFIX</a></li>
</ul>
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
<ul>
<li><a href="./#defaultvalue">defaultValue</a></li>
</ul>
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
<ul>
<li><a href="./#clear">clear</a></li>
<li><a href="./#get">get</a></li>
<li><a href="./#getdefaultvalue">getDefaultValue</a></li>
<li><a href="./#getraw">getRaw</a></li>
<li><a href="./#isempty">isEmpty</a></li>
<li><a href="./#parse">parse</a></li>
<li><a href="./#set">set</a></li>
<li><a href="./#setraw">setRaw</a></li>
<li><a href="./#stringify">stringify</a></li>
<li><a href="./#toobjectparam">toObjectParam</a></li>
<li><a href="./#tosearchstring">toSearchString</a></li>
<li><a href="./#tostring">toString</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>+ <strong>new PageParam</strong>(<code>init</code>: <a href="../../interfaces/_renderer_api_navigation_.pageparaminit/">PageParamInit</a>‹V› | PageSystemParamInit‹V›, <code>history</code>: IObservableHistory): <em><a href="./">PageParam</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L44">src/renderer/navigation/page-param.ts:44</a></em></p>
<p>+ <strong>new PageParam</strong>(<code>init</code>: <a href="../../interfaces/_renderer_api_navigation_.pageparaminit/">PageParamInit</a>‹V›, <code>history</code>: ObservableHistory): <em><a href="./">PageParam</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/2c3b510997/src/renderer/navigation/page-param.ts#L37">src/renderer/navigation/page-param.ts:37</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1091,79 +1074,48 @@
<tbody>
<tr>
<td><code>init</code></td>
<td><a href="../../interfaces/_renderer_api_navigation_.pageparaminit/">PageParamInit</a>‹V› &#124; PageSystemParamInit‹V›</td>
<td><a href="../../interfaces/_renderer_api_navigation_.pageparaminit/">PageParamInit</a>‹V›</td>
</tr>
<tr>
<td><code>history</code></td>
<td>IObservableHistory</td>
<td>ObservableHistory</td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <em><a href="./">PageParam</a></em></p>
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
<h3 id="protected-history"><code>Protected</code> history<a class="headerlink" href="#protected-history" title="Permanent link">#</a></h3>
<p>• <strong>history</strong>: <em>IObservableHistory</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L46">src/renderer/navigation/page-param.ts:46</a></em></p>
<hr />
<h3 id="init">init<a class="headerlink" href="#init" title="Permanent link">#</a></h3>
<p>• <strong>init</strong>: <em><a href="../../interfaces/_renderer_api_navigation_.pageparaminit/">PageParamInit</a>‹V› | PageSystemParamInit‹V›</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L46">src/renderer/navigation/page-param.ts:46</a></em></p>
<h3 id="ismulti">isMulti<a class="headerlink" href="#ismulti" title="Permanent link">#</a></h3>
<p>• <strong>isMulti</strong>: <em>boolean</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/2c3b510997/src/renderer/navigation/page-param.ts#L37">src/renderer/navigation/page-param.ts:37</a></em></p>
<hr />
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
<p>• <strong>name</strong>: <em>string</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L43">src/renderer/navigation/page-param.ts:43</a></em></p>
<hr />
<h3 id="urlname">urlName<a class="headerlink" href="#urlname" title="Permanent link">#</a></h3>
<p>• <strong>urlName</strong>: <em>string</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L44">src/renderer/navigation/page-param.ts:44</a></em></p>
<hr />
<h3 id="static-system_prefix"><code>Static</code> SYSTEM_PREFIX<a class="headerlink" href="#static-system_prefix" title="Permanent link">#</a></h3>
<p>▪ <strong>SYSTEM_PREFIX</strong>: <em>string</em> = "lens-"</p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L41">src/renderer/navigation/page-param.ts:41</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/2c3b510997/src/renderer/navigation/page-param.ts#L36">src/renderer/navigation/page-param.ts:36</a></em></p>
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
<h3 id="defaultvalue">defaultValue<a class="headerlink" href="#defaultvalue" title="Permanent link">#</a></h3>
<p>• <strong>get defaultValue</strong>(): <em>V | undefined</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/2c3b510997/src/renderer/navigation/page-param.ts#L48">src/renderer/navigation/page-param.ts:48</a></em></p>
<p><strong>Returns:</strong> <em>V | undefined</em></p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="clear">clear<a class="headerlink" href="#clear" title="Permanent link">#</a></h3>
<p>▸ <strong>clear</strong>(): <em>void</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L128">src/renderer/navigation/page-param.ts:128</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/2c3b510997/src/renderer/navigation/page-param.ts#L112">src/renderer/navigation/page-param.ts:112</a></em></p>
<p><strong>Returns:</strong> <em>void</em></p>
<hr />
<h3 id="get">get<a class="headerlink" href="#get" title="Permanent link">#</a></h3>
<p>▸ <strong>get</strong>(): <em>V</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L87">src/renderer/navigation/page-param.ts:87</a></em></p>
<p><strong>Returns:</strong> <em>V</em></p>
<hr />
<h3 id="getdefaultvalue">getDefaultValue<a class="headerlink" href="#getdefaultvalue" title="Permanent link">#</a></h3>
<p>▸ <strong>getDefaultValue</strong>(): <em>V</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L122">src/renderer/navigation/page-param.ts:122</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/2c3b510997/src/renderer/navigation/page-param.ts#L73">src/renderer/navigation/page-param.ts:73</a></em></p>
<p><strong>Returns:</strong> <em>V</em></p>
<hr />
<h3 id="getraw">getRaw<a class="headerlink" href="#getraw" title="Permanent link">#</a></h3>
<p>▸ <strong>getRaw</strong>(): <em>string[]</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L115">src/renderer/navigation/page-param.ts:115</a></em></p>
<p><strong>Returns:</strong> <em>string[]</em></p>
<hr />
<h3 id="isempty">isEmpty<a class="headerlink" href="#isempty" title="Permanent link">#</a></h3>
<p>▸ <strong>isEmpty</strong>(<code>value</code>: V | any): <em>boolean</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L57">src/renderer/navigation/page-param.ts:57</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>value</code></td>
<td>V &#124; any</td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <em>boolean</em></p>
<p>▸ <strong>getRaw</strong>(): <em>string | string[]</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/2c3b510997/src/renderer/navigation/page-param.ts#L105">src/renderer/navigation/page-param.ts:105</a></em></p>
<p>Get stringified raw value(s) from <code>document.location.search</code></p>
<p><strong>Returns:</strong> <em>string | string[]</em></p>
<hr />
<h3 id="parse">parse<a class="headerlink" href="#parse" title="Permanent link">#</a></h3>
<p>▸ <strong>parse</strong>(<code>values</code>: string[]): <em>V</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L61">src/renderer/navigation/page-param.ts:61</a></em></p>
<p>▸ <strong>parse</strong>(<code>values</code>: string | string[]): <em>V</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/2c3b510997/src/renderer/navigation/page-param.ts#L52">src/renderer/navigation/page-param.ts:52</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1175,7 +1127,7 @@
<tbody>
<tr>
<td><code>values</code></td>
<td>string[]</td>
<td>string &#124; string[]</td>
</tr>
</tbody>
</table>
@@ -1183,7 +1135,7 @@
<hr />
<h3 id="set">set<a class="headerlink" href="#set" title="Permanent link">#</a></h3>
<p>▸ <strong>set</strong>(<code>value</code>: V, <code>__namedParameters</code>: object): <em>void</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L97">src/renderer/navigation/page-param.ts:97</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/2c3b510997/src/renderer/navigation/page-param.ts#L78">src/renderer/navigation/page-param.ts:78</a></em></p>
<p><strong>Parameters:</strong></p>
<p>▪ <strong>value</strong>: <em>V</em></p>
<p>▪<code>Default value</code> <strong>__namedParameters</strong>: <em>object</em>= {}</p>
@@ -1212,27 +1164,30 @@
<hr />
<h3 id="setraw">setRaw<a class="headerlink" href="#setraw" title="Permanent link">#</a></h3>
<p>▸ <strong>setRaw</strong>(<code>value</code>: string | string[]): <em>void</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L103">src/renderer/navigation/page-param.ts:103</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/2c3b510997/src/renderer/navigation/page-param.ts#L89">src/renderer/navigation/page-param.ts:89</a></em></p>
<p>Set stringified raw value(s) and update <code>document.location.search</code></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>value</code></td>
<td>string &#124; string[]</td>
<td></td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <em>void</em></p>
<hr />
<h3 id="stringify">stringify<a class="headerlink" href="#stringify" title="Permanent link">#</a></h3>
<p>▸ <strong>stringify</strong>(<code>value</code>: V): <em>string</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L70">src/renderer/navigation/page-param.ts:70</a></em></p>
<p>▸ <strong>stringify</strong>(<code>value</code>: V): <em>string[]</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/2c3b510997/src/renderer/navigation/page-param.ts#L63">src/renderer/navigation/page-param.ts:63</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1250,33 +1205,11 @@
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <em>string</em></p>
<p><strong>Returns:</strong> <em>string[]</em></p>
<hr />
<h3 id="toobjectparam">toObjectParam<a class="headerlink" href="#toobjectparam" title="Permanent link">#</a></h3>
<p>▸ <strong>toObjectParam</strong>(<code>value</code>: V): <em>Record‹string, V›</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L151">src/renderer/navigation/page-param.ts:151</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>value</code></td>
<td>V</td>
<td>this.get()</td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <em>Record‹string, V›</em></p>
<hr />
<h3 id="tosearchstring">toSearchString<a class="headerlink" href="#tosearchstring" title="Permanent link">#</a></h3>
<p>▸ <strong>toSearchString</strong>(<code>__namedParameters</code>: object): <em>string</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0c45dd807e/src/renderer/navigation/page-param.ts#L132">src/renderer/navigation/page-param.ts:132</a></em></p>
<h3 id="tostring">toString<a class="headerlink" href="#tostring" title="Permanent link">#</a></h3>
<p>▸ <strong>toString</strong>(<code>__namedParameters</code>: object): <em>string</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/2c3b510997/src/renderer/navigation/page-param.ts#L116">src/renderer/navigation/page-param.ts:116</a></em></p>
<p><strong>Parameters:</strong></p>
<p>▪<code>Default value</code> <strong>__namedParameters</strong>: <em>object</em>= {}</p>
<table>