profectus-docs/assets/api_modules_util_proxies.md.feb8b3ae.js

1 line
5.1 KiB
JavaScript

import{_ as e,c as t,o as a,a as r}from"./app.ab34650d.js";const u=JSON.parse('{"title":"Module: util/proxies","description":"","frontmatter":{"editLink":false},"headers":[{"level":2,"title":"Type Aliases","slug":"type-aliases"},{"level":3,"title":"ProxiedWithState","slug":"proxiedwithstate"},{"level":2,"title":"Variables","slug":"variables"},{"level":3,"title":"ProxyPath","slug":"proxypath"},{"level":3,"title":"ProxyState","slug":"proxystate"},{"level":2,"title":"Functions","slug":"functions"},{"level":3,"title":"createLazyProxy","slug":"createlazyproxy"}],"relativePath":"api/modules/util/proxies.md","lastUpdated":null}'),d={name:"api/modules/util/proxies.md"},o=r('<h1 id="module-util-proxies" tabindex="-1">Module: util/proxies <a class="header-anchor" href="#module-util-proxies" aria-hidden="true">#</a></h1><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-hidden="true">#</a></h2><h3 id="proxiedwithstate" tabindex="-1">ProxiedWithState <a class="header-anchor" href="#proxiedwithstate" aria-hidden="true">#</a></h3><p>\u01AC <strong>ProxiedWithState</strong>&lt;<code>T</code>&gt;: <code>NonNullable</code>&lt;<code>T</code>&gt; extends <code>Record</code>&lt;<code>PropertyKey</code>, <code>any</code>&gt; ? <code>NonNullable</code>&lt;<code>T</code>&gt; extends <a href="../../classes/lib/break_eternity.default"><code>default</code></a> ? <code>T</code> : { [<code>K</code> in keyof <code>T</code>]: <a href="./proxies.html#proxiedwithstate"><code>ProxiedWithState</code></a>&lt;<code>T</code>[<code>K</code>]&gt; } &amp; { <code>[ProxyPath]</code>: <code>string</code>[] ; <code>[ProxyState]</code>: <code>T</code> } : <code>T</code></p><h4 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-hidden="true">#</a></h4><table><thead><tr><th style="text-align:left;">Name</th></tr></thead><tbody><tr><td style="text-align:left;"><code>T</code></td></tr></tbody></table><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/util/proxies.ts#L7" target="_blank" rel="noopener noreferrer">profectus/src/util/proxies.ts:7</a></p><h2 id="variables" tabindex="-1">Variables <a class="header-anchor" href="#variables" aria-hidden="true">#</a></h2><h3 id="proxypath" tabindex="-1">ProxyPath <a class="header-anchor" href="#proxypath" aria-hidden="true">#</a></h3><p>\u2022 <code>Const</code> <strong>ProxyPath</strong>: typeof <a href="./proxies.html#proxypath"><code>ProxyPath</code></a></p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/util/proxies.ts#L4" target="_blank" rel="noopener noreferrer">profectus/src/util/proxies.ts:4</a></p><hr><h3 id="proxystate" tabindex="-1">ProxyState <a class="header-anchor" href="#proxystate" aria-hidden="true">#</a></h3><p>\u2022 <code>Const</code> <strong>ProxyState</strong>: typeof <a href="./proxies.html#proxystate"><code>ProxyState</code></a></p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/util/proxies.ts#L3" target="_blank" rel="noopener noreferrer">profectus/src/util/proxies.ts:3</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-hidden="true">#</a></h2><h3 id="createlazyproxy" tabindex="-1">createLazyProxy <a class="header-anchor" href="#createlazyproxy" aria-hidden="true">#</a></h3><p>\u25B8 <strong>createLazyProxy</strong>&lt;<code>T</code>, <code>S</code>&gt;(<code>objectFunc</code>, <code>baseObject?</code>): <code>T</code></p><h4 id="type-parameters-1" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-1" aria-hidden="true">#</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>T</code></td><td style="text-align:left;">extends <code>object</code></td></tr><tr><td style="text-align:left;"><code>S</code></td><td style="text-align:left;"><code>S</code></td></tr></tbody></table><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-hidden="true">#</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>objectFunc</code></td><td style="text-align:left;">(<code>baseObject</code>: <code>S</code>) =&gt; <code>T</code> &amp; <code>S</code></td></tr><tr><td style="text-align:left;"><code>baseObject</code></td><td style="text-align:left;"><code>S</code></td></tr></tbody></table><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-hidden="true">#</a></h4><p><code>T</code></p>',27),i=[o];function s(c,l,n,h,p,x){return a(),t("div",null,i)}var y=e(d,[["render",s]]);export{u as __pageData,y as default};