Skip to content

Commit

Permalink
Deploy website
Browse files Browse the repository at this point in the history 
Deploy website version based on 68b756b
  • Loading branch information
@coolsoftwaretyler
coolsoftwaretyler committed Nov 27, 2023
1 parent ec8d94e commit 3908a43
Show file tree
Hide file tree
Showing 65 changed files with 1,382 additions and 1,258 deletions.
426 changes: 214 additions & 212 deletions API/index.html
View file

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions API/interfaces/customtypeoptions.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CustomTypeOptions · MobX-state-tree</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.3.0](/API/) › [CustomTypeOptions](/API/interfaces/customtypeoptions)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="CustomTypeOptions · MobX-state-tree"/><meta property="og:type" content="website"/><meta property="og:url" content="https://mobx-state-tree.js.org//"/><meta property="og:description" content="[mobx-state-tree - v5.3.0](/API/) › [CustomTypeOptions](/API/interfaces/customtypeoptions)"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/img/favicon.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/dracula.min.css"/><script>
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CustomTypeOptions · MobX-state-tree</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.0](/API/) › [CustomTypeOptions](/API/interfaces/customtypeoptions)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="CustomTypeOptions · MobX-state-tree"/><meta property="og:type" content="website"/><meta property="og:url" content="https://mobx-state-tree.js.org//"/><meta property="og:description" content="[mobx-state-tree - v5.4.0](/API/) › [CustomTypeOptions](/API/interfaces/customtypeoptions)"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/img/favicon.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/dracula.min.css"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
Expand Down Expand Up @@ -62,7 +62,7 @@
};
}
});
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/mobxjs/mobx-state-tree/edit/master/docs/API/interfaces/customtypeoptions.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">CustomTypeOptions</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.3.0</a> › <a href="/API/interfaces/customtypeoptions">CustomTypeOptions</a></p>
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/mobxjs/mobx-state-tree/edit/master/docs/API/interfaces/customtypeoptions.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">CustomTypeOptions</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.0</a> › <a href="/API/interfaces/customtypeoptions">CustomTypeOptions</a></p>
<h2><a class="anchor" aria-hidden="true" id="type-parameters"></a><a href="#type-parameters" 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>Type parameters</h2>
<p>▪ <strong>S</strong></p>
<p>▪ <strong>T</strong></p>
Expand All @@ -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/bef5159a/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/68b756ba/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/bef5159a/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/68b756ba/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/bef5159a/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/68b756ba/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/bef5159a/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/68b756ba/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/bef5159a/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/68b756ba/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 Down
Loading

0 comments on commit 3908a43

Please sign in to comment.