Skip to content

Commit

Permalink
Deploy website
Browse files Browse the repository at this point in the history 
Deploy website version based on d6823f7
  • Loading branch information
@coolsoftwaretyler
coolsoftwaretyler committed Feb 4, 2024
1 parent 3908a43 commit 10ca890
Show file tree
Hide file tree
Showing 115 changed files with 609 additions and 609 deletions.
414 changes: 207 additions & 207 deletions API/index.html
View file

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions API/interfaces/customtypeoptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,12 +85,12 @@ <h3><a class="anchor" aria-hidden="true" id="methods"></a><a href="#methods" ari
<h2><a class="anchor" aria-hidden="true" id="properties-1"></a><a href="#properties-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Properties</h2>
<h3><a class="anchor" aria-hidden="true" id="name"></a><a href="#name" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>name</h3>
<p>• <strong>name</strong>: <em>string</em></p>
<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/68b756ba/src/types/utility-types/custom.ts#L15">src/types/utility-types/custom.ts:15</a></em></p>
<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/d6823f74/src/types/utility-types/custom.ts#L15">src/types/utility-types/custom.ts:15</a></em></p>
<p>Friendly name</p>
<h2><a class="anchor" aria-hidden="true" id="methods-1"></a><a href="#methods-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Methods</h2>
<h3><a class="anchor" aria-hidden="true" id="fromsnapshot"></a><a href="#fromsnapshot" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>fromSnapshot</h3>
<p>▸ <strong>fromSnapshot</strong>(<code>snapshot</code>: S, <code>env?</code>: any): <em>T</em></p>
<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/68b756ba/src/types/utility-types/custom.ts#L17">src/types/utility-types/custom.ts:17</a></em></p>
<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/d6823f74/src/types/utility-types/custom.ts#L17">src/types/utility-types/custom.ts:17</a></em></p>
<p>given a serialized value and environment, how to turn it into the target type</p>
<p><strong>Parameters:</strong></p>
<table>
Expand All @@ -106,7 +106,7 @@ <h3><a class="anchor" aria-hidden="true" id="fromsnapshot"></a><a href="#fromsna
<hr>
<h3><a class="anchor" aria-hidden="true" id="getvalidationmessage"></a><a href="#getvalidationmessage" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>getValidationMessage</h3>
<p>▸ <strong>getValidationMessage</strong>(<code>snapshot</code>: S): <em>string</em></p>
<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/68b756ba/src/types/utility-types/custom.ts#L23">src/types/utility-types/custom.ts:23</a></em></p>
<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/d6823f74/src/types/utility-types/custom.ts#L23">src/types/utility-types/custom.ts:23</a></em></p>
<p>a non empty string is assumed to be a validation error</p>
<p><strong>Parameters:</strong></p>
<table>
Expand All @@ -121,7 +121,7 @@ <h3><a class="anchor" aria-hidden="true" id="getvalidationmessage"></a><a href="
<hr>
<h3><a class="anchor" aria-hidden="true" id="istargettype"></a><a href="#istargettype" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>isTargetType</h3>
<p>▸ <strong>isTargetType</strong>(<code>value</code>: T | S): <em>boolean</em></p>
<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/68b756ba/src/types/utility-types/custom.ts#L21">src/types/utility-types/custom.ts:21</a></em></p>
<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/d6823f74/src/types/utility-types/custom.ts#L21">src/types/utility-types/custom.ts:21</a></em></p>
<p>if true, this is a converted value, if false, it's a snapshot</p>
<p><strong>Parameters:</strong></p>
<table>
Expand All @@ -136,7 +136,7 @@ <h3><a class="anchor" aria-hidden="true" id="istargettype"></a><a href="#istarge
<hr>
<h3><a class="anchor" aria-hidden="true" id="tosnapshot"></a><a href="#tosnapshot" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>toSnapshot</h3>
<p>▸ <strong>toSnapshot</strong>(<code>value</code>: T): <em>S</em></p>
<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/68b756ba/src/types/utility-types/custom.ts#L19">src/types/utility-types/custom.ts:19</a></em></p>
<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/d6823f74/src/types/utility-types/custom.ts#L19">src/types/utility-types/custom.ts:19</a></em></p>
<p>return the serialization of the current value</p>
<p><strong>Parameters:</strong></p>
<table>
Expand All @@ -148,7 +148,7 @@ <h3><a class="anchor" aria-hidden="true" id="tosnapshot"></a><a href="#tosnapsho
</tbody>
</table>
<p><strong>Returns:</strong> <em>S</em></p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/index"><span class="arrow-prev">← </span><span>Globals</span></a><a class="docs-next button" href="/API/interfaces/functionwithflag"><span class="function-name-prevnext">FunctionWithFlag</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#type-parameters">Type parameters</a></li><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li><li><a href="#methods">Methods</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#name">name</a></li></ul></li><li><a href="#methods-1">Methods</a><ul class="toc-headings"><li><a href="#fromsnapshot">fromSnapshot</a></li><li><a href="#getvalidationmessage">getValidationMessage</a></li><li><a href="#istargettype">isTargetType</a></li><li><a href="#tosnapshot">toSnapshot</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="MobX-state-tree" width="66" height="58"/></a><div><h5>Docs</h5><a href="/intro/getting-started">Getting Started</a><a href="/concepts/trees">Basic concepts</a><a href="/concepts/patches">Advanced concepts</a><a href="/overview/types">API Reference</a></div><div><h5>Community</h5><a href="https://github.com/mobxjs/mobx-state-tree/discussions" target="_blank" rel="noreferrer noopener">GitHub Discussions</a><a href="https://stackoverflow.com/questions/tagged/mobx-state-tree" target="_blank" rel="noreferrer noopener">Stack Overflow</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/mobxjs/mobx-state-tree">GitHub</a><a class="github-button" href="https://github.com/mobxjs/mobx-state-tree" data-icon="octicon-star" data-count-href="/facebook/docusaurus/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><a href="https://opensource.facebook.com/" target="_blank" rel="noreferrer noopener" class="fbOpenSource"><img src="/img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"/></a><section class="copyright">Copyright © 2023 Michel Weststrate</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/index"><span class="arrow-prev">← </span><span>Globals</span></a><a class="docs-next button" href="/API/interfaces/functionwithflag"><span class="function-name-prevnext">FunctionWithFlag</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#type-parameters">Type parameters</a></li><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li><li><a href="#methods">Methods</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#name">name</a></li></ul></li><li><a href="#methods-1">Methods</a><ul class="toc-headings"><li><a href="#fromsnapshot">fromSnapshot</a></li><li><a href="#getvalidationmessage">getValidationMessage</a></li><li><a href="#istargettype">isTargetType</a></li><li><a href="#tosnapshot">toSnapshot</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="MobX-state-tree" width="66" height="58"/></a><div><h5>Docs</h5><a href="/intro/getting-started">Getting Started</a><a href="/concepts/trees">Basic concepts</a><a href="/concepts/patches">Advanced concepts</a><a href="/overview/types">API Reference</a></div><div><h5>Community</h5><a href="https://github.com/mobxjs/mobx-state-tree/discussions" target="_blank" rel="noreferrer noopener">GitHub Discussions</a><a href="https://stackoverflow.com/questions/tagged/mobx-state-tree" target="_blank" rel="noreferrer noopener">Stack Overflow</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/mobxjs/mobx-state-tree">GitHub</a><a class="github-button" href="https://github.com/mobxjs/mobx-state-tree" data-icon="octicon-star" data-count-href="/facebook/docusaurus/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><a href="https://opensource.facebook.com/" target="_blank" rel="noreferrer noopener" class="fbOpenSource"><img src="/img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"/></a><section class="copyright">Copyright © 2024 Michel Weststrate</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;
Expand Down
Loading

0 comments on commit 10ca890

Please sign in to comment.