From 7e7c70107500b7cb39e05bc6406cfcab0109ffd8 Mon Sep 17 00:00:00 2001 From: Tyler Williams <tyler@coolsoftware.dev> Date: Mon, 6 May 2024 13:05:40 -0600 Subject: [PATCH] Deploy website Deploy website version based on 72f4f6445216bc0fef58ada44bd4875ecbf690a7 --- API/index.html | 1625 +++-------------- API/interfaces/customtypeoptions.html | 14 +- API/interfaces/customtypeoptions/index.html | 14 +- API/interfaces/functionwithflag.html | 38 +- API/interfaces/functionwithflag/index.html | 38 +- API/interfaces/iactioncontext.html | 16 +- API/interfaces/iactioncontext/index.html | 16 +- API/interfaces/iactionrecorder.html | 14 +- API/interfaces/iactionrecorder/index.html | 14 +- .../iactiontrackingmiddleware2call.html | 8 +- .../iactiontrackingmiddleware2call/index.html | 8 +- .../iactiontrackingmiddleware2hooks.html | 10 +- .../index.html | 10 +- .../iactiontrackingmiddlewarehooks.html | 16 +- .../iactiontrackingmiddlewarehooks/index.html | 16 +- API/interfaces/ianycomplextype.html | 16 +- API/interfaces/ianycomplextype/index.html | 16 +- API/interfaces/ianymodeltype.html | 36 +- API/interfaces/ianymodeltype/index.html | 36 +- API/interfaces/ianytype.html | 16 +- API/interfaces/ianytype/index.html | 16 +- API/interfaces/ihooks.html | 12 +- API/interfaces/ihooks/index.html | 12 +- API/interfaces/ijsonpatch.html | 10 +- API/interfaces/ijsonpatch/index.html | 10 +- API/interfaces/imiddlewareevent.html | 26 +- API/interfaces/imiddlewareevent/index.html | 26 +- API/interfaces/imodelreflectiondata.html | 16 +- .../imodelreflectiondata/index.html | 16 +- .../imodelreflectionpropertiesdata.html | 8 +- .../imodelreflectionpropertiesdata/index.html | 8 +- API/interfaces/imodeltype.html | 36 +- API/interfaces/imodeltype/index.html | 36 +- API/interfaces/ipatchrecorder.html | 20 +- API/interfaces/ipatchrecorder/index.html | 20 +- API/interfaces/ireversiblejsonpatch.html | 12 +- .../ireversiblejsonpatch/index.html | 12 +- API/interfaces/iserializedactioncall.html | 10 +- .../iserializedactioncall/index.html | 10 +- API/interfaces/isimpletype.html | 16 +- API/interfaces/isimpletype/index.html | 16 +- API/interfaces/isnapshotprocessor.html | 16 +- API/interfaces/isnapshotprocessor/index.html | 16 +- API/interfaces/isnapshotprocessors.html | 8 +- API/interfaces/isnapshotprocessors/index.html | 8 +- API/interfaces/itype.html | 16 +- API/interfaces/itype/index.html | 16 +- API/interfaces/ivalidationcontextentry.html | 8 +- .../ivalidationcontextentry/index.html | 8 +- API/interfaces/ivalidationerror.html | 10 +- API/interfaces/ivalidationerror/index.html | 10 +- API/interfaces/referenceoptionsgetset.html | 8 +- .../referenceoptionsgetset/index.html | 8 +- .../referenceoptionsoninvalidated.html | 6 +- .../referenceoptionsoninvalidated/index.html | 6 +- API/interfaces/unionoptions.html | 8 +- API/interfaces/unionoptions/index.html | 8 +- intro/welcome.html | 76 +- intro/welcome/index.html | 76 +- tips/typescript.html | 2 +- tips/typescript/index.html | 2 +- 61 files changed, 727 insertions(+), 1914 deletions(-) diff --git a/API/index.html b/API/index.html index 47f4cdf66..2c6757fb3 100644 --- a/API/index.html +++ b/API/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>mobx-state-tree - v5.4.2 · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="mobx-state-tree - v5.4.2 · 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.2](/API/)"/><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>mobx-state-tree - v6.0.0 · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="mobx-state-tree - v6.0.0 · 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 - v6.0.0](/API/)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/index.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">mobx-state-tree - v5.4.2</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/index.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">mobx-state-tree - v6.0.0</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a></p> <h2><a class="anchor" aria-hidden="true" id="index"></a><a href="#index" 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>Index</h2> <h3><a class="anchor" aria-hidden="true" id="interfaces"></a><a href="#interfaces" 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>Interfaces</h3> <ul> @@ -168,6 +168,7 @@ <h3><a class="anchor" aria-hidden="true" id="functions"></a><a href="#functions" <li><a href="/API/#getrunningactioncontext">getRunningActionContext</a></li> <li><a href="/API/#getsnapshot">getSnapshot</a></li> <li><a href="/API/#gettype">getType</a></li> +<li><a href="/API/#hasenv">hasEnv</a></li> <li><a href="/API/#hasparent">hasParent</a></li> <li><a href="/API/#hasparentoftype">hasParentOfType</a></li> <li><a href="/API/#isactioncontextchildof">isActionContextChildOf</a></li> @@ -230,14 +231,14 @@ <h3><a class="anchor" aria-hidden="true" id="object-literals"></a><a href="#obje <h2><a class="anchor" aria-hidden="true" id="type-aliases-1"></a><a href="#type-aliases-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>Type aliases</h2> <h3><a class="anchor" aria-hidden="true" id="idisposer"></a><a href="#idisposer" 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>IDisposer</h3> <p>Ƭ <strong>IDisposer</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/utils.ts#L41">src/utils.ts:41</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/utils.ts#L41">src/utils.ts:41</a></em></p> <p>A generic disposer.</p> <h4><a class="anchor" aria-hidden="true" id="type-declaration"></a><a href="#type-declaration" 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 declaration:</h4> <p>▸ (): <em>void</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="ihooksgetter"></a><a href="#ihooksgetter" 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>IHooksGetter</h3> <p>Ƭ <strong>IHooksGetter</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/node/Hook.ts#L19">src/core/node/Hook.ts:19</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/node/Hook.ts#L19">src/core/node/Hook.ts:19</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration-1"></a><a href="#type-declaration-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>Type declaration:</h4> <p>▸ (<code>self</code>: T): <em><a href="/API/interfaces/ihooks">IHooks</a></em></p> <p><strong>Parameters:</strong></p> @@ -252,11 +253,11 @@ <h4><a class="anchor" aria-hidden="true" id="type-declaration-1"></a><a href="#t <hr> <h3><a class="anchor" aria-hidden="true" id="imiddlewareeventtype"></a><a href="#imiddlewareeventtype" 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>IMiddlewareEventType</h3> <p>Ƭ <strong>IMiddlewareEventType</strong>: <em>"action" | "flow_spawn" | "flow_resume" | "flow_resume_error" | "flow_return" | "flow_throw"</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L16">src/core/action.ts:16</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L16">src/core/action.ts:16</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="imiddlewarehandler"></a><a href="#imiddlewarehandler" 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>IMiddlewareHandler</h3> <p>Ƭ <strong>IMiddlewareHandler</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L54">src/core/action.ts:54</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L54">src/core/action.ts:54</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration-2"></a><a href="#type-declaration-2" 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 declaration:</h4> <p>▸ (<code>actionCall</code>: <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a>, <code>next</code>: function, <code>abort</code>: function): <em>any</em></p> <p><strong>Parameters:</strong></p> @@ -287,7 +288,7 @@ <h4><a class="anchor" aria-hidden="true" id="type-declaration-2"></a><a href="#t <hr> <h3><a class="anchor" aria-hidden="true" id="itypedispatcher"></a><a href="#itypedispatcher" 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>ITypeDispatcher</h3> <p>Ƭ <strong>ITypeDispatcher</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L27">src/types/utility-types/union.ts:27</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/union.ts#L22">src/types/utility-types/union.ts:22</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration-3"></a><a href="#type-declaration-3" 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 declaration:</h4> <p>▸ (<code>snapshot</code>: any): <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> <p><strong>Parameters:</strong></p> @@ -302,22 +303,22 @@ <h4><a class="anchor" aria-hidden="true" id="type-declaration-3"></a><a href="#t <hr> <h3><a class="anchor" aria-hidden="true" id="ivalidationcontext"></a><a href="#ivalidationcontext" 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>IValidationContext</h3> <p>Ƭ <strong>IValidationContext</strong>: <em><a href="/API/interfaces/ivalidationcontextentry">IValidationContextEntry</a>[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type-checker.ts#L23">src/core/type/type-checker.ts:23</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type-checker.ts#L23">src/core/type/type-checker.ts:23</a></em></p> <p>Array of validation context entries</p> <hr> <h3><a class="anchor" aria-hidden="true" id="ivalidationresult"></a><a href="#ivalidationresult" 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>IValidationResult</h3> <p>Ƭ <strong>IValidationResult</strong>: <em><a href="/API/interfaces/ivalidationerror">IValidationError</a>[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type-checker.ts#L36">src/core/type/type-checker.ts:36</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type-checker.ts#L36">src/core/type/type-checker.ts:36</a></em></p> <p>Type validation result, which is an array of type validation errors</p> <hr> <h3><a class="anchor" aria-hidden="true" id="instance"></a><a href="#instance" 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>Instance</h3> <p>Ƭ <strong>Instance</strong>: <em>T extends object ? T["Type"] : T</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L230">src/core/type/type.ts:230</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L230">src/core/type/type.ts:230</a></em></p> <p>The instance representation of a given type.</p> <hr> <h3><a class="anchor" aria-hidden="true" id="livelinessmode"></a><a href="#livelinessmode" 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>LivelinessMode</h3> <p>Ƭ <strong>LivelinessMode</strong>: <em>"warn" | "error" | "ignore"</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/node/livelinessChecking.ts#L7">src/core/node/livelinessChecking.ts:7</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/node/livelinessChecking.ts#L7">src/core/node/livelinessChecking.ts:7</a></em></p> <p>Defines what MST should do when running into reads / writes to objects that have died.</p> <ul> <li><code>"warn"</code>: Print a warning (default).</li> @@ -327,7 +328,7 @@ <h3><a class="anchor" aria-hidden="true" id="livelinessmode"></a><a href="#livel <hr> <h3><a class="anchor" aria-hidden="true" id="onreferenceinvalidated"></a><a href="#onreferenceinvalidated" 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>OnReferenceInvalidated</h3> <p>Ƭ <strong>OnReferenceInvalidated</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/reference.ts#L43">src/types/utility-types/reference.ts:43</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/reference.ts#L43">src/types/utility-types/reference.ts:43</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration-4"></a><a href="#type-declaration-4" 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 declaration:</h4> <p>▸ (<code>event</code>: <a href="/API/#onreferenceinvalidatedevent">OnReferenceInvalidatedEvent</a>‹STN›): <em>void</em></p> <p><strong>Parameters:</strong></p> @@ -342,26 +343,26 @@ <h4><a class="anchor" aria-hidden="true" id="type-declaration-4"></a><a href="#t <hr> <h3><a class="anchor" aria-hidden="true" id="onreferenceinvalidatedevent"></a><a href="#onreferenceinvalidatedevent" 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>OnReferenceInvalidatedEvent</h3> <p>Ƭ <strong>OnReferenceInvalidatedEvent</strong>: <em>object</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/reference.ts#L34">src/types/utility-types/reference.ts:34</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/reference.ts#L34">src/types/utility-types/reference.ts:34</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration-5"></a><a href="#type-declaration-5" 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 declaration:</h4> <hr> <h3><a class="anchor" aria-hidden="true" id="referenceidentifier"></a><a href="#referenceidentifier" 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>ReferenceIdentifier</h3> <p>Ƭ <strong>ReferenceIdentifier</strong>: <em>string | number</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/identifier.ts#L142">src/types/utility-types/identifier.ts:142</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/identifier.ts#L144">src/types/utility-types/identifier.ts:144</a></em></p> <p>Valid types for identifiers.</p> <hr> <h3><a class="anchor" aria-hidden="true" id="referenceoptions"></a><a href="#referenceoptions" 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>ReferenceOptions</h3> <p>Ƭ <strong>ReferenceOptions</strong>: <em><a href="/API/interfaces/referenceoptionsgetset">ReferenceOptionsGetSet</a>‹IT› | <a href="/API/interfaces/referenceoptionsoninvalidated">ReferenceOptionsOnInvalidated</a>‹IT› | <a href="/API/interfaces/referenceoptionsgetset">ReferenceOptionsGetSet</a>‹IT› & <a href="/API/interfaces/referenceoptionsoninvalidated">ReferenceOptionsOnInvalidated</a>‹IT›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/reference.ts#L451">src/types/utility-types/reference.ts:451</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/reference.ts#L451">src/types/utility-types/reference.ts:451</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="snapshotin"></a><a href="#snapshotin" 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>SnapshotIn</h3> <p>Ƭ <strong>SnapshotIn</strong>: <em>T extends object ? T["CreationType"] : T extends IStateTreeNode<infer IT> ? IT["CreationType"] : T</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L235">src/core/type/type.ts:235</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L235">src/core/type/type.ts:235</a></em></p> <p>The input (creation) snapshot representation of a given type.</p> <hr> <h3><a class="anchor" aria-hidden="true" id="snapshotorinstance"></a><a href="#snapshotorinstance" 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>SnapshotOrInstance</h3> <p>Ƭ <strong>SnapshotOrInstance</strong>: <em><a href="/API/#snapshotin">SnapshotIn</a>‹T› | <a href="/API/#instance">Instance</a>‹T›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L276">src/core/type/type.ts:276</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L276">src/core/type/type.ts:276</a></em></p> <p>A type which is equivalent to the union of SnapshotIn and Instance types of a given typeof TYPE or typeof VARIABLE. For primitives it defaults to the primitive itself.</p> <p>For example:</p> @@ -387,12 +388,12 @@ <h3><a class="anchor" aria-hidden="true" id="snapshotorinstance"></a><a href="#s <hr> <h3><a class="anchor" aria-hidden="true" id="snapshotout"></a><a href="#snapshotout" 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>SnapshotOut</h3> <p>Ƭ <strong>SnapshotOut</strong>: <em>T extends object ? T["SnapshotType"] : T extends IStateTreeNode<infer IT> ? IT["SnapshotType"] : T</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L244">src/core/type/type.ts:244</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L244">src/core/type/type.ts:244</a></em></p> <p>The output snapshot representation of a given type.</p> <h2><a class="anchor" aria-hidden="true" id="variables-1"></a><a href="#variables-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>Variables</h2> <h3><a class="anchor" aria-hidden="true" id="const-dateprimitive"></a><a href="#const-dateprimitive" 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><code>Const</code> DatePrimitive</h3> <p>• <strong>DatePrimitive</strong>: <em><a href="/API/interfaces/itype">IType</a>‹number | Date, number, Date›</em> = _DatePrimitive</p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/primitives.ts#L215">src/types/primitives.ts:215</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/primitives.ts#L215">src/types/primitives.ts:215</a></em></p> <p><code>types.Date</code> - Creates a type that can only contain a javascript Date value.</p> <p>Example:</p> <pre><code class="hljs css language-ts"><span class="hljs-keyword">const</span> LogLine = types.model({ @@ -408,7 +409,7 @@ <h3><a class="anchor" aria-hidden="true" id="const-boolean"></a><a href="#const- TypeFlags.Boolean, (v) => typeof v === "boolean" )</p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/primitives.ts#L169">src/types/primitives.ts:169</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/primitives.ts#L169">src/types/primitives.ts:169</a></em></p> <p><code>types.boolean</code> - Creates a type that can only contain a boolean value. This type is used for boolean values by default</p> <p>Example:</p> @@ -424,7 +425,7 @@ <h3><a class="anchor" aria-hidden="true" id="const-finite"></a><a href="#const-f TypeFlags.Finite, (v) => isFinite(v) )</p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/primitives.ts#L150">src/types/primitives.ts:150</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/primitives.ts#L150">src/types/primitives.ts:150</a></em></p> <p><code>types.finite</code> - Creates a type that can only contain an finite value.</p> <p>Example:</p> <pre><code class="hljs css language-ts"><span class="hljs-keyword">const</span> Size = types.model({ @@ -439,7 +440,7 @@ <h3><a class="anchor" aria-hidden="true" id="const-float"></a><a href="#const-fl TypeFlags.Float, (v) => isFloat(v) )</p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/primitives.ts#L132">src/types/primitives.ts:132</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/primitives.ts#L132">src/types/primitives.ts:132</a></em></p> <p><code>types.float</code> - Creates a type that can only contain an float value.</p> <p>Example:</p> <pre><code class="hljs css language-ts"><span class="hljs-keyword">const</span> Size = types.model({ @@ -450,7 +451,7 @@ <h3><a class="anchor" aria-hidden="true" id="const-float"></a><a href="#const-fl <hr> <h3><a class="anchor" aria-hidden="true" id="const-identifier"></a><a href="#const-identifier" 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><code>Const</code> identifier</h3> <p>• <strong>identifier</strong>: <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹string›</em> = new IdentifierType()</p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/identifier.ts#L110">src/types/utility-types/identifier.ts:110</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/identifier.ts#L112">src/types/utility-types/identifier.ts:112</a></em></p> <p><code>types.identifier</code> - Identifiers are used to make references, lifecycle events and reconciling works. Inside a state tree, for each type can exist only one instance for each given identifier. For example there couldn't be 2 instances of user with id 1. If you need more, consider using references. @@ -466,7 +467,7 @@ <h3><a class="anchor" aria-hidden="true" id="const-identifier"></a><a href="#con <hr> <h3><a class="anchor" aria-hidden="true" id="const-identifiernumber"></a><a href="#const-identifiernumber" 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><code>Const</code> identifierNumber</h3> <p>• <strong>identifierNumber</strong>: <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹number›</em> = new IdentifierNumberType()</p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/identifier.ts#L125">src/types/utility-types/identifier.ts:125</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/identifier.ts#L127">src/types/utility-types/identifier.ts:127</a></em></p> <p><code>types.identifierNumber</code> - Similar to <code>types.identifier</code>. This one will serialize from / to a number when applying snapshots</p> <p>Example:</p> <pre><code class="hljs css language-ts"> <span class="hljs-keyword">const</span> Todo = types.model(<span class="hljs-string">"Todo"</span>, { @@ -482,7 +483,7 @@ <h3><a class="anchor" aria-hidden="true" id="const-integer"></a><a href="#const- TypeFlags.Integer, (v) => isInteger(v) )</p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/primitives.ts#L114">src/types/primitives.ts:114</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/primitives.ts#L114">src/types/primitives.ts:114</a></em></p> <p><code>types.integer</code> - Creates a type that can only contain an integer value.</p> <p>Example:</p> <pre><code class="hljs css language-ts"><span class="hljs-keyword">const</span> Size = types.model({ @@ -497,7 +498,7 @@ <h3><a class="anchor" aria-hidden="true" id="const-nulltype"></a><a href="#const TypeFlags.Null, (v) => v === null )</p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/primitives.ts#L178">src/types/primitives.ts:178</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/primitives.ts#L178">src/types/primitives.ts:178</a></em></p> <p><code>types.null</code> - The type of the value <code>null</code></p> <hr> <h3><a class="anchor" aria-hidden="true" id="const-number"></a><a href="#const-number" 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><code>Const</code> number</h3> @@ -506,7 +507,7 @@ <h3><a class="anchor" aria-hidden="true" id="const-number"></a><a href="#const-n TypeFlags.Number, (v) => typeof v === "number" )</p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/primitives.ts#L96">src/types/primitives.ts:96</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/primitives.ts#L96">src/types/primitives.ts:96</a></em></p> <p><code>types.number</code> - Creates a type that can only contain a numeric value. This type is used for numeric values by default</p> <p>Example:</p> @@ -522,7 +523,7 @@ <h3><a class="anchor" aria-hidden="true" id="const-string"></a><a href="#const-s TypeFlags.String, (v) => typeof v === "string" )</p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/primitives.ts#L77">src/types/primitives.ts:77</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/primitives.ts#L77">src/types/primitives.ts:77</a></em></p> <p><code>types.string</code> - Creates a type that can only contain a string value. This type is used for string values by default</p> <p>Example:</p> @@ -538,12 +539,12 @@ <h3><a class="anchor" aria-hidden="true" id="const-undefinedtype"></a><a href="# TypeFlags.Undefined, (v) => v === undefined )</p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/primitives.ts#L187">src/types/primitives.ts:187</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/primitives.ts#L187">src/types/primitives.ts:187</a></em></p> <p><code>types.undefined</code> - The type of the value <code>undefined</code></p> <h2><a class="anchor" aria-hidden="true" id="functions-1"></a><a href="#functions-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>Functions</h2> <h3><a class="anchor" aria-hidden="true" id="adddisposer"></a><a href="#adddisposer" 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>addDisposer</h3> <p>▸ <strong>addDisposer</strong>(<code>target</code>: IAnyStateTreeNode, <code>disposer</code>: <a href="/API/#idisposer">IDisposer</a>): <em><a href="/API/#idisposer">IDisposer</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L752">src/core/mst-operations.ts:752</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L751">src/core/mst-operations.ts:751</a></em></p> <p>Use this utility to register a function that should be called whenever the targeted state tree node is destroyed. This is a useful alternative to managing cleanup methods yourself using the <code>beforeDestroy</code> hook.</p> @@ -578,7 +579,7 @@ <h3><a class="anchor" aria-hidden="true" id="adddisposer"></a><a href="#adddispo <hr> <h3><a class="anchor" aria-hidden="true" id="addmiddleware"></a><a href="#addmiddleware" 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>addMiddleware</h3> <p>▸ <strong>addMiddleware</strong>(<code>target</code>: IAnyStateTreeNode, <code>handler</code>: <a href="/API/#imiddlewarehandler">IMiddlewareHandler</a>, <code>includeHooks</code>: boolean): <em><a href="/API/#idisposer">IDisposer</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L161">src/core/action.ts:161</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L161">src/core/action.ts:161</a></em></p> <p>Middleware can be used to intercept any action is invoked on the subtree where it is attached. If a tree is protected (by default), this means that any mutation of the tree will pass through your middleware.</p> <p>For more details, see the <a href="/concepts/middleware">middleware docs</a></p> @@ -598,7 +599,7 @@ <h3><a class="anchor" aria-hidden="true" id="addmiddleware"></a><a href="#addmid <hr> <h3><a class="anchor" aria-hidden="true" id="applyaction"></a><a href="#applyaction" 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>applyAction</h3> <p>▸ <strong>applyAction</strong>(<code>target</code>: IAnyStateTreeNode, <code>actions</code>: <a href="/API/interfaces/iserializedactioncall">ISerializedActionCall</a> | <a href="/API/interfaces/iserializedactioncall">ISerializedActionCall</a>[]): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L88">src/middlewares/on-action.ts:88</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L88">src/middlewares/on-action.ts:88</a></em></p> <p>Applies an action or a series of actions in a single MobX transaction. Does not return any value Takes an action description as produced by the <code>onAction</code> middleware.</p> @@ -616,7 +617,7 @@ <h3><a class="anchor" aria-hidden="true" id="applyaction"></a><a href="#applyact <hr> <h3><a class="anchor" aria-hidden="true" id="applypatch"></a><a href="#applypatch" 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>applyPatch</h3> <p>▸ <strong>applyPatch</strong>(<code>target</code>: IAnyStateTreeNode, <code>patch</code>: <a href="/API/interfaces/ijsonpatch">IJsonPatch</a> | ReadonlyArray‹<a href="/API/interfaces/ijsonpatch">IJsonPatch</a>›): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L125">src/core/mst-operations.ts:125</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L124">src/core/mst-operations.ts:124</a></em></p> <p>Applies a JSON-patch to the given model instance or bails out if the patch couldn't be applied See <a href="https://github.com/mobxjs/mobx-state-tree#patches">patches</a> for more details.</p> <p>Can apply a single past, or an array of patches.</p> @@ -634,7 +635,7 @@ <h3><a class="anchor" aria-hidden="true" id="applypatch"></a><a href="#applypatc <hr> <h3><a class="anchor" aria-hidden="true" id="applysnapshot"></a><a href="#applysnapshot" 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>applySnapshot</h3> <p>▸ <strong>applySnapshot</strong><<strong>C</strong>>(<code>target</code>: IStateTreeNode‹<a href="/API/interfaces/itype">IType</a>‹C, any, any››, <code>snapshot</code>: C): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L322">src/core/mst-operations.ts:322</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L321">src/core/mst-operations.ts:321</a></em></p> <p>Applies a snapshot to a given model instances. Patch and snapshot listeners will be invoked as usual.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>C</strong></p> @@ -652,7 +653,7 @@ <h3><a class="anchor" aria-hidden="true" id="applysnapshot"></a><a href="#applys <hr> <h3><a class="anchor" aria-hidden="true" id="array"></a><a href="#array" 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>array</h3> <p>▸ <strong>array</strong><<strong>IT</strong>>(<code>subtype</code>: IT): <em>IArrayType‹IT›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/array.ts#L333">src/types/complex-types/array.ts:333</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/array.ts#L344">src/types/complex-types/array.ts:344</a></em></p> <p><code>types.array</code> - Creates an index based collection type who's children are all of a uniform declared type.</p> <p>This type will always produce <a href="https://mobx.js.org/api.html#observablearray">observable arrays</a></p> <p>Example:</p> @@ -684,7 +685,7 @@ <h3><a class="anchor" aria-hidden="true" id="array"></a><a href="#array" aria-hi <hr> <h3><a class="anchor" aria-hidden="true" id="cast"></a><a href="#cast" 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>cast</h3> <p>▸ <strong>cast</strong><<strong>O</strong>>(<code>snapshotOrInstance</code>: O): <em>O</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L887">src/core/mst-operations.ts:887</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L908">src/core/mst-operations.ts:908</a></em></p> <p>Casts a node snapshot or instance type to an instance type so it can be assigned to a type instance. Note that this is just a cast for the type system, this is, it won't actually convert a snapshot to an instance, but just fool typescript into thinking so. @@ -721,7 +722,7 @@ <h3><a class="anchor" aria-hidden="true" id="cast"></a><a href="#cast" aria-hidd <p><strong>Returns:</strong> <em>O</em></p> <p>The same object cast as an instance</p> <p>▸ <strong>cast</strong><<strong>O</strong>>(<code>snapshotOrInstance</code>: TypeOfValue<O>["CreationType"] | TypeOfValue<O>["SnapshotType"] | TypeOfValue<O>["Type"]): <em>O</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L890">src/core/mst-operations.ts:890</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L911">src/core/mst-operations.ts:911</a></em></p> <p>Casts a node snapshot or instance type to an instance type so it can be assigned to a type instance. Note that this is just a cast for the type system, this is, it won't actually convert a snapshot to an instance, but just fool typescript into thinking so. @@ -760,7 +761,7 @@ <h3><a class="anchor" aria-hidden="true" id="cast"></a><a href="#cast" aria-hidd <hr> <h3><a class="anchor" aria-hidden="true" id="castflowreturn"></a><a href="#castflowreturn" 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>castFlowReturn</h3> <p>▸ <strong>castFlowReturn</strong><<strong>T</strong>>(<code>val</code>: T): <em>T</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/flow.ts#L34">src/core/flow.ts:34</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/flow.ts#L34">src/core/flow.ts:34</a></em></p> <p><strong><code>deprecated</code></strong> Not needed since TS3.6. Used for TypeScript to make flows that return a promise return the actual promise result.</p> <p><strong>Type parameters:</strong></p> @@ -778,7 +779,7 @@ <h3><a class="anchor" aria-hidden="true" id="castflowreturn"></a><a href="#castf <hr> <h3><a class="anchor" aria-hidden="true" id="casttoreferencesnapshot"></a><a href="#casttoreferencesnapshot" 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>castToReferenceSnapshot</h3> <p>▸ <strong>castToReferenceSnapshot</strong><<strong>I</strong>>(<code>instance</code>: I): <em>Extract<I, IAnyStateTreeNode> extends never ? I : ReferenceIdentifier</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L990">src/core/mst-operations.ts:990</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L1011">src/core/mst-operations.ts:1011</a></em></p> <p>Casts a node instance type to a reference snapshot type so it can be assigned to a reference snapshot (e.g. to be used inside a create call). Note that this is just a cast for the type system, this is, it won't actually convert an instance to a reference snapshot, but just fool typescript into thinking so.</p> @@ -816,7 +817,7 @@ <h3><a class="anchor" aria-hidden="true" id="casttoreferencesnapshot"></a><a hre <hr> <h3><a class="anchor" aria-hidden="true" id="casttosnapshot"></a><a href="#casttosnapshot" 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>castToSnapshot</h3> <p>▸ <strong>castToSnapshot</strong><<strong>I</strong>>(<code>snapshotOrInstance</code>: I): <em>Extract<I, IAnyStateTreeNode> extends never ? I : TypeOfValue<I>["CreationType"]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L956">src/core/mst-operations.ts:956</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L977">src/core/mst-operations.ts:977</a></em></p> <p>Casts a node instance type to a snapshot type so it can be assigned to a type snapshot (e.g. to be used inside a create call). Note that this is just a cast for the type system, this is, it won't actually convert an instance to a snapshot, but just fool typescript into thinking so.</p> @@ -853,7 +854,7 @@ <h3><a class="anchor" aria-hidden="true" id="casttosnapshot"></a><a href="#castt <hr> <h3><a class="anchor" aria-hidden="true" id="clone"></a><a href="#clone" 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>clone</h3> <p>▸ <strong>clone</strong><<strong>T</strong>>(<code>source</code>: T, <code>keepEnvironment</code>: boolean | any): <em>T</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L667">src/core/mst-operations.ts:667</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L666">src/core/mst-operations.ts:666</a></em></p> <p>Returns a deep copy of the given state tree node as new tree. Shorthand for <code>snapshot(x) = getType(x).create(getSnapshot(x))</code></p> <p><em>Tip: clone will create a literal copy, including the same identifiers. To modify identifiers etc. during cloning, don't use clone but take a snapshot of the tree, modify it, and create new instance</em></p> @@ -873,7 +874,7 @@ <h3><a class="anchor" aria-hidden="true" id="clone"></a><a href="#clone" aria-hi <hr> <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" 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>compose</h3> <p>▸ <strong>compose</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>>(<code>name</code>: string, <code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB, OA & OB, _CustomJoin‹FCA, FCB›, _CustomJoin‹FSA, FSB››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L774">src/types/complex-types/model.ts:774</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L769">src/types/complex-types/model.ts:769</a></em></p> <p><code>types.compose</code> - Composes a new model from one or more existing model types. This method can be invoked in two forms: Given 2 or more model types, the types are composed into a new Type. @@ -901,7 +902,7 @@ <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" ari </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB, OA & OB, _CustomJoin‹FCA, FCB›, _CustomJoin‹FSA, FSB››</em></p> <p>▸ <strong>compose</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>>(<code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB, OA & OB, _CustomJoin‹FCA, FCB›, _CustomJoin‹FSA, FSB››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L776">src/types/complex-types/model.ts:776</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L771">src/types/complex-types/model.ts:771</a></em></p> <p><code>types.compose</code> - Composes a new model from one or more existing model types. This method can be invoked in two forms: Given 2 or more model types, the types are composed into a new Type. @@ -928,7 +929,7 @@ <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" ari </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB, OA & OB, _CustomJoin‹FCA, FCB›, _CustomJoin‹FSA, FSB››</em></p> <p>▸ <strong>compose</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>>(<code>name</code>: string, <code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC, OA & OB & OC, _CustomJoin‹FCA, _CustomJoin‹FCB, FCC››, _CustomJoin‹FSA, _CustomJoin‹FSB, FSC›››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L778">src/types/complex-types/model.ts:778</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L773">src/types/complex-types/model.ts:773</a></em></p> <p><code>types.compose</code> - Composes a new model from one or more existing model types. This method can be invoked in two forms: Given 2 or more model types, the types are composed into a new Type. @@ -961,7 +962,7 @@ <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" ari </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC, OA & OB & OC, _CustomJoin‹FCA, _CustomJoin‹FCB, FCC››, _CustomJoin‹FSA, _CustomJoin‹FSB, FSC›››</em></p> <p>▸ <strong>compose</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>>(<code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC, OA & OB & OC, _CustomJoin‹FCA, _CustomJoin‹FCB, FCC››, _CustomJoin‹FSA, _CustomJoin‹FSB, FSC›››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L780">src/types/complex-types/model.ts:780</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L775">src/types/complex-types/model.ts:775</a></em></p> <p><code>types.compose</code> - Composes a new model from one or more existing model types. This method can be invoked in two forms: Given 2 or more model types, the types are composed into a new Type. @@ -993,7 +994,7 @@ <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" ari </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC, OA & OB & OC, _CustomJoin‹FCA, _CustomJoin‹FCB, FCC››, _CustomJoin‹FSA, _CustomJoin‹FSB, FSC›››</em></p> <p>▸ <strong>compose</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>>(<code>name</code>: string, <code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD, OA & OB & OC & OD, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, FCD›››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, FSD››››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L782">src/types/complex-types/model.ts:782</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L777">src/types/complex-types/model.ts:777</a></em></p> <p><code>types.compose</code> - Composes a new model from one or more existing model types. This method can be invoked in two forms: Given 2 or more model types, the types are composed into a new Type. @@ -1031,7 +1032,7 @@ <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" ari </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD, OA & OB & OC & OD, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, FCD›››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, FSD››››</em></p> <p>▸ <strong>compose</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>>(<code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD, OA & OB & OC & OD, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, FCD›››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, FSD››››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L784">src/types/complex-types/model.ts:784</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L779">src/types/complex-types/model.ts:779</a></em></p> <p><code>types.compose</code> - Composes a new model from one or more existing model types. This method can be invoked in two forms: Given 2 or more model types, the types are composed into a new Type. @@ -1068,7 +1069,7 @@ <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" ari </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD, OA & OB & OC & OD, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, FCD›››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, FSD››››</em></p> <p>▸ <strong>compose</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>>(<code>name</code>: string, <code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE, OA & OB & OC & OD & OE, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, FCE››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, FSE›››››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L786">src/types/complex-types/model.ts:786</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L781">src/types/complex-types/model.ts:781</a></em></p> <p><code>types.compose</code> - Composes a new model from one or more existing model types. This method can be invoked in two forms: Given 2 or more model types, the types are composed into a new Type. @@ -1111,7 +1112,7 @@ <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" ari </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE, OA & OB & OC & OD & OE, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, FCE››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, FSE›››››</em></p> <p>▸ <strong>compose</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>>(<code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE, OA & OB & OC & OD & OE, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, FCE››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, FSE›››››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L788">src/types/complex-types/model.ts:788</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L783">src/types/complex-types/model.ts:783</a></em></p> <p><code>types.compose</code> - Composes a new model from one or more existing model types. This method can be invoked in two forms: Given 2 or more model types, the types are composed into a new Type. @@ -1153,7 +1154,7 @@ <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" ari </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE, OA & OB & OC & OD & OE, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, FCE››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, FSE›››››</em></p> <p>▸ <strong>compose</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>, <strong>PF</strong>, <strong>OF</strong>, <strong>FCF</strong>, <strong>FSF</strong>>(<code>name</code>: string, <code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›, <code>F</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE & PF, OA & OB & OC & OD & OE & OF, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, FCF›››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, FSF››››››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L792">src/types/complex-types/model.ts:792</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L787">src/types/complex-types/model.ts:787</a></em></p> <p><code>types.compose</code> - Composes a new model from one or more existing model types. This method can be invoked in two forms: Given 2 or more model types, the types are composed into a new Type. @@ -1201,7 +1202,7 @@ <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" ari </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE & PF, OA & OB & OC & OD & OE & OF, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, FCF›››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, FSF››››››</em></p> <p>▸ <strong>compose</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>, <strong>PF</strong>, <strong>OF</strong>, <strong>FCF</strong>, <strong>FSF</strong>>(<code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›, <code>F</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE & PF, OA & OB & OC & OD & OE & OF, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, FCF›››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, FSF››››››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L795">src/types/complex-types/model.ts:795</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L790">src/types/complex-types/model.ts:790</a></em></p> <p><code>types.compose</code> - Composes a new model from one or more existing model types. This method can be invoked in two forms: Given 2 or more model types, the types are composed into a new Type. @@ -1248,7 +1249,7 @@ <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" ari </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE & PF, OA & OB & OC & OD & OE & OF, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, FCF›››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, FSF››››››</em></p> <p>▸ <strong>compose</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>, <strong>PF</strong>, <strong>OF</strong>, <strong>FCF</strong>, <strong>FSF</strong>, <strong>PG</strong>, <strong>OG</strong>, <strong>FCG</strong>, <strong>FSG</strong>>(<code>name</code>: string, <code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›, <code>F</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›, <code>G</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE & PF & PG, OA & OB & OC & OD & OE & OF & OG, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, FCG››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, FSG›››››››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L798">src/types/complex-types/model.ts:798</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L793">src/types/complex-types/model.ts:793</a></em></p> <p><code>types.compose</code> - Composes a new model from one or more existing model types. This method can be invoked in two forms: Given 2 or more model types, the types are composed into a new Type. @@ -1301,7 +1302,7 @@ <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" ari </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE & PF & PG, OA & OB & OC & OD & OE & OF & OG, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, FCG››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, FSG›››››››</em></p> <p>▸ <strong>compose</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>, <strong>PF</strong>, <strong>OF</strong>, <strong>FCF</strong>, <strong>FSF</strong>, <strong>PG</strong>, <strong>OG</strong>, <strong>FCG</strong>, <strong>FSG</strong>>(<code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›, <code>F</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›, <code>G</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE & PF & PG, OA & OB & OC & OD & OE & OF & OG, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, FCG››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, FSG›››››››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L801">src/types/complex-types/model.ts:801</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L796">src/types/complex-types/model.ts:796</a></em></p> <p><code>types.compose</code> - Composes a new model from one or more existing model types. This method can be invoked in two forms: Given 2 or more model types, the types are composed into a new Type. @@ -1353,7 +1354,7 @@ <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" ari </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE & PF & PG, OA & OB & OC & OD & OE & OF & OG, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, FCG››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, FSG›››››››</em></p> <p>▸ <strong>compose</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>, <strong>PF</strong>, <strong>OF</strong>, <strong>FCF</strong>, <strong>FSF</strong>, <strong>PG</strong>, <strong>OG</strong>, <strong>FCG</strong>, <strong>FSG</strong>, <strong>PH</strong>, <strong>OH</strong>, <strong>FCH</strong>, <strong>FSH</strong>>(<code>name</code>: string, <code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›, <code>F</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›, <code>G</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›, <code>H</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PH, OH, FCH, FSH›): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE & PF & PG & PH, OA & OB & OC & OD & OE & OF & OG & OH, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, _CustomJoin‹FCG, FCH›››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, _CustomJoin‹FSG, FSH››››››››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L804">src/types/complex-types/model.ts:804</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L799">src/types/complex-types/model.ts:799</a></em></p> <p><code>types.compose</code> - Composes a new model from one or more existing model types. This method can be invoked in two forms: Given 2 or more model types, the types are composed into a new Type. @@ -1411,7 +1412,7 @@ <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" ari </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE & PF & PG & PH, OA & OB & OC & OD & OE & OF & OG & OH, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, _CustomJoin‹FCG, FCH›››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, _CustomJoin‹FSG, FSH››››››››</em></p> <p>▸ <strong>compose</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>, <strong>PF</strong>, <strong>OF</strong>, <strong>FCF</strong>, <strong>FSF</strong>, <strong>PG</strong>, <strong>OG</strong>, <strong>FCG</strong>, <strong>FSG</strong>, <strong>PH</strong>, <strong>OH</strong>, <strong>FCH</strong>, <strong>FSH</strong>>(<code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›, <code>F</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›, <code>G</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›, <code>H</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PH, OH, FCH, FSH›): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE & PF & PG & PH, OA & OB & OC & OD & OE & OF & OG & OH, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, _CustomJoin‹FCG, FCH›››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, _CustomJoin‹FSG, FSH››››››››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L807">src/types/complex-types/model.ts:807</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L802">src/types/complex-types/model.ts:802</a></em></p> <p><code>types.compose</code> - Composes a new model from one or more existing model types. This method can be invoked in two forms: Given 2 or more model types, the types are composed into a new Type. @@ -1468,7 +1469,7 @@ <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" ari </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE & PF & PG & PH, OA & OB & OC & OD & OE & OF & OG & OH, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, _CustomJoin‹FCG, FCH›››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, _CustomJoin‹FSG, FSH››››››››</em></p> <p>▸ <strong>compose</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>, <strong>PF</strong>, <strong>OF</strong>, <strong>FCF</strong>, <strong>FSF</strong>, <strong>PG</strong>, <strong>OG</strong>, <strong>FCG</strong>, <strong>FSG</strong>, <strong>PH</strong>, <strong>OH</strong>, <strong>FCH</strong>, <strong>FSH</strong>, <strong>PI</strong>, <strong>OI</strong>, <strong>FCI</strong>, <strong>FSI</strong>>(<code>name</code>: string, <code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›, <code>F</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›, <code>G</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›, <code>H</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PH, OH, FCH, FSH›, <code>I</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PI, OI, FCI, FSI›): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE & PF & PG & PH & PI, OA & OB & OC & OD & OE & OF & OG & OH & OI, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, _CustomJoin‹FCG, _CustomJoin‹FCH, FCI››››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, _CustomJoin‹FSG, _CustomJoin‹FSH, FSI›››››››››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L810">src/types/complex-types/model.ts:810</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L805">src/types/complex-types/model.ts:805</a></em></p> <p><code>types.compose</code> - Composes a new model from one or more existing model types. This method can be invoked in two forms: Given 2 or more model types, the types are composed into a new Type. @@ -1531,7 +1532,7 @@ <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" ari </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE & PF & PG & PH & PI, OA & OB & OC & OD & OE & OF & OG & OH & OI, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, _CustomJoin‹FCG, _CustomJoin‹FCH, FCI››››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, _CustomJoin‹FSG, _CustomJoin‹FSH, FSI›››››››››</em></p> <p>▸ <strong>compose</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>, <strong>PF</strong>, <strong>OF</strong>, <strong>FCF</strong>, <strong>FSF</strong>, <strong>PG</strong>, <strong>OG</strong>, <strong>FCG</strong>, <strong>FSG</strong>, <strong>PH</strong>, <strong>OH</strong>, <strong>FCH</strong>, <strong>FSH</strong>, <strong>PI</strong>, <strong>OI</strong>, <strong>FCI</strong>, <strong>FSI</strong>>(<code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›, <code>F</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›, <code>G</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›, <code>H</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PH, OH, FCH, FSH›, <code>I</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PI, OI, FCI, FSI›): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PA & PB & PC & PD & PE & PF & PG & PH & PI, OA & OB & OC & OD & OE & OF & OG & OH & OI, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, _CustomJoin‹FCG, _CustomJoin‹FCH, FCI››››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, _CustomJoin‹FSG, _CustomJoin‹FSH, FSI›››››››››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L813">src/types/complex-types/model.ts:813</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L808">src/types/complex-types/model.ts:808</a></em></p> <p><code>types.compose</code> - Composes a new model from one or more existing model types. This method can be invoked in two forms: Given 2 or more model types, the types are composed into a new Type. @@ -1595,7 +1596,7 @@ <h3><a class="anchor" aria-hidden="true" id="compose"></a><a href="#compose" ari <hr> <h3><a class="anchor" aria-hidden="true" id="createactiontrackingmiddleware"></a><a href="#createactiontrackingmiddleware" 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>createActionTrackingMiddleware</h3> <p>▸ <strong>createActionTrackingMiddleware</strong><<strong>T</strong>>(<code>hooks</code>: <a href="/API/interfaces/iactiontrackingmiddlewarehooks">IActionTrackingMiddlewareHooks</a>‹T›): <em><a href="/API/#imiddlewarehandler">IMiddlewareHandler</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/create-action-tracking-middleware.ts#L28">src/middlewares/create-action-tracking-middleware.ts:28</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/create-action-tracking-middleware.ts#L28">src/middlewares/create-action-tracking-middleware.ts:28</a></em></p> <p>Note: Consider migrating to <code>createActionTrackingMiddleware2</code>, it is easier to use.</p> <p>Convenience utility to create action based middleware that supports async processes more easily. All hooks are called for both synchronous and asynchronous actions. Except that either <code>onSuccess</code> or <code>onFail</code> is called</p> @@ -1617,7 +1618,7 @@ <h3><a class="anchor" aria-hidden="true" id="createactiontrackingmiddleware"></a <hr> <h3><a class="anchor" aria-hidden="true" id="createactiontrackingmiddleware2"></a><a href="#createactiontrackingmiddleware2" 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>createActionTrackingMiddleware2</h3> <p>▸ <strong>createActionTrackingMiddleware2</strong><<strong>TEnv</strong>>(<code>middlewareHooks</code>: <a href="/API/interfaces/iactiontrackingmiddleware2hooks">IActionTrackingMiddleware2Hooks</a>‹TEnv›): <em><a href="/API/#imiddlewarehandler">IMiddlewareHandler</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/createActionTrackingMiddleware2.ts#L74">src/middlewares/createActionTrackingMiddleware2.ts:74</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/createActionTrackingMiddleware2.ts#L72">src/middlewares/createActionTrackingMiddleware2.ts:72</a></em></p> <p>Convenience utility to create action based middleware that supports async processes more easily. The flow is like this:</p> <ul> @@ -1654,7 +1655,7 @@ <h3><a class="anchor" aria-hidden="true" id="createactiontrackingmiddleware2"></ <hr> <h3><a class="anchor" aria-hidden="true" id="custom"></a><a href="#custom" 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>custom</h3> <p>▸ <strong>custom</strong><<strong>S</strong>, <strong>T</strong>>(<code>options</code>: <a href="/API/interfaces/customtypeoptions">CustomTypeOptions</a>‹S, T›): <em><a href="/API/interfaces/itype">IType</a>‹S | T, S, T›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/custom.ts#L74">src/types/utility-types/custom.ts:74</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/custom.ts#L74">src/types/utility-types/custom.ts:74</a></em></p> <p><code>types.custom</code> - Creates a custom type. Custom types can be used for arbitrary immutable values, that have a serializable representation. For example, to create your own Date representation, Decimal type etc.</p> <p>The signature of the options is:</p> <pre><code class="hljs css language-ts"><span class="hljs-keyword">export</span> <span class="hljs-keyword">interface</span> CustomTypeOptions<S, T> { @@ -1708,7 +1709,7 @@ <h3><a class="anchor" aria-hidden="true" id="custom"></a><a href="#custom" aria- <hr> <h3><a class="anchor" aria-hidden="true" id="decorate"></a><a href="#decorate" 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>decorate</h3> <p>▸ <strong>decorate</strong><<strong>T</strong>>(<code>handler</code>: <a href="/API/#imiddlewarehandler">IMiddlewareHandler</a>, <code>fn</code>: T, <code>includeHooks</code>: boolean): <em>T</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L200">src/core/action.ts:200</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L200">src/core/action.ts:200</a></em></p> <p>Binds middleware to a specific action.</p> <p>Example:</p> <pre><code class="hljs css language-ts"><span class="hljs-keyword">type</span>.actions(<span class="hljs-function"><span class="hljs-params">self</span> =></span> { @@ -1741,7 +1742,7 @@ <h3><a class="anchor" aria-hidden="true" id="decorate"></a><a href="#decorate" a <hr> <h3><a class="anchor" aria-hidden="true" id="destroy"></a><a href="#destroy" 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>destroy</h3> <p>▸ <strong>destroy</strong>(<code>target</code>: IAnyStateTreeNode): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L699">src/core/mst-operations.ts:699</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L698">src/core/mst-operations.ts:698</a></em></p> <p>Removes a model element from the state tree, and mark it as end-of-life; the element should not be used anymore</p> <p><strong>Parameters:</strong></p> <table> @@ -1756,7 +1757,7 @@ <h3><a class="anchor" aria-hidden="true" id="destroy"></a><a href="#destroy" ari <hr> <h3><a class="anchor" aria-hidden="true" id="detach"></a><a href="#detach" 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>detach</h3> <p>▸ <strong>detach</strong><<strong>T</strong>>(<code>target</code>: T): <em>T</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L688">src/core/mst-operations.ts:688</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L687">src/core/mst-operations.ts:687</a></em></p> <p>Removes a model element from the state tree, and let it live on as a new state tree</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>T</strong>: <em>IAnyStateTreeNode</em></p> @@ -1772,8 +1773,8 @@ <h3><a class="anchor" aria-hidden="true" id="detach"></a><a href="#detach" aria- <p><strong>Returns:</strong> <em>T</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="enumeration"></a><a href="#enumeration" 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>enumeration</h3> -<p>▸ <strong>enumeration</strong><<strong>T</strong>>(<code>options</code>: T): <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹UnionStringArray‹T››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/enumeration.ts#L11">src/types/utility-types/enumeration.ts:11</a></em></p> +<p>▸ <strong>enumeration</strong><<strong>T</strong>>(<code>options</code>: keyof T[]): <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹UnionStringArray‹T[]››</em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/enumeration.ts#L11">src/types/utility-types/enumeration.ts:11</a></em></p> <p><code>types.enumeration</code> - Can be used to create an string based enumeration. (note: this methods is just sugar for a union of string literals)</p> <p>Example:</p> @@ -1782,19 +1783,19 @@ <h3><a class="anchor" aria-hidden="true" id="enumeration"></a><a href="#enumerat }) </code></pre> <p><strong>Type parameters:</strong></p> -<p>▪ <strong>T</strong>: <em>keyof string[]</em></p> +<p>▪ <strong>T</strong>: <em>string</em></p> <p><strong>Parameters:</strong></p> <table> <thead> <tr><th>Name</th><th>Type</th><th>Description</th></tr> </thead> <tbody> -<tr><td><code>options</code></td><td>T</td><td>possible values this enumeration can have</td></tr> +<tr><td><code>options</code></td><td>keyof T[]</td><td>possible values this enumeration can have</td></tr> </tbody> </table> -<p><strong>Returns:</strong> <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹UnionStringArray‹T››</em></p> -<p>▸ <strong>enumeration</strong><<strong>T</strong>>(<code>name</code>: string, <code>options</code>: T[]): <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹UnionStringArray‹T[]››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/enumeration.ts#L14">src/types/utility-types/enumeration.ts:14</a></em></p> +<p><strong>Returns:</strong> <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹UnionStringArray‹T[]››</em></p> +<p>▸ <strong>enumeration</strong><<strong>T</strong>>(<code>name</code>: string, <code>options</code>: keyof T[]): <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹UnionStringArray‹T[]››</em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/enumeration.ts#L14">src/types/utility-types/enumeration.ts:14</a></em></p> <p><code>types.enumeration</code> - Can be used to create an string based enumeration. (note: this methods is just sugar for a union of string literals)</p> <p>Example:</p> @@ -1811,14 +1812,14 @@ <h3><a class="anchor" aria-hidden="true" id="enumeration"></a><a href="#enumerat </thead> <tbody> <tr><td><code>name</code></td><td>string</td><td>descriptive name of the enumeration (optional)</td></tr> -<tr><td><code>options</code></td><td>T[]</td><td>possible values this enumeration can have</td></tr> +<tr><td><code>options</code></td><td>keyof T[]</td><td>possible values this enumeration can have</td></tr> </tbody> </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹UnionStringArray‹T[]››</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="escapejsonpath"></a><a href="#escapejsonpath" 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>escapeJsonPath</h3> <p>▸ <strong>escapeJsonPath</strong>(<code>path</code>: string): <em>string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L77">src/core/json-patch.ts:77</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L78">src/core/json-patch.ts:78</a></em></p> <p>Escape slashes and backslashes.</p> <p><a href="http://tools.ietf.org/html/rfc6901">http://tools.ietf.org/html/rfc6901</a></p> <p><strong>Parameters:</strong></p> @@ -1834,7 +1835,7 @@ <h3><a class="anchor" aria-hidden="true" id="escapejsonpath"></a><a href="#escap <hr> <h3><a class="anchor" aria-hidden="true" id="flow"></a><a href="#flow" 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>flow</h3> <p>▸ <strong>flow</strong><<strong>R</strong>, <strong>Args</strong>>(<code>generator</code>: function): <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/flow.ts#L21">src/core/flow.ts:21</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/flow.ts#L21">src/core/flow.ts:21</a></em></p> <p>See <a href="/concepts/async-actions">asynchronous actions</a>.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>R</strong></p> @@ -1866,7 +1867,7 @@ <h3><a class="anchor" aria-hidden="true" id="flow"></a><a href="#flow" aria-hidd <hr> <h3><a class="anchor" aria-hidden="true" id="frozen"></a><a href="#frozen" 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>frozen</h3> <p>▸ <strong>frozen</strong><<strong>C</strong>>(<code>subType</code>: <a href="/API/interfaces/itype">IType</a>‹C, any, any›): <em><a href="/API/interfaces/itype">IType</a>‹C, C, C›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/frozen.ts#L54">src/types/utility-types/frozen.ts:54</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/frozen.ts#L54">src/types/utility-types/frozen.ts:54</a></em></p> <p><code>types.frozen</code> - Frozen can be used to store any value that is serializable in itself (that is valid JSON). Frozen values need to be immutable or treated as if immutable. They need be serializable as well. Values stored in frozen will snapshotted as-is by MST, and internal changes will not be tracked.</p> @@ -1910,7 +1911,7 @@ <h3><a class="anchor" aria-hidden="true" id="frozen"></a><a href="#frozen" aria- </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/itype">IType</a>‹C, C, C›</em></p> <p>▸ <strong>frozen</strong><<strong>T</strong>>(<code>defaultValue</code>: T): <em><a href="/API/interfaces/itype">IType</a>‹T | undefined | null, T, T›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/frozen.ts#L55">src/types/utility-types/frozen.ts:55</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/frozen.ts#L55">src/types/utility-types/frozen.ts:55</a></em></p> <p><code>types.frozen</code> - Frozen can be used to store any value that is serializable in itself (that is valid JSON). Frozen values need to be immutable or treated as if immutable. They need be serializable as well. Values stored in frozen will snapshotted as-is by MST, and internal changes will not be tracked.</p> @@ -1954,7 +1955,7 @@ <h3><a class="anchor" aria-hidden="true" id="frozen"></a><a href="#frozen" aria- </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/itype">IType</a>‹T | undefined | null, T, T›</em></p> <p>▸ <strong>frozen</strong><<strong>T</strong>>(): <em><a href="/API/interfaces/itype">IType</a>‹T, T, T›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/frozen.ts#L56">src/types/utility-types/frozen.ts:56</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/frozen.ts#L56">src/types/utility-types/frozen.ts:56</a></em></p> <p><code>types.frozen</code> - Frozen can be used to store any value that is serializable in itself (that is valid JSON). Frozen values need to be immutable or treated as if immutable. They need be serializable as well. Values stored in frozen will snapshotted as-is by MST, and internal changes will not be tracked.</p> @@ -1991,7 +1992,7 @@ <h3><a class="anchor" aria-hidden="true" id="frozen"></a><a href="#frozen" aria- <hr> <h3><a class="anchor" aria-hidden="true" id="getchildtype"></a><a href="#getchildtype" 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>getChildType</h3> <p>▸ <strong>getChildType</strong>(<code>object</code>: IAnyStateTreeNode, <code>propertyName?</code>: undefined | string): <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L69">src/core/mst-operations.ts:69</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L68">src/core/mst-operations.ts:68</a></em></p> <p>Returns the <em>declared</em> type of the given sub property of an object, array or map. In the case of arrays and maps the property name is optional and will be ignored.</p> <p>Example:</p> @@ -2014,8 +2015,8 @@ <h3><a class="anchor" aria-hidden="true" id="getchildtype"></a><a href="#getchil <hr> <h3><a class="anchor" aria-hidden="true" id="getenv"></a><a href="#getenv" 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>getEnv</h3> <p>▸ <strong>getEnv</strong><<strong>T</strong>>(<code>target</code>: IAnyStateTreeNode): <em>T</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L774">src/core/mst-operations.ts:774</a></em></p> -<p>Returns the environment of the current state tree. For more info on environments, +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L773">src/core/mst-operations.ts:773</a></em></p> +<p>Returns the environment of the current state tree, or throws. For more info on environments, see <a href="https://github.com/mobxjs/mobx-state-tree#dependency-injection">Dependency injection</a></p> <p>Please note that in child nodes access to the root is only possible once the <code>afterAttach</code> hook has fired</p> @@ -2035,7 +2036,7 @@ <h3><a class="anchor" aria-hidden="true" id="getenv"></a><a href="#getenv" aria- <hr> <h3><a class="anchor" aria-hidden="true" id="getidentifier"></a><a href="#getidentifier" 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>getIdentifier</h3> <p>▸ <strong>getIdentifier</strong>(<code>target</code>: IAnyStateTreeNode): <em>string | null</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L550">src/core/mst-operations.ts:550</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L549">src/core/mst-operations.ts:549</a></em></p> <p>Returns the identifier of the target node. This is the <em>string normalized</em> identifier, which might not match the type of the identifier attribute</p> <p><strong>Parameters:</strong></p> @@ -2051,14 +2052,14 @@ <h3><a class="anchor" aria-hidden="true" id="getidentifier"></a><a href="#getide <hr> <h3><a class="anchor" aria-hidden="true" id="getlivelinesschecking"></a><a href="#getlivelinesschecking" 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>getLivelinessChecking</h3> <p>▸ <strong>getLivelinessChecking</strong>(): <em><a href="/API/#livelinessmode">LivelinessMode</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/node/livelinessChecking.ts#L27">src/core/node/livelinessChecking.ts:27</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/node/livelinessChecking.ts#L27">src/core/node/livelinessChecking.ts:27</a></em></p> <p>Returns the current liveliness checking mode.</p> <p><strong>Returns:</strong> <em><a href="/API/#livelinessmode">LivelinessMode</a></em></p> <p><code>"warn"</code>, <code>"error"</code> or <code>"ignore"</code></p> <hr> <h3><a class="anchor" aria-hidden="true" id="getmembers"></a><a href="#getmembers" 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>getMembers</h3> <p>▸ <strong>getMembers</strong>(<code>target</code>: IAnyStateTreeNode): <em><a href="/API/interfaces/imodelreflectiondata">IModelReflectionData</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L853">src/core/mst-operations.ts:853</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L874">src/core/mst-operations.ts:874</a></em></p> <p>Returns a reflection of the model node, including name, properties, views, volatile state, and actions. <code>flowActions</code> is also provided as a separate array of names for any action that came from a flow generator as well.</p> @@ -2079,7 +2080,7 @@ <h3><a class="anchor" aria-hidden="true" id="getmembers"></a><a href="#getmember <hr> <h3><a class="anchor" aria-hidden="true" id="getnodeid"></a><a href="#getnodeid" 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>getNodeId</h3> <p>▸ <strong>getNodeId</strong>(<code>target</code>: IAnyStateTreeNode): <em>number</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L1005">src/core/mst-operations.ts:1005</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L1026">src/core/mst-operations.ts:1026</a></em></p> <p>Returns the unique node id (not to be confused with the instance identifier) for a given instance. This id is a number that is unique for each instance.</p> @@ -2097,7 +2098,7 @@ <h3><a class="anchor" aria-hidden="true" id="getnodeid"></a><a href="#getnodeid" <hr> <h3><a class="anchor" aria-hidden="true" id="getparent"></a><a href="#getparent" 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>getParent</h3> <p>▸ <strong>getParent</strong><<strong>IT</strong>>(<code>target</code>: IAnyStateTreeNode, <code>depth</code>: number): <em>TypeOrStateTreeNodeToStateTreeNode‹IT›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L383">src/core/mst-operations.ts:383</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L382">src/core/mst-operations.ts:382</a></em></p> <p>Returns the immediate parent of this object, or throws.</p> <p>Note that the immediate parent can be either an object, map or array, and doesn't necessarily refer to the parent model.</p> @@ -2119,7 +2120,7 @@ <h3><a class="anchor" aria-hidden="true" id="getparent"></a><a href="#getparent" <hr> <h3><a class="anchor" aria-hidden="true" id="getparentoftype"></a><a href="#getparentoftype" 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>getParentOfType</h3> <p>▸ <strong>getParentOfType</strong><<strong>IT</strong>>(<code>target</code>: IAnyStateTreeNode, <code>type</code>: IT): <em>IT["Type"]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L427">src/core/mst-operations.ts:427</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L426">src/core/mst-operations.ts:426</a></em></p> <p>Returns the target's parent of a given type, or throws.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>IT</strong>: <em><a href="/API/interfaces/ianycomplextype">IAnyComplexType</a></em></p> @@ -2137,7 +2138,7 @@ <h3><a class="anchor" aria-hidden="true" id="getparentoftype"></a><a href="#getp <hr> <h3><a class="anchor" aria-hidden="true" id="getpath"></a><a href="#getpath" 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>getPath</h3> <p>▸ <strong>getPath</strong>(<code>target</code>: IAnyStateTreeNode): <em>string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L467">src/core/mst-operations.ts:467</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L466">src/core/mst-operations.ts:466</a></em></p> <p>Returns the path of the given object in the model tree</p> <p><strong>Parameters:</strong></p> <table> @@ -2152,7 +2153,7 @@ <h3><a class="anchor" aria-hidden="true" id="getpath"></a><a href="#getpath" ari <hr> <h3><a class="anchor" aria-hidden="true" id="getpathparts"></a><a href="#getpathparts" 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>getPathParts</h3> <p>▸ <strong>getPathParts</strong>(<code>target</code>: IAnyStateTreeNode): <em>string[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L480">src/core/mst-operations.ts:480</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L479">src/core/mst-operations.ts:479</a></em></p> <p>Returns the path of the given object as unescaped string array.</p> <p><strong>Parameters:</strong></p> <table> @@ -2167,7 +2168,7 @@ <h3><a class="anchor" aria-hidden="true" id="getpathparts"></a><a href="#getpath <hr> <h3><a class="anchor" aria-hidden="true" id="getpropertymembers"></a><a href="#getpropertymembers" 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>getPropertyMembers</h3> <p>▸ <strong>getPropertyMembers</strong>(<code>typeOrNode</code>: <a href="/API/interfaces/ianymodeltype">IAnyModelType</a> | IAnyStateTreeNode): <em><a href="/API/interfaces/imodelreflectionpropertiesdata">IModelReflectionPropertiesData</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L814">src/core/mst-operations.ts:814</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L835">src/core/mst-operations.ts:835</a></em></p> <p>Returns a reflection of the model type properties and name for either a model type or model node.</p> <p><strong>Parameters:</strong></p> <table> @@ -2182,7 +2183,7 @@ <h3><a class="anchor" aria-hidden="true" id="getpropertymembers"></a><a href="#g <hr> <h3><a class="anchor" aria-hidden="true" id="getrelativepath"></a><a href="#getrelativepath" 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>getRelativePath</h3> <p>▸ <strong>getRelativePath</strong>(<code>base</code>: IAnyStateTreeNode, <code>target</code>: IAnyStateTreeNode): <em>string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L649">src/core/mst-operations.ts:649</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L648">src/core/mst-operations.ts:648</a></em></p> <p>Given two state tree nodes that are part of the same tree, returns the shortest jsonpath needed to navigate from the one to the other</p> <p><strong>Parameters:</strong></p> @@ -2199,7 +2200,7 @@ <h3><a class="anchor" aria-hidden="true" id="getrelativepath"></a><a href="#getr <hr> <h3><a class="anchor" aria-hidden="true" id="getroot"></a><a href="#getroot" 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>getRoot</h3> <p>▸ <strong>getRoot</strong><<strong>IT</strong>>(<code>target</code>: IAnyStateTreeNode): <em>TypeOrStateTreeNodeToStateTreeNode‹IT›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L452">src/core/mst-operations.ts:452</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L451">src/core/mst-operations.ts:451</a></em></p> <p>Given an object in a model tree, returns the root object of that tree.</p> <p>Please note that in child nodes access to the root is only possible once the <code>afterAttach</code> hook has fired.</p> @@ -2218,13 +2219,13 @@ <h3><a class="anchor" aria-hidden="true" id="getroot"></a><a href="#getroot" ari <hr> <h3><a class="anchor" aria-hidden="true" id="getrunningactioncontext"></a><a href="#getrunningactioncontext" 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>getRunningActionContext</h3> <p>▸ <strong>getRunningActionContext</strong>(): <em><a href="/API/interfaces/iactioncontext">IActionContext</a> | undefined</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L26">src/core/actionContext.ts:26</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L26">src/core/actionContext.ts:26</a></em></p> <p>Returns the currently executing MST action context, or undefined if none.</p> <p><strong>Returns:</strong> <em><a href="/API/interfaces/iactioncontext">IActionContext</a> | undefined</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="getsnapshot"></a><a href="#getsnapshot" 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>getSnapshot</h3> <p>▸ <strong>getSnapshot</strong><<strong>S</strong>>(<code>target</code>: IStateTreeNode‹<a href="/API/interfaces/itype">IType</a>‹any, S, any››, <code>applyPostProcess</code>: boolean): <em>S</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L337">src/core/mst-operations.ts:337</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L336">src/core/mst-operations.ts:336</a></em></p> <p>Calculates a snapshot from the given model instance. The snapshot will always reflect the latest state but use structural sharing where possible. Doesn't require MobX transactions to be completed.</p> <p><strong>Type parameters:</strong></p> @@ -2243,7 +2244,7 @@ <h3><a class="anchor" aria-hidden="true" id="getsnapshot"></a><a href="#getsnaps <hr> <h3><a class="anchor" aria-hidden="true" id="gettype"></a><a href="#gettype" 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>getType</h3> <p>▸ <strong>getType</strong>(<code>object</code>: IAnyStateTreeNode): <em><a href="/API/interfaces/ianycomplextype">IAnyComplexType</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L47">src/core/mst-operations.ts:47</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L46">src/core/mst-operations.ts:46</a></em></p> <p>Returns the <em>actual</em> type of the given tree node. (Or throws)</p> <p><strong>Parameters:</strong></p> <table> @@ -2256,9 +2257,25 @@ <h3><a class="anchor" aria-hidden="true" id="gettype"></a><a href="#gettype" ari </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/ianycomplextype">IAnyComplexType</a></em></p> <hr> +<h3><a class="anchor" aria-hidden="true" id="hasenv"></a><a href="#hasenv" 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>hasEnv</h3> +<p>▸ <strong>hasEnv</strong>(<code>target</code>: IAnyStateTreeNode): <em>boolean</em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L790">src/core/mst-operations.ts:790</a></em></p> +<p>Returns whether the current state tree has environment or not.</p> +<p><strong><code>export</code></strong></p> +<p><strong>Parameters:</strong></p> +<table> +<thead> +<tr><th>Name</th><th>Type</th></tr> +</thead> +<tbody> +<tr><td><code>target</code></td><td>IAnyStateTreeNode</td></tr> +</tbody> +</table> +<p><strong>Returns:</strong> <em>boolean</em></p> +<hr> <h3><a class="anchor" aria-hidden="true" id="hasparent"></a><a href="#hasparent" 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>hasParent</h3> <p>▸ <strong>hasParent</strong>(<code>target</code>: IAnyStateTreeNode, <code>depth</code>: number): <em>boolean</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L357">src/core/mst-operations.ts:357</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L356">src/core/mst-operations.ts:356</a></em></p> <p>Given a model instance, returns <code>true</code> if the object has a parent, that is, is part of another object, map or array.</p> <p><strong>Parameters:</strong></p> <table> @@ -2274,7 +2291,7 @@ <h3><a class="anchor" aria-hidden="true" id="hasparent"></a><a href="#hasparent" <hr> <h3><a class="anchor" aria-hidden="true" id="hasparentoftype"></a><a href="#hasparentoftype" 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>hasParentOfType</h3> <p>▸ <strong>hasParentOfType</strong>(<code>target</code>: IAnyStateTreeNode, <code>type</code>: <a href="/API/interfaces/ianycomplextype">IAnyComplexType</a>): <em>boolean</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L407">src/core/mst-operations.ts:407</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L406">src/core/mst-operations.ts:406</a></em></p> <p>Given a model instance, returns <code>true</code> if the object has a parent of given type, that is, is part of another object, map or array</p> <p><strong>Parameters:</strong></p> <table> @@ -2290,7 +2307,7 @@ <h3><a class="anchor" aria-hidden="true" id="hasparentoftype"></a><a href="#hasp <hr> <h3><a class="anchor" aria-hidden="true" id="isactioncontextchildof"></a><a href="#isactioncontextchildof" 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>isActionContextChildOf</h3> <p>▸ <strong>isActionContextChildOf</strong>(<code>actionContext</code>: <a href="/API/interfaces/iactioncontext">IActionContext</a>, <code>parent</code>: number | <a href="/API/interfaces/iactioncontext">IActionContext</a> | <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a>): <em>boolean</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L56">src/core/actionContext.ts:56</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L56">src/core/actionContext.ts:56</a></em></p> <p>Returns if the given action context is a parent of this action context.</p> <p><strong>Parameters:</strong></p> <table> @@ -2306,7 +2323,7 @@ <h3><a class="anchor" aria-hidden="true" id="isactioncontextchildof"></a><a href <hr> <h3><a class="anchor" aria-hidden="true" id="isactioncontextthisorchildof"></a><a href="#isactioncontextthisorchildof" 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>isActionContextThisOrChildOf</h3> <p>▸ <strong>isActionContextThisOrChildOf</strong>(<code>actionContext</code>: <a href="/API/interfaces/iactioncontext">IActionContext</a>, <code>parentOrThis</code>: number | <a href="/API/interfaces/iactioncontext">IActionContext</a> | <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a>): <em>boolean</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L66">src/core/actionContext.ts:66</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L66">src/core/actionContext.ts:66</a></em></p> <p>Returns if the given action context is this or a parent of this action context.</p> <p><strong>Parameters:</strong></p> <table> @@ -2322,7 +2339,7 @@ <h3><a class="anchor" aria-hidden="true" id="isactioncontextthisorchildof"></a>< <hr> <h3><a class="anchor" aria-hidden="true" id="isalive"></a><a href="#isalive" 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>isAlive</h3> <p>▸ <strong>isAlive</strong>(<code>target</code>: IAnyStateTreeNode): <em>boolean</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L717">src/core/mst-operations.ts:717</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L716">src/core/mst-operations.ts:716</a></em></p> <p>Returns true if the given state tree node is not killed yet. This means that the node is still a part of a tree, and that <code>destroy</code> has not been called. If a node is not alive anymore, the only thing one can do with it @@ -2340,7 +2357,7 @@ <h3><a class="anchor" aria-hidden="true" id="isalive"></a><a href="#isalive" ari <hr> <h3><a class="anchor" aria-hidden="true" id="isarraytype"></a><a href="#isarraytype" 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>isArrayType</h3> <p>▸ <strong>isArrayType</strong><<strong>Items</strong>>(<code>type</code>: <a href="/API/interfaces/ianytype">IAnyType</a>): <em>type is IArrayType<Items></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/array.ts#L497">src/types/complex-types/array.ts:497</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/array.ts#L508">src/types/complex-types/array.ts:508</a></em></p> <p>Returns if a given value represents an array type.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>Items</strong>: <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> @@ -2358,7 +2375,7 @@ <h3><a class="anchor" aria-hidden="true" id="isarraytype"></a><a href="#isarrayt <hr> <h3><a class="anchor" aria-hidden="true" id="isfrozentype"></a><a href="#isfrozentype" 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>isFrozenType</h3> <p>▸ <strong>isFrozenType</strong><<strong>IT</strong>, <strong>T</strong>>(<code>type</code>: IT): <em>type is IT</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/frozen.ts#L109">src/types/utility-types/frozen.ts:109</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/frozen.ts#L109">src/types/utility-types/frozen.ts:109</a></em></p> <p>Returns if a given value represents a frozen type.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>IT</strong>: <em><a href="/API/interfaces/itype">IType</a>‹T | any, T, T›</em></p> @@ -2376,7 +2393,7 @@ <h3><a class="anchor" aria-hidden="true" id="isfrozentype"></a><a href="#isfroze <hr> <h3><a class="anchor" aria-hidden="true" id="isidentifiertype"></a><a href="#isidentifiertype" 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>isIdentifierType</h3> <p>▸ <strong>isIdentifierType</strong><<strong>IT</strong>>(<code>type</code>: IT): <em>type is IT</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/identifier.ts#L133">src/types/utility-types/identifier.ts:133</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/identifier.ts#L135">src/types/utility-types/identifier.ts:135</a></em></p> <p>Returns if a given value represents an identifier type.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>IT</strong>: <em><a href="/API/interfaces/isimpletype">ISimpleType</a> | <a href="/API/interfaces/isimpletype">ISimpleType</a></em></p> @@ -2393,7 +2410,7 @@ <h3><a class="anchor" aria-hidden="true" id="isidentifiertype"></a><a href="#isi <hr> <h3><a class="anchor" aria-hidden="true" id="islatetype"></a><a href="#islatetype" 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>isLateType</h3> <p>▸ <strong>isLateType</strong><<strong>IT</strong>>(<code>type</code>: IT): <em>type is IT</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/late.ts#L137">src/types/utility-types/late.ts:137</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/late.ts#L141">src/types/utility-types/late.ts:141</a></em></p> <p>Returns if a given value represents a late type.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>IT</strong>: <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> @@ -2410,7 +2427,7 @@ <h3><a class="anchor" aria-hidden="true" id="islatetype"></a><a href="#islatetyp <hr> <h3><a class="anchor" aria-hidden="true" id="isliteraltype"></a><a href="#isliteraltype" 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>isLiteralType</h3> <p>▸ <strong>isLiteralType</strong><<strong>IT</strong>>(<code>type</code>: IT): <em>type is IT</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/literal.ts#L82">src/types/utility-types/literal.ts:82</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/literal.ts#L81">src/types/utility-types/literal.ts:81</a></em></p> <p>Returns if a given value represents a literal type.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>IT</strong>: <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹any›</em></p> @@ -2427,7 +2444,7 @@ <h3><a class="anchor" aria-hidden="true" id="isliteraltype"></a><a href="#islite <hr> <h3><a class="anchor" aria-hidden="true" id="ismaptype"></a><a href="#ismaptype" 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>isMapType</h3> <p>▸ <strong>isMapType</strong><<strong>Items</strong>>(<code>type</code>: <a href="/API/interfaces/ianytype">IAnyType</a>): <em>type is IMapType<Items></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/map.ts#L512">src/types/complex-types/map.ts:512</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/map.ts#L512">src/types/complex-types/map.ts:512</a></em></p> <p>Returns if a given value represents a map type.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>Items</strong>: <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> @@ -2445,7 +2462,7 @@ <h3><a class="anchor" aria-hidden="true" id="ismaptype"></a><a href="#ismaptype" <hr> <h3><a class="anchor" aria-hidden="true" id="ismodeltype"></a><a href="#ismodeltype" 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>isModelType</h3> <p>▸ <strong>isModelType</strong><<strong>IT</strong>>(<code>type</code>: <a href="/API/interfaces/ianytype">IAnyType</a>): <em>type is IT</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L859">src/types/complex-types/model.ts:859</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L854">src/types/complex-types/model.ts:854</a></em></p> <p>Returns if a given value represents a model type.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>IT</strong>: <em><a href="/API/interfaces/ianymodeltype">IAnyModelType</a></em></p> @@ -2462,7 +2479,7 @@ <h3><a class="anchor" aria-hidden="true" id="ismodeltype"></a><a href="#ismodelt <hr> <h3><a class="anchor" aria-hidden="true" id="isoptionaltype"></a><a href="#isoptionaltype" 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>isOptionalType</h3> <p>▸ <strong>isOptionalType</strong><<strong>IT</strong>>(<code>type</code>: IT): <em>type is IT</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/optional.ts#L229">src/types/utility-types/optional.ts:229</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/optional.ts#L229">src/types/utility-types/optional.ts:229</a></em></p> <p>Returns if a value represents an optional type.</p> <p><strong><code>template</code></strong> IT</p> <p><strong>Type parameters:</strong></p> @@ -2480,7 +2497,7 @@ <h3><a class="anchor" aria-hidden="true" id="isoptionaltype"></a><a href="#isopt <hr> <h3><a class="anchor" aria-hidden="true" id="isprimitivetype"></a><a href="#isprimitivetype" 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>isPrimitiveType</h3> <p>▸ <strong>isPrimitiveType</strong><<strong>IT</strong>>(<code>type</code>: IT): <em>type is IT</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/primitives.ts#L241">src/types/primitives.ts:241</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/primitives.ts#L241">src/types/primitives.ts:241</a></em></p> <p>Returns if a given value represents a primitive type.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>IT</strong>: <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹string› | <a href="/API/interfaces/isimpletype">ISimpleType</a>‹number› | <a href="/API/interfaces/isimpletype">ISimpleType</a>‹boolean› | <a href="/API/interfaces/itype">IType</a></em></p> @@ -2497,7 +2514,7 @@ <h3><a class="anchor" aria-hidden="true" id="isprimitivetype"></a><a href="#ispr <hr> <h3><a class="anchor" aria-hidden="true" id="isprotected"></a><a href="#isprotected" 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>isProtected</h3> <p>▸ <strong>isProtected</strong>(<code>target</code>: IAnyStateTreeNode): <em>boolean</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L311">src/core/mst-operations.ts:311</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L310">src/core/mst-operations.ts:310</a></em></p> <p>Returns true if the object is in protected mode, @see protect</p> <p><strong>Parameters:</strong></p> <table> @@ -2512,7 +2529,7 @@ <h3><a class="anchor" aria-hidden="true" id="isprotected"></a><a href="#isprotec <hr> <h3><a class="anchor" aria-hidden="true" id="isreferencetype"></a><a href="#isreferencetype" 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>isReferenceType</h3> <p>▸ <strong>isReferenceType</strong><<strong>IT</strong>>(<code>type</code>: IT): <em>type is IT</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/reference.ts#L509">src/types/utility-types/reference.ts:509</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/reference.ts#L511">src/types/utility-types/reference.ts:511</a></em></p> <p>Returns if a given value represents a reference type.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>IT</strong>: <em>IReferenceType‹any›</em></p> @@ -2529,7 +2546,7 @@ <h3><a class="anchor" aria-hidden="true" id="isreferencetype"></a><a href="#isre <hr> <h3><a class="anchor" aria-hidden="true" id="isrefinementtype"></a><a href="#isrefinementtype" 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>isRefinementType</h3> <p>▸ <strong>isRefinementType</strong><<strong>IT</strong>>(<code>type</code>: IT): <em>type is IT</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/refinement.ts#L124">src/types/utility-types/refinement.ts:124</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/refinement.ts#L123">src/types/utility-types/refinement.ts:123</a></em></p> <p>Returns if a given value is a refinement type.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>IT</strong>: <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> @@ -2546,7 +2563,7 @@ <h3><a class="anchor" aria-hidden="true" id="isrefinementtype"></a><a href="#isr <hr> <h3><a class="anchor" aria-hidden="true" id="isroot"></a><a href="#isroot" 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>isRoot</h3> <p>▸ <strong>isRoot</strong>(<code>target</code>: IAnyStateTreeNode): <em>boolean</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L493">src/core/mst-operations.ts:493</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L492">src/core/mst-operations.ts:492</a></em></p> <p>Returns true if the given object is the root of a model tree.</p> <p><strong>Parameters:</strong></p> <table> @@ -2561,7 +2578,7 @@ <h3><a class="anchor" aria-hidden="true" id="isroot"></a><a href="#isroot" aria- <hr> <h3><a class="anchor" aria-hidden="true" id="isstatetreenode"></a><a href="#isstatetreenode" 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>isStateTreeNode</h3> <p>▸ <strong>isStateTreeNode</strong><<strong>IT</strong>>(<code>value</code>: any): <em>value is STNValue<Instance<IT>, IT></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/node/node-utils.ts#L68">src/core/node/node-utils.ts:68</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/node/node-utils.ts#L68">src/core/node/node-utils.ts:68</a></em></p> <p>Returns true if the given value is a node in a state tree. More precisely, that is, if the value is an instance of a <code>types.model</code>, <code>types.array</code> or <code>types.map</code>.</p> @@ -2581,7 +2598,7 @@ <h3><a class="anchor" aria-hidden="true" id="isstatetreenode"></a><a href="#isst <hr> <h3><a class="anchor" aria-hidden="true" id="istype"></a><a href="#istype" 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>isType</h3> <p>▸ <strong>isType</strong>(<code>value</code>: any): <em>value is IAnyType</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L538">src/core/type/type.ts:538</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L538">src/core/type/type.ts:538</a></em></p> <p>Returns if a given value represents a type.</p> <p><strong>Parameters:</strong></p> <table> @@ -2597,7 +2614,7 @@ <h3><a class="anchor" aria-hidden="true" id="istype"></a><a href="#istype" aria- <hr> <h3><a class="anchor" aria-hidden="true" id="isuniontype"></a><a href="#isuniontype" 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>isUnionType</h3> <p>▸ <strong>isUnionType</strong><<strong>IT</strong>>(<code>type</code>: IT): <em>type is IT</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L280">src/types/utility-types/union.ts:280</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/union.ts#L203">src/types/utility-types/union.ts:203</a></em></p> <p>Returns if a given value represents a union type.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>IT</strong>: <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> @@ -2614,7 +2631,7 @@ <h3><a class="anchor" aria-hidden="true" id="isuniontype"></a><a href="#isuniont <hr> <h3><a class="anchor" aria-hidden="true" id="isvalidreference"></a><a href="#isvalidreference" 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>isValidReference</h3> <p>▸ <strong>isValidReference</strong><<strong>N</strong>>(<code>getter</code>: function, <code>checkIfAlive</code>: boolean): <em>boolean</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L597">src/core/mst-operations.ts:597</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L596">src/core/mst-operations.ts:596</a></em></p> <p>Tests if a reference is valid (pointing to an existing node and optionally if alive) and returns if the check passes or not.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>N</strong>: <em>IAnyStateTreeNode</em></p> @@ -2628,7 +2645,7 @@ <h3><a class="anchor" aria-hidden="true" id="isvalidreference"></a><a href="#isv <hr> <h3><a class="anchor" aria-hidden="true" id="joinjsonpath"></a><a href="#joinjsonpath" 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>joinJsonPath</h3> <p>▸ <strong>joinJsonPath</strong>(<code>path</code>: string[]): <em>string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L98">src/core/json-patch.ts:98</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L99">src/core/json-patch.ts:99</a></em></p> <p>Generates a json-path compliant json path from path parts.</p> <p><strong>Parameters:</strong></p> <table> @@ -2643,7 +2660,7 @@ <h3><a class="anchor" aria-hidden="true" id="joinjsonpath"></a><a href="#joinjso <hr> <h3><a class="anchor" aria-hidden="true" id="late"></a><a href="#late" 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>late</h3> <p>▸ <strong>late</strong><<strong>T</strong>>(<code>type</code>: function): <em>T</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/late.ts#L99">src/types/utility-types/late.ts:99</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/late.ts#L103">src/types/utility-types/late.ts:103</a></em></p> <p><code>types.late</code> - Defines a type that gets implemented later. This is useful when you have to deal with circular dependencies. Please notice that when defining circular dependencies TypeScript isn't smart enough to inference them.</p> <p>Example:</p> @@ -2660,7 +2677,7 @@ <h3><a class="anchor" aria-hidden="true" id="late"></a><a href="#late" aria-hidd <p>▸ (): <em>T</em></p> <p><strong>Returns:</strong> <em>T</em></p> <p>▸ <strong>late</strong><<strong>T</strong>>(<code>name</code>: string, <code>type</code>: function): <em>T</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/late.ts#L100">src/types/utility-types/late.ts:100</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/late.ts#L104">src/types/utility-types/late.ts:104</a></em></p> <p><code>types.late</code> - Defines a type that gets implemented later. This is useful when you have to deal with circular dependencies. Please notice that when defining circular dependencies TypeScript isn't smart enough to inference them.</p> <p>Example:</p> @@ -2681,7 +2698,7 @@ <h3><a class="anchor" aria-hidden="true" id="late"></a><a href="#late" aria-hidd <hr> <h3><a class="anchor" aria-hidden="true" id="lazy"></a><a href="#lazy" 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>lazy</h3> <p>▸ <strong>lazy</strong><<strong>T</strong>, <strong>U</strong>>(<code>name</code>: string, <code>options</code>: LazyOptions‹T, U›): <em>T</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/lazy.ts#L22">src/types/utility-types/lazy.ts:22</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/lazy.ts#L22">src/types/utility-types/lazy.ts:22</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>T</strong>: <em><a href="/API/interfaces/itype">IType</a>‹any, any, any›</em></p> <p>▪ <strong>U</strong></p> @@ -2699,7 +2716,7 @@ <h3><a class="anchor" aria-hidden="true" id="lazy"></a><a href="#lazy" aria-hidd <hr> <h3><a class="anchor" aria-hidden="true" id="literal"></a><a href="#literal" 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>literal</h3> <p>▸ <strong>literal</strong><<strong>S</strong>>(<code>value</code>: S): <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹S›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/literal.ts#L69">src/types/utility-types/literal.ts:69</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/literal.ts#L68">src/types/utility-types/literal.ts:68</a></em></p> <p><code>types.literal</code> - The literal type will return a type that will match only the exact given type. The given value must be a primitive, in order to be serialized to a snapshot correctly. You can use literal to match exact strings for example the exact male or female string.</p> @@ -2724,7 +2741,7 @@ <h3><a class="anchor" aria-hidden="true" id="literal"></a><a href="#literal" ari <hr> <h3><a class="anchor" aria-hidden="true" id="map"></a><a href="#map" 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>map</h3> <p>▸ <strong>map</strong><<strong>IT</strong>>(<code>subtype</code>: IT): <em>IMapType‹IT›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/map.ts#L502">src/types/complex-types/map.ts:502</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/map.ts#L502">src/types/complex-types/map.ts:502</a></em></p> <p><code>types.map</code> - Creates a key based collection type who's children are all of a uniform declared type. If the type stored in a map has an identifier, it is mandatory to store the child under that identifier in the map.</p> <p>This type will always produce <a href="https://mobx.js.org/api.html#observablemap">observable maps</a></p> @@ -2759,7 +2776,7 @@ <h3><a class="anchor" aria-hidden="true" id="map"></a><a href="#map" aria-hidden <hr> <h3><a class="anchor" aria-hidden="true" id="maybe"></a><a href="#maybe" 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>maybe</h3> <p>▸ <strong>maybe</strong><<strong>IT</strong>>(<code>type</code>: IT): <em>IMaybe‹IT›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/maybe.ts#L31">src/types/utility-types/maybe.ts:31</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/maybe.ts#L31">src/types/utility-types/maybe.ts:31</a></em></p> <p><code>types.maybe</code> - Maybe will make a type nullable, and also optional. The value <code>undefined</code> will be used to represent nullability.</p> <p><strong>Type parameters:</strong></p> @@ -2777,7 +2794,7 @@ <h3><a class="anchor" aria-hidden="true" id="maybe"></a><a href="#maybe" aria-hi <hr> <h3><a class="anchor" aria-hidden="true" id="maybenull"></a><a href="#maybenull" 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>maybeNull</h3> <p>▸ <strong>maybeNull</strong><<strong>IT</strong>>(<code>type</code>: IT): <em>IMaybeNull‹IT›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/maybe.ts#L44">src/types/utility-types/maybe.ts:44</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/maybe.ts#L44">src/types/utility-types/maybe.ts:44</a></em></p> <p><code>types.maybeNull</code> - Maybe will make a type nullable, and also optional. The value <code>null</code> will be used to represent no value.</p> <p><strong>Type parameters:</strong></p> @@ -2795,7 +2812,7 @@ <h3><a class="anchor" aria-hidden="true" id="maybenull"></a><a href="#maybenull" <hr> <h3><a class="anchor" aria-hidden="true" id="model"></a><a href="#model" 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>model</h3> <p>▸ <strong>model</strong><<strong>P</strong>>(<code>name</code>: string, <code>properties?</code>: <a href="undefined">P</a>): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹ModelPropertiesDeclarationToProperties‹P›, __type›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L743">src/types/complex-types/model.ts:743</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L738">src/types/complex-types/model.ts:738</a></em></p> <p><code>types.model</code> - Creates a new model type by providing a name, properties, volatile state and actions.</p> <p>See the <a href="/concepts/trees#creating-models">model type</a> description or the <a href="/intro/getting-started#getting-started-1">getting started</a> tutorial.</p> <p><strong>Type parameters:</strong></p> @@ -2812,7 +2829,7 @@ <h3><a class="anchor" aria-hidden="true" id="model"></a><a href="#model" aria-hi </table> <p><strong>Returns:</strong> <em><a href="/API/interfaces/imodeltype">IModelType</a>‹ModelPropertiesDeclarationToProperties‹P›, __type›</em></p> <p>▸ <strong>model</strong><<strong>P</strong>>(<code>properties?</code>: <a href="undefined">P</a>): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹ModelPropertiesDeclarationToProperties‹P›, __type›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L747">src/types/complex-types/model.ts:747</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L742">src/types/complex-types/model.ts:742</a></em></p> <p><code>types.model</code> - Creates a new model type by providing a name, properties, volatile state and actions.</p> <p>See the <a href="/concepts/trees#creating-models">model type</a> description or the <a href="/intro/getting-started#getting-started-1">getting started</a> tutorial.</p> <p><strong>Type parameters:</strong></p> @@ -2830,7 +2847,7 @@ <h3><a class="anchor" aria-hidden="true" id="model"></a><a href="#model" aria-hi <hr> <h3><a class="anchor" aria-hidden="true" id="onaction"></a><a href="#onaction" 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>onAction</h3> <p>▸ <strong>onAction</strong>(<code>target</code>: IAnyStateTreeNode, <code>listener</code>: function, <code>attachAfter</code>: boolean): <em><a href="/API/#idisposer">IDisposer</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L225">src/middlewares/on-action.ts:225</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L225">src/middlewares/on-action.ts:225</a></em></p> <p>Registers a function that will be invoked for each action that is called on the provided model instance, or to any of its children. See <a href="https://github.com/mobxjs/mobx-state-tree#actions">actions</a> for more details. onAction events are emitted only for the outermost called action in the stack. Action can also be intercepted by middleware using addMiddleware to change the function call before it will be run.</p> @@ -2878,7 +2895,7 @@ <h3><a class="anchor" aria-hidden="true" id="onaction"></a><a href="#onaction" a <hr> <h3><a class="anchor" aria-hidden="true" id="onpatch"></a><a href="#onpatch" 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>onPatch</h3> <p>▸ <strong>onPatch</strong>(<code>target</code>: IAnyStateTreeNode, <code>callback</code>: function): <em><a href="/API/#idisposer">IDisposer</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L84">src/core/mst-operations.ts:84</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L83">src/core/mst-operations.ts:83</a></em></p> <p>Registers a function that will be invoked for each mutation that is applied to the provided model instance, or to any of its children. See <a href="https://github.com/mobxjs/mobx-state-tree#patches">patches</a> for more details. onPatch events are emitted immediately and will not await the end of a transaction. Patches can be used to deeply observe a model tree.</p> @@ -2903,7 +2920,7 @@ <h3><a class="anchor" aria-hidden="true" id="onpatch"></a><a href="#onpatch" ari <hr> <h3><a class="anchor" aria-hidden="true" id="onsnapshot"></a><a href="#onsnapshot" 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>onSnapshot</h3> <p>▸ <strong>onSnapshot</strong><<strong>S</strong>>(<code>target</code>: IStateTreeNode‹<a href="/API/interfaces/itype">IType</a>‹any, S, any››, <code>callback</code>: function): <em><a href="/API/#idisposer">IDisposer</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L104">src/core/mst-operations.ts:104</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L103">src/core/mst-operations.ts:103</a></em></p> <p>Registers a function that is invoked whenever a new snapshot for the given model instance is available. The listener will only be fire at the end of the current MobX (trans)action. See <a href="https://github.com/mobxjs/mobx-state-tree#snapshots">snapshots</a> for more details.</p> @@ -2925,8 +2942,8 @@ <h3><a class="anchor" aria-hidden="true" id="onsnapshot"></a><a href="#onsnapsho <p><strong>Returns:</strong> <em><a href="/API/#idisposer">IDisposer</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional"></a><a href="#optional" 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>optional</h3> -<p>▸ <strong>optional</strong><<strong>IT</strong>>(<code>type</code>: IT, <code>defaultValueOrFunction</code>: OptionalDefaultValueOrFunction‹IT›): <em>IOptionalIType‹IT, [undefined]›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/optional.ts#L155">src/types/utility-types/optional.ts:155</a></em></p> +<p>▸ <strong>optional</strong><<strong>IT</strong>>(<code>type</code>: IT, <code>defaultValueOrFunction</code>: OptionalDefaultValueOrFunction‹IT›): <em>IOptionalIType‹IT, []›</em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/optional.ts#L155">src/types/utility-types/optional.ts:155</a></em></p> <p><code>types.optional</code> - Can be used to create a property with a default value.</p> <p>Depending on the third argument (<code>optionalValues</code>) there are two ways of operation:</p> <ul> @@ -2970,9 +2987,9 @@ <h3><a class="anchor" aria-hidden="true" id="optional"></a><a href="#optional" a <tr><td><code>defaultValueOrFunction</code></td><td>OptionalDefaultValueOrFunction‹IT›</td></tr> </tbody> </table> -<p><strong>Returns:</strong> <em>IOptionalIType‹IT, [undefined]›</em></p> +<p><strong>Returns:</strong> <em>IOptionalIType‹IT, []›</em></p> <p>▸ <strong>optional</strong><<strong>IT</strong>, <strong>OptionalVals</strong>>(<code>type</code>: IT, <code>defaultValueOrFunction</code>: OptionalDefaultValueOrFunction‹IT›, <code>optionalValues</code>: OptionalVals): <em>IOptionalIType‹IT, OptionalVals›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/optional.ts#L159">src/types/utility-types/optional.ts:159</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/optional.ts#L159">src/types/utility-types/optional.ts:159</a></em></p> <p><code>types.optional</code> - Can be used to create a property with a default value.</p> <p>Depending on the third argument (<code>optionalValues</code>) there are two ways of operation:</p> <ul> @@ -3022,7 +3039,7 @@ <h3><a class="anchor" aria-hidden="true" id="optional"></a><a href="#optional" a <hr> <h3><a class="anchor" aria-hidden="true" id="protect"></a><a href="#protect" 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>protect</h3> <p>▸ <strong>protect</strong>(<code>target</code>: IAnyStateTreeNode): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L266">src/core/mst-operations.ts:266</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L265">src/core/mst-operations.ts:265</a></em></p> <p>The inverse of <code>unprotect</code>.</p> <p><strong>Parameters:</strong></p> <table> @@ -3037,7 +3054,7 @@ <h3><a class="anchor" aria-hidden="true" id="protect"></a><a href="#protect" ari <hr> <h3><a class="anchor" aria-hidden="true" id="recordactions"></a><a href="#recordactions" 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>recordActions</h3> <p>▸ <strong>recordActions</strong>(<code>subject</code>: IAnyStateTreeNode, <code>filter?</code>: undefined | function): <em><a href="/API/interfaces/iactionrecorder">IActionRecorder</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L147">src/middlewares/on-action.ts:147</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L147">src/middlewares/on-action.ts:147</a></em></p> <p>Small abstraction around <code>onAction</code> and <code>applyAction</code>, attaches an action listener to a tree and records all the actions emitted. Returns an recorder object with the following signature:</p> <p>Example:</p> @@ -3069,7 +3086,7 @@ <h3><a class="anchor" aria-hidden="true" id="recordactions"></a><a href="#record <hr> <h3><a class="anchor" aria-hidden="true" id="recordpatches"></a><a href="#recordpatches" 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>recordPatches</h3> <p>▸ <strong>recordPatches</strong>(<code>subject</code>: IAnyStateTreeNode, <code>filter?</code>: undefined | function): <em><a href="/API/interfaces/ipatchrecorder">IPatchRecorder</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L178">src/core/mst-operations.ts:178</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L177">src/core/mst-operations.ts:177</a></em></p> <p>Small abstraction around <code>onPatch</code> and <code>applyPatch</code>, attaches a patch listener to a tree and records all the patches. Returns a recorder object with the following signature:</p> <p>Example:</p> @@ -3106,7 +3123,7 @@ <h3><a class="anchor" aria-hidden="true" id="recordpatches"></a><a href="#record <hr> <h3><a class="anchor" aria-hidden="true" id="reference"></a><a href="#reference" 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>reference</h3> <p>▸ <strong>reference</strong><<strong>IT</strong>>(<code>subType</code>: IT, <code>options?</code>: <a href="/API/#referenceoptions">ReferenceOptions</a>‹IT›): <em>IReferenceType‹IT›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/reference.ts#L464">src/types/utility-types/reference.ts:464</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/reference.ts#L464">src/types/utility-types/reference.ts:464</a></em></p> <p><code>types.reference</code> - Creates a reference to another type, which should have defined an identifier. See also the <a href="https://github.com/mobxjs/mobx-state-tree#references-and-identifiers">reference and identifiers</a> section.</p> <p><strong>Type parameters:</strong></p> @@ -3125,7 +3142,7 @@ <h3><a class="anchor" aria-hidden="true" id="reference"></a><a href="#reference" <hr> <h3><a class="anchor" aria-hidden="true" id="refinement"></a><a href="#refinement" 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>refinement</h3> <p>▸ <strong>refinement</strong><<strong>IT</strong>>(<code>name</code>: string, <code>type</code>: IT, <code>predicate</code>: function, <code>message?</code>: string | function): <em>IT</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/refinement.ts#L84">src/types/utility-types/refinement.ts:84</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/refinement.ts#L83">src/types/utility-types/refinement.ts:83</a></em></p> <p><code>types.refinement</code> - Creates a type that is more specific than the base type, e.g. <code>types.refinement(types.string, value => value.length > 5)</code> to create a type of strings that can only be longer then 5.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>IT</strong>: <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> @@ -3146,7 +3163,7 @@ <h3><a class="anchor" aria-hidden="true" id="refinement"></a><a href="#refinemen <p>▪<code>Optional</code> <strong>message</strong>: <em>string | function</em></p> <p><strong>Returns:</strong> <em>IT</em></p> <p>▸ <strong>refinement</strong><<strong>IT</strong>>(<code>type</code>: IT, <code>predicate</code>: function, <code>message?</code>: string | function): <em>IT</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/refinement.ts#L90">src/types/utility-types/refinement.ts:90</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/refinement.ts#L89">src/types/utility-types/refinement.ts:89</a></em></p> <p><code>types.refinement</code> - Creates a type that is more specific than the base type, e.g. <code>types.refinement(types.string, value => value.length > 5)</code> to create a type of strings that can only be longer then 5.</p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>IT</strong>: <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> @@ -3168,7 +3185,7 @@ <h3><a class="anchor" aria-hidden="true" id="refinement"></a><a href="#refinemen <hr> <h3><a class="anchor" aria-hidden="true" id="resolveidentifier"></a><a href="#resolveidentifier" 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>resolveIdentifier</h3> <p>▸ <strong>resolveIdentifier</strong><<strong>IT</strong>>(<code>type</code>: IT, <code>target</code>: IAnyStateTreeNode, <code>identifier</code>: <a href="/API/#referenceidentifier">ReferenceIdentifier</a>): <em>IT["Type"] | undefined</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L526">src/core/mst-operations.ts:526</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L525">src/core/mst-operations.ts:525</a></em></p> <p>Resolves a model instance given a root target, the type and the identifier you are searching for. Returns undefined if no value can be found.</p> <p><strong>Type parameters:</strong></p> @@ -3188,7 +3205,7 @@ <h3><a class="anchor" aria-hidden="true" id="resolveidentifier"></a><a href="#re <hr> <h3><a class="anchor" aria-hidden="true" id="resolvepath"></a><a href="#resolvepath" 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>resolvePath</h3> <p>▸ <strong>resolvePath</strong>(<code>target</code>: IAnyStateTreeNode, <code>path</code>: string): <em>any</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L508">src/core/mst-operations.ts:508</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L507">src/core/mst-operations.ts:507</a></em></p> <p>Resolves a path relatively to a given object. Returns undefined if no value can be found.</p> <p><strong>Parameters:</strong></p> @@ -3205,7 +3222,7 @@ <h3><a class="anchor" aria-hidden="true" id="resolvepath"></a><a href="#resolvep <hr> <h3><a class="anchor" aria-hidden="true" id="safereference"></a><a href="#safereference" 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>safeReference</h3> <p>▸ <strong>safeReference</strong><<strong>IT</strong>>(<code>subType</code>: IT, <code>options</code>: __type | <a href="/API/interfaces/referenceoptionsgetset">ReferenceOptionsGetSet</a>‹IT› & object): <em>IReferenceType‹IT›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/reference.ts#L513">src/types/utility-types/reference.ts:513</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/reference.ts#L515">src/types/utility-types/reference.ts:515</a></em></p> <p><code>types.safeReference</code> - A safe reference is like a standard reference, except that it accepts the undefined value by default and automatically sets itself to undefined (when the parent is a model) / removes itself from arrays and maps when the reference it is pointing to gets detached/destroyed.</p> @@ -3230,7 +3247,7 @@ <h3><a class="anchor" aria-hidden="true" id="safereference"></a><a href="#safere </table> <p><strong>Returns:</strong> <em>IReferenceType‹IT›</em></p> <p>▸ <strong>safeReference</strong><<strong>IT</strong>>(<code>subType</code>: IT, <code>options?</code>: __type | <a href="/API/interfaces/referenceoptionsgetset">ReferenceOptionsGetSet</a>‹IT› & object): <em>IMaybe‹IReferenceType‹IT››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/reference.ts#L520">src/types/utility-types/reference.ts:520</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/reference.ts#L522">src/types/utility-types/reference.ts:522</a></em></p> <p><code>types.safeReference</code> - A safe reference is like a standard reference, except that it accepts the undefined value by default and automatically sets itself to undefined (when the parent is a model) / removes itself from arrays and maps when the reference it is pointing to gets detached/destroyed.</p> @@ -3257,7 +3274,7 @@ <h3><a class="anchor" aria-hidden="true" id="safereference"></a><a href="#safere <hr> <h3><a class="anchor" aria-hidden="true" id="setlivelinesschecking"></a><a href="#setlivelinesschecking" 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>setLivelinessChecking</h3> <p>▸ <strong>setLivelinessChecking</strong>(<code>mode</code>: <a href="/API/#livelinessmode">LivelinessMode</a>): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/node/livelinessChecking.ts#L18">src/core/node/livelinessChecking.ts:18</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/node/livelinessChecking.ts#L18">src/core/node/livelinessChecking.ts:18</a></em></p> <p>Defines what MST should do when running into reads / writes to objects that have died. By default it will print a warning. Use the <code>"error"</code> option to easy debugging to see where the error was thrown and when the offending read / write took place</p> @@ -3274,7 +3291,7 @@ <h3><a class="anchor" aria-hidden="true" id="setlivelinesschecking"></a><a href= <hr> <h3><a class="anchor" aria-hidden="true" id="snapshotprocessor"></a><a href="#snapshotprocessor" 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>snapshotProcessor</h3> <p>▸ <strong>snapshotProcessor</strong><<strong>IT</strong>, <strong>CustomC</strong>, <strong>CustomS</strong>>(<code>type</code>: IT, <code>processors</code>: <a href="/API/interfaces/isnapshotprocessors">ISnapshotProcessors</a>‹IT, CustomC, CustomS›, <code>name?</code>: undefined | string): <em><a href="/API/interfaces/isnapshotprocessor">ISnapshotProcessor</a>‹IT, CustomC, CustomS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/snapshotProcessor.ts#L247">src/types/utility-types/snapshotProcessor.ts:247</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/snapshotProcessor.ts#L247">src/types/utility-types/snapshotProcessor.ts:247</a></em></p> <p><code>types.snapshotProcessor</code> - Runs a pre/post snapshot processor before/after serializing a given type.</p> <p>Example:</p> <pre><code class="hljs css language-ts"><span class="hljs-keyword">const</span> Todo1 = types.model({ text: types.string }) @@ -3318,7 +3335,7 @@ <h3><a class="anchor" aria-hidden="true" id="snapshotprocessor"></a><a href="#sn <hr> <h3><a class="anchor" aria-hidden="true" id="splitjsonpath"></a><a href="#splitjsonpath" 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>splitJsonPath</h3> <p>▸ <strong>splitJsonPath</strong>(<code>path</code>: string): <em>string[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L118">src/core/json-patch.ts:118</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L119">src/core/json-patch.ts:119</a></em></p> <p>Splits and decodes a json path into several parts.</p> <p><strong>Parameters:</strong></p> <table> @@ -3333,7 +3350,7 @@ <h3><a class="anchor" aria-hidden="true" id="splitjsonpath"></a><a href="#splitj <hr> <h3><a class="anchor" aria-hidden="true" id="togenerator"></a><a href="#togenerator" 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>toGenerator</h3> <p>▸ <strong>toGenerator</strong><<strong>R</strong>>(<code>p</code>: Promise‹R›): <em>Generator‹Promise‹R›, R, R›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/flow.ts#L87">src/core/flow.ts:87</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/flow.ts#L87">src/core/flow.ts:87</a></em></p> <p><strong><code>experimental</code></strong> experimental api - might change on minor/patch releases</p> <p>Convert a promise to a generator yielding that promise @@ -3365,7 +3382,7 @@ <h3><a class="anchor" aria-hidden="true" id="togenerator"></a><a href="#togenera <hr> <h3><a class="anchor" aria-hidden="true" id="togeneratorfunction"></a><a href="#togeneratorfunction" 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>toGeneratorFunction</h3> <p>▸ <strong>toGeneratorFunction</strong><<strong>R</strong>, <strong>Args</strong>>(<code>p</code>: function): <em>(Anonymous function)</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/flow.ts#L60">src/core/flow.ts:60</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/flow.ts#L60">src/core/flow.ts:60</a></em></p> <p><strong><code>experimental</code></strong> experimental api - might change on minor/patch releases</p> <p>Convert a promise-returning function to a generator-returning one. @@ -3402,7 +3419,7 @@ <h3><a class="anchor" aria-hidden="true" id="togeneratorfunction"></a><a href="# <hr> <h3><a class="anchor" aria-hidden="true" id="tryreference"></a><a href="#tryreference" 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>tryReference</h3> <p>▸ <strong>tryReference</strong><<strong>N</strong>>(<code>getter</code>: function, <code>checkIfAlive</code>: boolean): <em>N | undefined</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L565">src/core/mst-operations.ts:565</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L564">src/core/mst-operations.ts:564</a></em></p> <p>Tests if a reference is valid (pointing to an existing node and optionally if alive) and returns such reference if the check passes, else it returns undefined.</p> <p><strong>Type parameters:</strong></p> @@ -3417,7 +3434,7 @@ <h3><a class="anchor" aria-hidden="true" id="tryreference"></a><a href="#tryrefe <hr> <h3><a class="anchor" aria-hidden="true" id="tryresolve"></a><a href="#tryresolve" 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>tryResolve</h3> <p>▸ <strong>tryResolve</strong>(<code>target</code>: IAnyStateTreeNode, <code>path</code>: string): <em>any</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L625">src/core/mst-operations.ts:625</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L624">src/core/mst-operations.ts:624</a></em></p> <p>Try to resolve a given path relative to a given node.</p> <p><strong>Parameters:</strong></p> <table> @@ -3433,7 +3450,7 @@ <h3><a class="anchor" aria-hidden="true" id="tryresolve"></a><a href="#tryresolv <hr> <h3><a class="anchor" aria-hidden="true" id="typecheck"></a><a href="#typecheck" 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>typecheck</h3> <p>▸ <strong>typecheck</strong><<strong>IT</strong>>(<code>type</code>: IT, <code>value</code>: ExtractCSTWithSTN‹IT›): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type-checker.ts#L164">src/core/type/type-checker.ts:164</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type-checker.ts#L164">src/core/type/type-checker.ts:164</a></em></p> <p>Run's the typechecker for the given type on the given value, which can be a snapshot or an instance. Throws if the given value is not according the provided type specification. Use this if you need typechecks even in a production build (by default all automatic runtime type checks will be skipped in production builds)</p> @@ -3453,7 +3470,7 @@ <h3><a class="anchor" aria-hidden="true" id="typecheck"></a><a href="#typecheck" <hr> <h3><a class="anchor" aria-hidden="true" id="unescapejsonpath"></a><a href="#unescapejsonpath" 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>unescapeJsonPath</h3> <p>▸ <strong>unescapeJsonPath</strong>(<code>path</code>: string): <em>string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L88">src/core/json-patch.ts:88</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L89">src/core/json-patch.ts:89</a></em></p> <p>Unescape slashes and backslashes.</p> <p><strong>Parameters:</strong></p> <table> @@ -3467,239 +3484,26 @@ <h3><a class="anchor" aria-hidden="true" id="unescapejsonpath"></a><a href="#une <p><strong>Returns:</strong> <em>string</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="union"></a><a href="#union" 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>union</h3> -<p>▸ <strong>union</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>>(<code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›): <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L157">src/types/utility-types/union.ts:157</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>PA</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OA</strong></p> -<p>▪ <strong>FCA</strong></p> -<p>▪ <strong>FSA</strong></p> -<p>▪ <strong>PB</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OB</strong></p> -<p>▪ <strong>FCB</strong></p> -<p>▪ <strong>FSB</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>A</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB››</em></p> -<p>▸ <strong>union</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, <code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›): <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L159">src/types/utility-types/union.ts:159</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>PA</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OA</strong></p> -<p>▪ <strong>FCA</strong></p> -<p>▪ <strong>FSA</strong></p> -<p>▪ <strong>PB</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OB</strong></p> -<p>▪ <strong>FCB</strong></p> -<p>▪ <strong>FSB</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>options</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a></td></tr> -<tr><td><code>A</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB››</em></p> -<p>▸ <strong>union</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>>(<code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›): <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L162">src/types/utility-types/union.ts:162</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>PA</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OA</strong></p> -<p>▪ <strong>FCA</strong></p> -<p>▪ <strong>FSA</strong></p> -<p>▪ <strong>PB</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OB</strong></p> -<p>▪ <strong>FCB</strong></p> -<p>▪ <strong>FSB</strong></p> -<p>▪ <strong>PC</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OC</strong></p> -<p>▪ <strong>FCC</strong></p> -<p>▪ <strong>FSC</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>A</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC››</em></p> -<p>▸ <strong>union</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, <code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›): <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L164">src/types/utility-types/union.ts:164</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>PA</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OA</strong></p> -<p>▪ <strong>FCA</strong></p> -<p>▪ <strong>FSA</strong></p> -<p>▪ <strong>PB</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OB</strong></p> -<p>▪ <strong>FCB</strong></p> -<p>▪ <strong>FSB</strong></p> -<p>▪ <strong>PC</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OC</strong></p> -<p>▪ <strong>FCC</strong></p> -<p>▪ <strong>FSC</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>options</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a></td></tr> -<tr><td><code>A</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC››</em></p> -<p>▸ <strong>union</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>>(<code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›): <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L166">src/types/utility-types/union.ts:166</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>PA</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OA</strong></p> -<p>▪ <strong>FCA</strong></p> -<p>▪ <strong>FSA</strong></p> -<p>▪ <strong>PB</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OB</strong></p> -<p>▪ <strong>FCB</strong></p> -<p>▪ <strong>FSB</strong></p> -<p>▪ <strong>PC</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OC</strong></p> -<p>▪ <strong>FCC</strong></p> -<p>▪ <strong>FSC</strong></p> -<p>▪ <strong>PD</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OD</strong></p> -<p>▪ <strong>FCD</strong></p> -<p>▪ <strong>FSD</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>A</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD››</em></p> -<p>▸ <strong>union</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, <code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›): <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L169">src/types/utility-types/union.ts:169</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>PA</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OA</strong></p> -<p>▪ <strong>FCA</strong></p> -<p>▪ <strong>FSA</strong></p> -<p>▪ <strong>PB</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OB</strong></p> -<p>▪ <strong>FCB</strong></p> -<p>▪ <strong>FSB</strong></p> -<p>▪ <strong>PC</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OC</strong></p> -<p>▪ <strong>FCC</strong></p> -<p>▪ <strong>FSC</strong></p> -<p>▪ <strong>PD</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OD</strong></p> -<p>▪ <strong>FCD</strong></p> -<p>▪ <strong>FSD</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>options</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a></td></tr> -<tr><td><code>A</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD››</em></p> -<p>▸ <strong>union</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>>(<code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›): <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L172">src/types/utility-types/union.ts:172</a></em></p> +<p>▸ <strong>union</strong><<strong>Types</strong>>(...<code>types</code>: Types): <em>IUnionType‹Types›</em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/union.ts#L160">src/types/utility-types/union.ts:160</a></em></p> <p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> <p><strong>Type parameters:</strong></p> -<p>▪ <strong>PA</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OA</strong></p> -<p>▪ <strong>FCA</strong></p> -<p>▪ <strong>FSA</strong></p> -<p>▪ <strong>PB</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OB</strong></p> -<p>▪ <strong>FCB</strong></p> -<p>▪ <strong>FSB</strong></p> -<p>▪ <strong>PC</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OC</strong></p> -<p>▪ <strong>FCC</strong></p> -<p>▪ <strong>FSC</strong></p> -<p>▪ <strong>PD</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OD</strong></p> -<p>▪ <strong>FCD</strong></p> -<p>▪ <strong>FSD</strong></p> -<p>▪ <strong>PE</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OE</strong></p> -<p>▪ <strong>FCE</strong></p> -<p>▪ <strong>FSE</strong></p> +<p>▪ <strong>Types</strong>: <em><a href="/API/interfaces/ianytype">IAnyType</a>[]</em></p> <p><strong>Parameters:</strong></p> <table> <thead> <tr><th>Name</th><th>Type</th></tr> </thead> <tbody> -<tr><td><code>A</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›</td></tr> +<tr><td><code>...types</code></td><td>Types</td></tr> </tbody> </table> -<p><strong>Returns:</strong> <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE››</em></p> -<p>▸ <strong>union</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, <code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›): <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L175">src/types/utility-types/union.ts:175</a></em></p> +<p><strong>Returns:</strong> <em>IUnionType‹Types›</em></p> +<p>▸ <strong>union</strong><<strong>Types</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, ...<code>types</code>: Types): <em>IUnionType‹Types›</em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/union.ts#L161">src/types/utility-types/union.ts:161</a></em></p> <p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> <p><strong>Type parameters:</strong></p> -<p>▪ <strong>PA</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OA</strong></p> -<p>▪ <strong>FCA</strong></p> -<p>▪ <strong>FSA</strong></p> -<p>▪ <strong>PB</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OB</strong></p> -<p>▪ <strong>FCB</strong></p> -<p>▪ <strong>FSB</strong></p> -<p>▪ <strong>PC</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OC</strong></p> -<p>▪ <strong>FCC</strong></p> -<p>▪ <strong>FSC</strong></p> -<p>▪ <strong>PD</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OD</strong></p> -<p>▪ <strong>FCD</strong></p> -<p>▪ <strong>FSD</strong></p> -<p>▪ <strong>PE</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OE</strong></p> -<p>▪ <strong>FCE</strong></p> -<p>▪ <strong>FSE</strong></p> +<p>▪ <strong>Types</strong>: <em><a href="/API/interfaces/ianytype">IAnyType</a>[]</em></p> <p><strong>Parameters:</strong></p> <table> <thead> @@ -3707,1021 +3511,14 @@ <h3><a class="anchor" aria-hidden="true" id="union"></a><a href="#union" aria-hi </thead> <tbody> <tr><td><code>options</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a></td></tr> -<tr><td><code>A</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›</td></tr> +<tr><td><code>...types</code></td><td>Types</td></tr> </tbody> </table> -<p><strong>Returns:</strong> <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE››</em></p> -<p>▸ <strong>union</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>, <strong>PF</strong>, <strong>OF</strong>, <strong>FCF</strong>, <strong>FSF</strong>>(<code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›, <code>F</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›): <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L178">src/types/utility-types/union.ts:178</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>PA</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OA</strong></p> -<p>▪ <strong>FCA</strong></p> -<p>▪ <strong>FSA</strong></p> -<p>▪ <strong>PB</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OB</strong></p> -<p>▪ <strong>FCB</strong></p> -<p>▪ <strong>FSB</strong></p> -<p>▪ <strong>PC</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OC</strong></p> -<p>▪ <strong>FCC</strong></p> -<p>▪ <strong>FSC</strong></p> -<p>▪ <strong>PD</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OD</strong></p> -<p>▪ <strong>FCD</strong></p> -<p>▪ <strong>FSD</strong></p> -<p>▪ <strong>PE</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OE</strong></p> -<p>▪ <strong>FCE</strong></p> -<p>▪ <strong>FSE</strong></p> -<p>▪ <strong>PF</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OF</strong></p> -<p>▪ <strong>FCF</strong></p> -<p>▪ <strong>FSF</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>A</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›</td></tr> -<tr><td><code>F</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF››</em></p> -<p>▸ <strong>union</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>, <strong>PF</strong>, <strong>OF</strong>, <strong>FCF</strong>, <strong>FSF</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, <code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›, <code>F</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›): <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L181">src/types/utility-types/union.ts:181</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>PA</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OA</strong></p> -<p>▪ <strong>FCA</strong></p> -<p>▪ <strong>FSA</strong></p> -<p>▪ <strong>PB</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OB</strong></p> -<p>▪ <strong>FCB</strong></p> -<p>▪ <strong>FSB</strong></p> -<p>▪ <strong>PC</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OC</strong></p> -<p>▪ <strong>FCC</strong></p> -<p>▪ <strong>FSC</strong></p> -<p>▪ <strong>PD</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OD</strong></p> -<p>▪ <strong>FCD</strong></p> -<p>▪ <strong>FSD</strong></p> -<p>▪ <strong>PE</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OE</strong></p> -<p>▪ <strong>FCE</strong></p> -<p>▪ <strong>FSE</strong></p> -<p>▪ <strong>PF</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OF</strong></p> -<p>▪ <strong>FCF</strong></p> -<p>▪ <strong>FSF</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>options</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a></td></tr> -<tr><td><code>A</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›</td></tr> -<tr><td><code>F</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF››</em></p> -<p>▸ <strong>union</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>, <strong>PF</strong>, <strong>OF</strong>, <strong>FCF</strong>, <strong>FSF</strong>, <strong>PG</strong>, <strong>OG</strong>, <strong>FCG</strong>, <strong>FSG</strong>>(<code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›, <code>F</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›, <code>G</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›): <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L184">src/types/utility-types/union.ts:184</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>PA</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OA</strong></p> -<p>▪ <strong>FCA</strong></p> -<p>▪ <strong>FSA</strong></p> -<p>▪ <strong>PB</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OB</strong></p> -<p>▪ <strong>FCB</strong></p> -<p>▪ <strong>FSB</strong></p> -<p>▪ <strong>PC</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OC</strong></p> -<p>▪ <strong>FCC</strong></p> -<p>▪ <strong>FSC</strong></p> -<p>▪ <strong>PD</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OD</strong></p> -<p>▪ <strong>FCD</strong></p> -<p>▪ <strong>FSD</strong></p> -<p>▪ <strong>PE</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OE</strong></p> -<p>▪ <strong>FCE</strong></p> -<p>▪ <strong>FSE</strong></p> -<p>▪ <strong>PF</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OF</strong></p> -<p>▪ <strong>FCF</strong></p> -<p>▪ <strong>FSF</strong></p> -<p>▪ <strong>PG</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OG</strong></p> -<p>▪ <strong>FCG</strong></p> -<p>▪ <strong>FSG</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>A</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›</td></tr> -<tr><td><code>F</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›</td></tr> -<tr><td><code>G</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG››</em></p> -<p>▸ <strong>union</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>, <strong>PF</strong>, <strong>OF</strong>, <strong>FCF</strong>, <strong>FSF</strong>, <strong>PG</strong>, <strong>OG</strong>, <strong>FCG</strong>, <strong>FSG</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, <code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›, <code>F</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›, <code>G</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›): <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L187">src/types/utility-types/union.ts:187</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>PA</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OA</strong></p> -<p>▪ <strong>FCA</strong></p> -<p>▪ <strong>FSA</strong></p> -<p>▪ <strong>PB</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OB</strong></p> -<p>▪ <strong>FCB</strong></p> -<p>▪ <strong>FSB</strong></p> -<p>▪ <strong>PC</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OC</strong></p> -<p>▪ <strong>FCC</strong></p> -<p>▪ <strong>FSC</strong></p> -<p>▪ <strong>PD</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OD</strong></p> -<p>▪ <strong>FCD</strong></p> -<p>▪ <strong>FSD</strong></p> -<p>▪ <strong>PE</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OE</strong></p> -<p>▪ <strong>FCE</strong></p> -<p>▪ <strong>FSE</strong></p> -<p>▪ <strong>PF</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OF</strong></p> -<p>▪ <strong>FCF</strong></p> -<p>▪ <strong>FSF</strong></p> -<p>▪ <strong>PG</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OG</strong></p> -<p>▪ <strong>FCG</strong></p> -<p>▪ <strong>FSG</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>options</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a></td></tr> -<tr><td><code>A</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›</td></tr> -<tr><td><code>F</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›</td></tr> -<tr><td><code>G</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG››</em></p> -<p>▸ <strong>union</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>, <strong>PF</strong>, <strong>OF</strong>, <strong>FCF</strong>, <strong>FSF</strong>, <strong>PG</strong>, <strong>OG</strong>, <strong>FCG</strong>, <strong>FSG</strong>, <strong>PH</strong>, <strong>OH</strong>, <strong>FCH</strong>, <strong>FSH</strong>>(<code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›, <code>F</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›, <code>G</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›, <code>H</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PH, OH, FCH, FSH›): <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG› | ModelCreationType2‹PH, FCH›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG› | ModelSnapshotType2‹PH, FSH›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG› | ModelInstanceType‹PH, OH››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L191">src/types/utility-types/union.ts:191</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>PA</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OA</strong></p> -<p>▪ <strong>FCA</strong></p> -<p>▪ <strong>FSA</strong></p> -<p>▪ <strong>PB</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OB</strong></p> -<p>▪ <strong>FCB</strong></p> -<p>▪ <strong>FSB</strong></p> -<p>▪ <strong>PC</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OC</strong></p> -<p>▪ <strong>FCC</strong></p> -<p>▪ <strong>FSC</strong></p> -<p>▪ <strong>PD</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OD</strong></p> -<p>▪ <strong>FCD</strong></p> -<p>▪ <strong>FSD</strong></p> -<p>▪ <strong>PE</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OE</strong></p> -<p>▪ <strong>FCE</strong></p> -<p>▪ <strong>FSE</strong></p> -<p>▪ <strong>PF</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OF</strong></p> -<p>▪ <strong>FCF</strong></p> -<p>▪ <strong>FSF</strong></p> -<p>▪ <strong>PG</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OG</strong></p> -<p>▪ <strong>FCG</strong></p> -<p>▪ <strong>FSG</strong></p> -<p>▪ <strong>PH</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OH</strong></p> -<p>▪ <strong>FCH</strong></p> -<p>▪ <strong>FSH</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>A</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›</td></tr> -<tr><td><code>F</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›</td></tr> -<tr><td><code>G</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›</td></tr> -<tr><td><code>H</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PH, OH, FCH, FSH›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG› | ModelCreationType2‹PH, FCH›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG› | ModelSnapshotType2‹PH, FSH›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG› | ModelInstanceType‹PH, OH››</em></p> -<p>▸ <strong>union</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>, <strong>PF</strong>, <strong>OF</strong>, <strong>FCF</strong>, <strong>FSF</strong>, <strong>PG</strong>, <strong>OG</strong>, <strong>FCG</strong>, <strong>FSG</strong>, <strong>PH</strong>, <strong>OH</strong>, <strong>FCH</strong>, <strong>FSH</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, <code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›, <code>F</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›, <code>G</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›, <code>H</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PH, OH, FCH, FSH›): <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG› | ModelCreationType2‹PH, FCH›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG› | ModelSnapshotType2‹PH, FSH›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG› | ModelInstanceType‹PH, OH››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L194">src/types/utility-types/union.ts:194</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>PA</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OA</strong></p> -<p>▪ <strong>FCA</strong></p> -<p>▪ <strong>FSA</strong></p> -<p>▪ <strong>PB</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OB</strong></p> -<p>▪ <strong>FCB</strong></p> -<p>▪ <strong>FSB</strong></p> -<p>▪ <strong>PC</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OC</strong></p> -<p>▪ <strong>FCC</strong></p> -<p>▪ <strong>FSC</strong></p> -<p>▪ <strong>PD</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OD</strong></p> -<p>▪ <strong>FCD</strong></p> -<p>▪ <strong>FSD</strong></p> -<p>▪ <strong>PE</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OE</strong></p> -<p>▪ <strong>FCE</strong></p> -<p>▪ <strong>FSE</strong></p> -<p>▪ <strong>PF</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OF</strong></p> -<p>▪ <strong>FCF</strong></p> -<p>▪ <strong>FSF</strong></p> -<p>▪ <strong>PG</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OG</strong></p> -<p>▪ <strong>FCG</strong></p> -<p>▪ <strong>FSG</strong></p> -<p>▪ <strong>PH</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OH</strong></p> -<p>▪ <strong>FCH</strong></p> -<p>▪ <strong>FSH</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>options</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a></td></tr> -<tr><td><code>A</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›</td></tr> -<tr><td><code>F</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›</td></tr> -<tr><td><code>G</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›</td></tr> -<tr><td><code>H</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PH, OH, FCH, FSH›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG› | ModelCreationType2‹PH, FCH›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG› | ModelSnapshotType2‹PH, FSH›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG› | ModelInstanceType‹PH, OH››</em></p> -<p>▸ <strong>union</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>, <strong>PF</strong>, <strong>OF</strong>, <strong>FCF</strong>, <strong>FSF</strong>, <strong>PG</strong>, <strong>OG</strong>, <strong>FCG</strong>, <strong>FSG</strong>, <strong>PH</strong>, <strong>OH</strong>, <strong>FCH</strong>, <strong>FSH</strong>, <strong>PI</strong>, <strong>OI</strong>, <strong>FCI</strong>, <strong>FSI</strong>>(<code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›, <code>F</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›, <code>G</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›, <code>H</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PH, OH, FCH, FSH›, <code>I</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PI, OI, FCI, FSI›): <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG› | ModelCreationType2‹PH, FCH› | ModelCreationType2‹PI, FCI›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG› | ModelSnapshotType2‹PH, FSH› | ModelSnapshotType2‹PI, FSI›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG› | ModelInstanceType‹PH, OH› | ModelInstanceType‹PI, OI››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L198">src/types/utility-types/union.ts:198</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>PA</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OA</strong></p> -<p>▪ <strong>FCA</strong></p> -<p>▪ <strong>FSA</strong></p> -<p>▪ <strong>PB</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OB</strong></p> -<p>▪ <strong>FCB</strong></p> -<p>▪ <strong>FSB</strong></p> -<p>▪ <strong>PC</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OC</strong></p> -<p>▪ <strong>FCC</strong></p> -<p>▪ <strong>FSC</strong></p> -<p>▪ <strong>PD</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OD</strong></p> -<p>▪ <strong>FCD</strong></p> -<p>▪ <strong>FSD</strong></p> -<p>▪ <strong>PE</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OE</strong></p> -<p>▪ <strong>FCE</strong></p> -<p>▪ <strong>FSE</strong></p> -<p>▪ <strong>PF</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OF</strong></p> -<p>▪ <strong>FCF</strong></p> -<p>▪ <strong>FSF</strong></p> -<p>▪ <strong>PG</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OG</strong></p> -<p>▪ <strong>FCG</strong></p> -<p>▪ <strong>FSG</strong></p> -<p>▪ <strong>PH</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OH</strong></p> -<p>▪ <strong>FCH</strong></p> -<p>▪ <strong>FSH</strong></p> -<p>▪ <strong>PI</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OI</strong></p> -<p>▪ <strong>FCI</strong></p> -<p>▪ <strong>FSI</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>A</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›</td></tr> -<tr><td><code>F</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›</td></tr> -<tr><td><code>G</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›</td></tr> -<tr><td><code>H</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PH, OH, FCH, FSH›</td></tr> -<tr><td><code>I</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PI, OI, FCI, FSI›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG› | ModelCreationType2‹PH, FCH› | ModelCreationType2‹PI, FCI›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG› | ModelSnapshotType2‹PH, FSH› | ModelSnapshotType2‹PI, FSI›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG› | ModelInstanceType‹PH, OH› | ModelInstanceType‹PI, OI››</em></p> -<p>▸ <strong>union</strong><<strong>PA</strong>, <strong>OA</strong>, <strong>FCA</strong>, <strong>FSA</strong>, <strong>PB</strong>, <strong>OB</strong>, <strong>FCB</strong>, <strong>FSB</strong>, <strong>PC</strong>, <strong>OC</strong>, <strong>FCC</strong>, <strong>FSC</strong>, <strong>PD</strong>, <strong>OD</strong>, <strong>FCD</strong>, <strong>FSD</strong>, <strong>PE</strong>, <strong>OE</strong>, <strong>FCE</strong>, <strong>FSE</strong>, <strong>PF</strong>, <strong>OF</strong>, <strong>FCF</strong>, <strong>FSF</strong>, <strong>PG</strong>, <strong>OG</strong>, <strong>FCG</strong>, <strong>FSG</strong>, <strong>PH</strong>, <strong>OH</strong>, <strong>FCH</strong>, <strong>FSH</strong>, <strong>PI</strong>, <strong>OI</strong>, <strong>FCI</strong>, <strong>FSI</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, <code>A</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›, <code>B</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›, <code>C</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›, <code>D</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›, <code>E</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›, <code>F</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›, <code>G</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›, <code>H</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PH, OH, FCH, FSH›, <code>I</code>: <a href="/API/interfaces/imodeltype">IModelType</a>‹PI, OI, FCI, FSI›): <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG› | ModelCreationType2‹PH, FCH› | ModelCreationType2‹PI, FCI›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG› | ModelSnapshotType2‹PH, FSH› | ModelSnapshotType2‹PI, FSI›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG› | ModelInstanceType‹PH, OH› | ModelInstanceType‹PI, OI››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L201">src/types/utility-types/union.ts:201</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>PA</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OA</strong></p> -<p>▪ <strong>FCA</strong></p> -<p>▪ <strong>FSA</strong></p> -<p>▪ <strong>PB</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OB</strong></p> -<p>▪ <strong>FCB</strong></p> -<p>▪ <strong>FSB</strong></p> -<p>▪ <strong>PC</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OC</strong></p> -<p>▪ <strong>FCC</strong></p> -<p>▪ <strong>FSC</strong></p> -<p>▪ <strong>PD</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OD</strong></p> -<p>▪ <strong>FCD</strong></p> -<p>▪ <strong>FSD</strong></p> -<p>▪ <strong>PE</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OE</strong></p> -<p>▪ <strong>FCE</strong></p> -<p>▪ <strong>FSE</strong></p> -<p>▪ <strong>PF</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OF</strong></p> -<p>▪ <strong>FCF</strong></p> -<p>▪ <strong>FSF</strong></p> -<p>▪ <strong>PG</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OG</strong></p> -<p>▪ <strong>FCG</strong></p> -<p>▪ <strong>FSG</strong></p> -<p>▪ <strong>PH</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OH</strong></p> -<p>▪ <strong>FCH</strong></p> -<p>▪ <strong>FSH</strong></p> -<p>▪ <strong>PI</strong>: <em>ModelProperties</em></p> -<p>▪ <strong>OI</strong></p> -<p>▪ <strong>FCI</strong></p> -<p>▪ <strong>FSI</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>options</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a></td></tr> -<tr><td><code>A</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PA, OA, FCA, FSA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PB, OB, FCB, FSB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PC, OC, FCC, FSC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PD, OD, FCD, FSD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PE, OE, FCE, FSE›</td></tr> -<tr><td><code>F</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PF, OF, FCF, FSF›</td></tr> -<tr><td><code>G</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PG, OG, FCG, FSG›</td></tr> -<tr><td><code>H</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PH, OH, FCH, FSH›</td></tr> -<tr><td><code>I</code></td><td><a href="/API/interfaces/imodeltype">IModelType</a>‹PI, OI, FCI, FSI›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG› | ModelCreationType2‹PH, FCH› | ModelCreationType2‹PI, FCI›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG› | ModelSnapshotType2‹PH, FSH› | ModelSnapshotType2‹PI, FSI›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG› | ModelInstanceType‹PH, OH› | ModelInstanceType‹PI, OI››</em></p> -<p>▸ <strong>union</strong><<strong>CA</strong>, <strong>SA</strong>, <strong>TA</strong>, <strong>CB</strong>, <strong>SB</strong>, <strong>TB</strong>>(<code>A</code>: <a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›, <code>B</code>: <a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›): <em>ITypeUnion‹CA | CB, SA | SB, TA | TB›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L205">src/types/utility-types/union.ts:205</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>CA</strong></p> -<p>▪ <strong>SA</strong></p> -<p>▪ <strong>TA</strong></p> -<p>▪ <strong>CB</strong></p> -<p>▪ <strong>SB</strong></p> -<p>▪ <strong>TB</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>A</code></td><td><a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹CA | CB, SA | SB, TA | TB›</em></p> -<p>▸ <strong>union</strong><<strong>CA</strong>, <strong>SA</strong>, <strong>TA</strong>, <strong>CB</strong>, <strong>SB</strong>, <strong>TB</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, <code>A</code>: <a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›, <code>B</code>: <a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›): <em>ITypeUnion‹CA | CB, SA | SB, TA | TB›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L207">src/types/utility-types/union.ts:207</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>CA</strong></p> -<p>▪ <strong>SA</strong></p> -<p>▪ <strong>TA</strong></p> -<p>▪ <strong>CB</strong></p> -<p>▪ <strong>SB</strong></p> -<p>▪ <strong>TB</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>options</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a></td></tr> -<tr><td><code>A</code></td><td><a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹CA | CB, SA | SB, TA | TB›</em></p> -<p>▸ <strong>union</strong><<strong>CA</strong>, <strong>SA</strong>, <strong>TA</strong>, <strong>CB</strong>, <strong>SB</strong>, <strong>TB</strong>, <strong>CC</strong>, <strong>SC</strong>, <strong>TC</strong>>(<code>A</code>: <a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›, <code>B</code>: <a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›, <code>C</code>: <a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›): <em>ITypeUnion‹CA | CB | CC, SA | SB | SC, TA | TB | TC›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L209">src/types/utility-types/union.ts:209</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>CA</strong></p> -<p>▪ <strong>SA</strong></p> -<p>▪ <strong>TA</strong></p> -<p>▪ <strong>CB</strong></p> -<p>▪ <strong>SB</strong></p> -<p>▪ <strong>TB</strong></p> -<p>▪ <strong>CC</strong></p> -<p>▪ <strong>SC</strong></p> -<p>▪ <strong>TC</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>A</code></td><td><a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹CA | CB | CC, SA | SB | SC, TA | TB | TC›</em></p> -<p>▸ <strong>union</strong><<strong>CA</strong>, <strong>SA</strong>, <strong>TA</strong>, <strong>CB</strong>, <strong>SB</strong>, <strong>TB</strong>, <strong>CC</strong>, <strong>SC</strong>, <strong>TC</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, <code>A</code>: <a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›, <code>B</code>: <a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›, <code>C</code>: <a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›): <em>ITypeUnion‹CA | CB | CC, SA | SB | SC, TA | TB | TC›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L211">src/types/utility-types/union.ts:211</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>CA</strong></p> -<p>▪ <strong>SA</strong></p> -<p>▪ <strong>TA</strong></p> -<p>▪ <strong>CB</strong></p> -<p>▪ <strong>SB</strong></p> -<p>▪ <strong>TB</strong></p> -<p>▪ <strong>CC</strong></p> -<p>▪ <strong>SC</strong></p> -<p>▪ <strong>TC</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>options</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a></td></tr> -<tr><td><code>A</code></td><td><a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹CA | CB | CC, SA | SB | SC, TA | TB | TC›</em></p> -<p>▸ <strong>union</strong><<strong>CA</strong>, <strong>SA</strong>, <strong>TA</strong>, <strong>CB</strong>, <strong>SB</strong>, <strong>TB</strong>, <strong>CC</strong>, <strong>SC</strong>, <strong>TC</strong>, <strong>CD</strong>, <strong>SD</strong>, <strong>TD</strong>>(<code>A</code>: <a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›, <code>B</code>: <a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›, <code>C</code>: <a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›, <code>D</code>: <a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›): <em>ITypeUnion‹CA | CB | CC | CD, SA | SB | SC | SD, TA | TB | TC | TD›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L213">src/types/utility-types/union.ts:213</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>CA</strong></p> -<p>▪ <strong>SA</strong></p> -<p>▪ <strong>TA</strong></p> -<p>▪ <strong>CB</strong></p> -<p>▪ <strong>SB</strong></p> -<p>▪ <strong>TB</strong></p> -<p>▪ <strong>CC</strong></p> -<p>▪ <strong>SC</strong></p> -<p>▪ <strong>TC</strong></p> -<p>▪ <strong>CD</strong></p> -<p>▪ <strong>SD</strong></p> -<p>▪ <strong>TD</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>A</code></td><td><a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹CA | CB | CC | CD, SA | SB | SC | SD, TA | TB | TC | TD›</em></p> -<p>▸ <strong>union</strong><<strong>CA</strong>, <strong>SA</strong>, <strong>TA</strong>, <strong>CB</strong>, <strong>SB</strong>, <strong>TB</strong>, <strong>CC</strong>, <strong>SC</strong>, <strong>TC</strong>, <strong>CD</strong>, <strong>SD</strong>, <strong>TD</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, <code>A</code>: <a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›, <code>B</code>: <a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›, <code>C</code>: <a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›, <code>D</code>: <a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›): <em>ITypeUnion‹CA | CB | CC | CD, SA | SB | SC | SD, TA | TB | TC | TD›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L216">src/types/utility-types/union.ts:216</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>CA</strong></p> -<p>▪ <strong>SA</strong></p> -<p>▪ <strong>TA</strong></p> -<p>▪ <strong>CB</strong></p> -<p>▪ <strong>SB</strong></p> -<p>▪ <strong>TB</strong></p> -<p>▪ <strong>CC</strong></p> -<p>▪ <strong>SC</strong></p> -<p>▪ <strong>TC</strong></p> -<p>▪ <strong>CD</strong></p> -<p>▪ <strong>SD</strong></p> -<p>▪ <strong>TD</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>options</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a></td></tr> -<tr><td><code>A</code></td><td><a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹CA | CB | CC | CD, SA | SB | SC | SD, TA | TB | TC | TD›</em></p> -<p>▸ <strong>union</strong><<strong>CA</strong>, <strong>SA</strong>, <strong>TA</strong>, <strong>CB</strong>, <strong>SB</strong>, <strong>TB</strong>, <strong>CC</strong>, <strong>SC</strong>, <strong>TC</strong>, <strong>CD</strong>, <strong>SD</strong>, <strong>TD</strong>, <strong>CE</strong>, <strong>SE</strong>, <strong>TE</strong>>(<code>A</code>: <a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›, <code>B</code>: <a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›, <code>C</code>: <a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›, <code>D</code>: <a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›, <code>E</code>: <a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›): <em>ITypeUnion‹CA | CB | CC | CD | CE, SA | SB | SC | SD | SE, TA | TB | TC | TD | TE›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L218">src/types/utility-types/union.ts:218</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>CA</strong></p> -<p>▪ <strong>SA</strong></p> -<p>▪ <strong>TA</strong></p> -<p>▪ <strong>CB</strong></p> -<p>▪ <strong>SB</strong></p> -<p>▪ <strong>TB</strong></p> -<p>▪ <strong>CC</strong></p> -<p>▪ <strong>SC</strong></p> -<p>▪ <strong>TC</strong></p> -<p>▪ <strong>CD</strong></p> -<p>▪ <strong>SD</strong></p> -<p>▪ <strong>TD</strong></p> -<p>▪ <strong>CE</strong></p> -<p>▪ <strong>SE</strong></p> -<p>▪ <strong>TE</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>A</code></td><td><a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹CA | CB | CC | CD | CE, SA | SB | SC | SD | SE, TA | TB | TC | TD | TE›</em></p> -<p>▸ <strong>union</strong><<strong>CA</strong>, <strong>SA</strong>, <strong>TA</strong>, <strong>CB</strong>, <strong>SB</strong>, <strong>TB</strong>, <strong>CC</strong>, <strong>SC</strong>, <strong>TC</strong>, <strong>CD</strong>, <strong>SD</strong>, <strong>TD</strong>, <strong>CE</strong>, <strong>SE</strong>, <strong>TE</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, <code>A</code>: <a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›, <code>B</code>: <a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›, <code>C</code>: <a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›, <code>D</code>: <a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›, <code>E</code>: <a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›): <em>ITypeUnion‹CA | CB | CC | CD | CE, SA | SB | SC | SD | SE, TA | TB | TC | TD | TE›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L220">src/types/utility-types/union.ts:220</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>CA</strong></p> -<p>▪ <strong>SA</strong></p> -<p>▪ <strong>TA</strong></p> -<p>▪ <strong>CB</strong></p> -<p>▪ <strong>SB</strong></p> -<p>▪ <strong>TB</strong></p> -<p>▪ <strong>CC</strong></p> -<p>▪ <strong>SC</strong></p> -<p>▪ <strong>TC</strong></p> -<p>▪ <strong>CD</strong></p> -<p>▪ <strong>SD</strong></p> -<p>▪ <strong>TD</strong></p> -<p>▪ <strong>CE</strong></p> -<p>▪ <strong>SE</strong></p> -<p>▪ <strong>TE</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>options</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a></td></tr> -<tr><td><code>A</code></td><td><a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹CA | CB | CC | CD | CE, SA | SB | SC | SD | SE, TA | TB | TC | TD | TE›</em></p> -<p>▸ <strong>union</strong><<strong>CA</strong>, <strong>SA</strong>, <strong>TA</strong>, <strong>CB</strong>, <strong>SB</strong>, <strong>TB</strong>, <strong>CC</strong>, <strong>SC</strong>, <strong>TC</strong>, <strong>CD</strong>, <strong>SD</strong>, <strong>TD</strong>, <strong>CE</strong>, <strong>SE</strong>, <strong>TE</strong>, <strong>CF</strong>, <strong>SF</strong>, <strong>TF</strong>>(<code>A</code>: <a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›, <code>B</code>: <a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›, <code>C</code>: <a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›, <code>D</code>: <a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›, <code>E</code>: <a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›, <code>F</code>: <a href="/API/interfaces/itype">IType</a>‹CF, SF, TF›): <em>ITypeUnion‹CA | CB | CC | CD | CE | CF, SA | SB | SC | SD | SE | SF, TA | TB | TC | TD | TE | TF›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L222">src/types/utility-types/union.ts:222</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>CA</strong></p> -<p>▪ <strong>SA</strong></p> -<p>▪ <strong>TA</strong></p> -<p>▪ <strong>CB</strong></p> -<p>▪ <strong>SB</strong></p> -<p>▪ <strong>TB</strong></p> -<p>▪ <strong>CC</strong></p> -<p>▪ <strong>SC</strong></p> -<p>▪ <strong>TC</strong></p> -<p>▪ <strong>CD</strong></p> -<p>▪ <strong>SD</strong></p> -<p>▪ <strong>TD</strong></p> -<p>▪ <strong>CE</strong></p> -<p>▪ <strong>SE</strong></p> -<p>▪ <strong>TE</strong></p> -<p>▪ <strong>CF</strong></p> -<p>▪ <strong>SF</strong></p> -<p>▪ <strong>TF</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>A</code></td><td><a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›</td></tr> -<tr><td><code>F</code></td><td><a href="/API/interfaces/itype">IType</a>‹CF, SF, TF›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹CA | CB | CC | CD | CE | CF, SA | SB | SC | SD | SE | SF, TA | TB | TC | TD | TE | TF›</em></p> -<p>▸ <strong>union</strong><<strong>CA</strong>, <strong>SA</strong>, <strong>TA</strong>, <strong>CB</strong>, <strong>SB</strong>, <strong>TB</strong>, <strong>CC</strong>, <strong>SC</strong>, <strong>TC</strong>, <strong>CD</strong>, <strong>SD</strong>, <strong>TD</strong>, <strong>CE</strong>, <strong>SE</strong>, <strong>TE</strong>, <strong>CF</strong>, <strong>SF</strong>, <strong>TF</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, <code>A</code>: <a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›, <code>B</code>: <a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›, <code>C</code>: <a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›, <code>D</code>: <a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›, <code>E</code>: <a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›, <code>F</code>: <a href="/API/interfaces/itype">IType</a>‹CF, SF, TF›): <em>ITypeUnion‹CA | CB | CC | CD | CE | CF, SA | SB | SC | SD | SE | SF, TA | TB | TC | TD | TE | TF›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L224">src/types/utility-types/union.ts:224</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>CA</strong></p> -<p>▪ <strong>SA</strong></p> -<p>▪ <strong>TA</strong></p> -<p>▪ <strong>CB</strong></p> -<p>▪ <strong>SB</strong></p> -<p>▪ <strong>TB</strong></p> -<p>▪ <strong>CC</strong></p> -<p>▪ <strong>SC</strong></p> -<p>▪ <strong>TC</strong></p> -<p>▪ <strong>CD</strong></p> -<p>▪ <strong>SD</strong></p> -<p>▪ <strong>TD</strong></p> -<p>▪ <strong>CE</strong></p> -<p>▪ <strong>SE</strong></p> -<p>▪ <strong>TE</strong></p> -<p>▪ <strong>CF</strong></p> -<p>▪ <strong>SF</strong></p> -<p>▪ <strong>TF</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>options</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a></td></tr> -<tr><td><code>A</code></td><td><a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›</td></tr> -<tr><td><code>F</code></td><td><a href="/API/interfaces/itype">IType</a>‹CF, SF, TF›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹CA | CB | CC | CD | CE | CF, SA | SB | SC | SD | SE | SF, TA | TB | TC | TD | TE | TF›</em></p> -<p>▸ <strong>union</strong><<strong>CA</strong>, <strong>SA</strong>, <strong>TA</strong>, <strong>CB</strong>, <strong>SB</strong>, <strong>TB</strong>, <strong>CC</strong>, <strong>SC</strong>, <strong>TC</strong>, <strong>CD</strong>, <strong>SD</strong>, <strong>TD</strong>, <strong>CE</strong>, <strong>SE</strong>, <strong>TE</strong>, <strong>CF</strong>, <strong>SF</strong>, <strong>TF</strong>, <strong>CG</strong>, <strong>SG</strong>, <strong>TG</strong>>(<code>A</code>: <a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›, <code>B</code>: <a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›, <code>C</code>: <a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›, <code>D</code>: <a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›, <code>E</code>: <a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›, <code>F</code>: <a href="/API/interfaces/itype">IType</a>‹CF, SF, TF›, <code>G</code>: <a href="/API/interfaces/itype">IType</a>‹CG, SG, TG›): <em>ITypeUnion‹CA | CB | CC | CD | CE | CF | CG, SA | SB | SC | SD | SE | SF | SG, TA | TB | TC | TD | TE | TF | TG›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L226">src/types/utility-types/union.ts:226</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>CA</strong></p> -<p>▪ <strong>SA</strong></p> -<p>▪ <strong>TA</strong></p> -<p>▪ <strong>CB</strong></p> -<p>▪ <strong>SB</strong></p> -<p>▪ <strong>TB</strong></p> -<p>▪ <strong>CC</strong></p> -<p>▪ <strong>SC</strong></p> -<p>▪ <strong>TC</strong></p> -<p>▪ <strong>CD</strong></p> -<p>▪ <strong>SD</strong></p> -<p>▪ <strong>TD</strong></p> -<p>▪ <strong>CE</strong></p> -<p>▪ <strong>SE</strong></p> -<p>▪ <strong>TE</strong></p> -<p>▪ <strong>CF</strong></p> -<p>▪ <strong>SF</strong></p> -<p>▪ <strong>TF</strong></p> -<p>▪ <strong>CG</strong></p> -<p>▪ <strong>SG</strong></p> -<p>▪ <strong>TG</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>A</code></td><td><a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›</td></tr> -<tr><td><code>F</code></td><td><a href="/API/interfaces/itype">IType</a>‹CF, SF, TF›</td></tr> -<tr><td><code>G</code></td><td><a href="/API/interfaces/itype">IType</a>‹CG, SG, TG›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹CA | CB | CC | CD | CE | CF | CG, SA | SB | SC | SD | SE | SF | SG, TA | TB | TC | TD | TE | TF | TG›</em></p> -<p>▸ <strong>union</strong><<strong>CA</strong>, <strong>SA</strong>, <strong>TA</strong>, <strong>CB</strong>, <strong>SB</strong>, <strong>TB</strong>, <strong>CC</strong>, <strong>SC</strong>, <strong>TC</strong>, <strong>CD</strong>, <strong>SD</strong>, <strong>TD</strong>, <strong>CE</strong>, <strong>SE</strong>, <strong>TE</strong>, <strong>CF</strong>, <strong>SF</strong>, <strong>TF</strong>, <strong>CG</strong>, <strong>SG</strong>, <strong>TG</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, <code>A</code>: <a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›, <code>B</code>: <a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›, <code>C</code>: <a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›, <code>D</code>: <a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›, <code>E</code>: <a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›, <code>F</code>: <a href="/API/interfaces/itype">IType</a>‹CF, SF, TF›, <code>G</code>: <a href="/API/interfaces/itype">IType</a>‹CG, SG, TG›): <em>ITypeUnion‹CA | CB | CC | CD | CE | CF | CG, SA | SB | SC | SD | SE | SF | SG, TA | TB | TC | TD | TE | TF | TG›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L229">src/types/utility-types/union.ts:229</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>CA</strong></p> -<p>▪ <strong>SA</strong></p> -<p>▪ <strong>TA</strong></p> -<p>▪ <strong>CB</strong></p> -<p>▪ <strong>SB</strong></p> -<p>▪ <strong>TB</strong></p> -<p>▪ <strong>CC</strong></p> -<p>▪ <strong>SC</strong></p> -<p>▪ <strong>TC</strong></p> -<p>▪ <strong>CD</strong></p> -<p>▪ <strong>SD</strong></p> -<p>▪ <strong>TD</strong></p> -<p>▪ <strong>CE</strong></p> -<p>▪ <strong>SE</strong></p> -<p>▪ <strong>TE</strong></p> -<p>▪ <strong>CF</strong></p> -<p>▪ <strong>SF</strong></p> -<p>▪ <strong>TF</strong></p> -<p>▪ <strong>CG</strong></p> -<p>▪ <strong>SG</strong></p> -<p>▪ <strong>TG</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>options</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a></td></tr> -<tr><td><code>A</code></td><td><a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›</td></tr> -<tr><td><code>F</code></td><td><a href="/API/interfaces/itype">IType</a>‹CF, SF, TF›</td></tr> -<tr><td><code>G</code></td><td><a href="/API/interfaces/itype">IType</a>‹CG, SG, TG›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹CA | CB | CC | CD | CE | CF | CG, SA | SB | SC | SD | SE | SF | SG, TA | TB | TC | TD | TE | TF | TG›</em></p> -<p>▸ <strong>union</strong><<strong>CA</strong>, <strong>SA</strong>, <strong>TA</strong>, <strong>CB</strong>, <strong>SB</strong>, <strong>TB</strong>, <strong>CC</strong>, <strong>SC</strong>, <strong>TC</strong>, <strong>CD</strong>, <strong>SD</strong>, <strong>TD</strong>, <strong>CE</strong>, <strong>SE</strong>, <strong>TE</strong>, <strong>CF</strong>, <strong>SF</strong>, <strong>TF</strong>, <strong>CG</strong>, <strong>SG</strong>, <strong>TG</strong>, <strong>CH</strong>, <strong>SH</strong>, <strong>TH</strong>>(<code>A</code>: <a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›, <code>B</code>: <a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›, <code>C</code>: <a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›, <code>D</code>: <a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›, <code>E</code>: <a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›, <code>F</code>: <a href="/API/interfaces/itype">IType</a>‹CF, SF, TF›, <code>G</code>: <a href="/API/interfaces/itype">IType</a>‹CG, SG, TG›, <code>H</code>: <a href="/API/interfaces/itype">IType</a>‹CH, SH, TH›): <em>ITypeUnion‹CA | CB | CC | CD | CE | CF | CG | CH, SA | SB | SC | SD | SE | SF | SG | SH, TA | TB | TC | TD | TE | TF | TG | TH›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L231">src/types/utility-types/union.ts:231</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>CA</strong></p> -<p>▪ <strong>SA</strong></p> -<p>▪ <strong>TA</strong></p> -<p>▪ <strong>CB</strong></p> -<p>▪ <strong>SB</strong></p> -<p>▪ <strong>TB</strong></p> -<p>▪ <strong>CC</strong></p> -<p>▪ <strong>SC</strong></p> -<p>▪ <strong>TC</strong></p> -<p>▪ <strong>CD</strong></p> -<p>▪ <strong>SD</strong></p> -<p>▪ <strong>TD</strong></p> -<p>▪ <strong>CE</strong></p> -<p>▪ <strong>SE</strong></p> -<p>▪ <strong>TE</strong></p> -<p>▪ <strong>CF</strong></p> -<p>▪ <strong>SF</strong></p> -<p>▪ <strong>TF</strong></p> -<p>▪ <strong>CG</strong></p> -<p>▪ <strong>SG</strong></p> -<p>▪ <strong>TG</strong></p> -<p>▪ <strong>CH</strong></p> -<p>▪ <strong>SH</strong></p> -<p>▪ <strong>TH</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>A</code></td><td><a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›</td></tr> -<tr><td><code>F</code></td><td><a href="/API/interfaces/itype">IType</a>‹CF, SF, TF›</td></tr> -<tr><td><code>G</code></td><td><a href="/API/interfaces/itype">IType</a>‹CG, SG, TG›</td></tr> -<tr><td><code>H</code></td><td><a href="/API/interfaces/itype">IType</a>‹CH, SH, TH›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹CA | CB | CC | CD | CE | CF | CG | CH, SA | SB | SC | SD | SE | SF | SG | SH, TA | TB | TC | TD | TE | TF | TG | TH›</em></p> -<p>▸ <strong>union</strong><<strong>CA</strong>, <strong>SA</strong>, <strong>TA</strong>, <strong>CB</strong>, <strong>SB</strong>, <strong>TB</strong>, <strong>CC</strong>, <strong>SC</strong>, <strong>TC</strong>, <strong>CD</strong>, <strong>SD</strong>, <strong>TD</strong>, <strong>CE</strong>, <strong>SE</strong>, <strong>TE</strong>, <strong>CF</strong>, <strong>SF</strong>, <strong>TF</strong>, <strong>CG</strong>, <strong>SG</strong>, <strong>TG</strong>, <strong>CH</strong>, <strong>SH</strong>, <strong>TH</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, <code>A</code>: <a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›, <code>B</code>: <a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›, <code>C</code>: <a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›, <code>D</code>: <a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›, <code>E</code>: <a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›, <code>F</code>: <a href="/API/interfaces/itype">IType</a>‹CF, SF, TF›, <code>G</code>: <a href="/API/interfaces/itype">IType</a>‹CG, SG, TG›, <code>H</code>: <a href="/API/interfaces/itype">IType</a>‹CH, SH, TH›): <em>ITypeUnion‹CA | CB | CC | CD | CE | CF | CG | CH, SA | SB | SC | SD | SE | SF | SG | SH, TA | TB | TC | TD | TE | TF | TG | TH›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L234">src/types/utility-types/union.ts:234</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>CA</strong></p> -<p>▪ <strong>SA</strong></p> -<p>▪ <strong>TA</strong></p> -<p>▪ <strong>CB</strong></p> -<p>▪ <strong>SB</strong></p> -<p>▪ <strong>TB</strong></p> -<p>▪ <strong>CC</strong></p> -<p>▪ <strong>SC</strong></p> -<p>▪ <strong>TC</strong></p> -<p>▪ <strong>CD</strong></p> -<p>▪ <strong>SD</strong></p> -<p>▪ <strong>TD</strong></p> -<p>▪ <strong>CE</strong></p> -<p>▪ <strong>SE</strong></p> -<p>▪ <strong>TE</strong></p> -<p>▪ <strong>CF</strong></p> -<p>▪ <strong>SF</strong></p> -<p>▪ <strong>TF</strong></p> -<p>▪ <strong>CG</strong></p> -<p>▪ <strong>SG</strong></p> -<p>▪ <strong>TG</strong></p> -<p>▪ <strong>CH</strong></p> -<p>▪ <strong>SH</strong></p> -<p>▪ <strong>TH</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>options</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a></td></tr> -<tr><td><code>A</code></td><td><a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›</td></tr> -<tr><td><code>F</code></td><td><a href="/API/interfaces/itype">IType</a>‹CF, SF, TF›</td></tr> -<tr><td><code>G</code></td><td><a href="/API/interfaces/itype">IType</a>‹CG, SG, TG›</td></tr> -<tr><td><code>H</code></td><td><a href="/API/interfaces/itype">IType</a>‹CH, SH, TH›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹CA | CB | CC | CD | CE | CF | CG | CH, SA | SB | SC | SD | SE | SF | SG | SH, TA | TB | TC | TD | TE | TF | TG | TH›</em></p> -<p>▸ <strong>union</strong><<strong>CA</strong>, <strong>SA</strong>, <strong>TA</strong>, <strong>CB</strong>, <strong>SB</strong>, <strong>TB</strong>, <strong>CC</strong>, <strong>SC</strong>, <strong>TC</strong>, <strong>CD</strong>, <strong>SD</strong>, <strong>TD</strong>, <strong>CE</strong>, <strong>SE</strong>, <strong>TE</strong>, <strong>CF</strong>, <strong>SF</strong>, <strong>TF</strong>, <strong>CG</strong>, <strong>SG</strong>, <strong>TG</strong>, <strong>CH</strong>, <strong>SH</strong>, <strong>TH</strong>, <strong>CI</strong>, <strong>SI</strong>, <strong>TI</strong>>(<code>A</code>: <a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›, <code>B</code>: <a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›, <code>C</code>: <a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›, <code>D</code>: <a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›, <code>E</code>: <a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›, <code>F</code>: <a href="/API/interfaces/itype">IType</a>‹CF, SF, TF›, <code>G</code>: <a href="/API/interfaces/itype">IType</a>‹CG, SG, TG›, <code>H</code>: <a href="/API/interfaces/itype">IType</a>‹CH, SH, TH›, <code>I</code>: <a href="/API/interfaces/itype">IType</a>‹CI, SI, TI›): <em>ITypeUnion‹CA | CB | CC | CD | CE | CF | CG | CH | CI, SA | SB | SC | SD | SE | SF | SG | SH | SI, TA | TB | TC | TD | TE | TF | TG | TH | TI›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L237">src/types/utility-types/union.ts:237</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>CA</strong></p> -<p>▪ <strong>SA</strong></p> -<p>▪ <strong>TA</strong></p> -<p>▪ <strong>CB</strong></p> -<p>▪ <strong>SB</strong></p> -<p>▪ <strong>TB</strong></p> -<p>▪ <strong>CC</strong></p> -<p>▪ <strong>SC</strong></p> -<p>▪ <strong>TC</strong></p> -<p>▪ <strong>CD</strong></p> -<p>▪ <strong>SD</strong></p> -<p>▪ <strong>TD</strong></p> -<p>▪ <strong>CE</strong></p> -<p>▪ <strong>SE</strong></p> -<p>▪ <strong>TE</strong></p> -<p>▪ <strong>CF</strong></p> -<p>▪ <strong>SF</strong></p> -<p>▪ <strong>TF</strong></p> -<p>▪ <strong>CG</strong></p> -<p>▪ <strong>SG</strong></p> -<p>▪ <strong>TG</strong></p> -<p>▪ <strong>CH</strong></p> -<p>▪ <strong>SH</strong></p> -<p>▪ <strong>TH</strong></p> -<p>▪ <strong>CI</strong></p> -<p>▪ <strong>SI</strong></p> -<p>▪ <strong>TI</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>A</code></td><td><a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›</td></tr> -<tr><td><code>F</code></td><td><a href="/API/interfaces/itype">IType</a>‹CF, SF, TF›</td></tr> -<tr><td><code>G</code></td><td><a href="/API/interfaces/itype">IType</a>‹CG, SG, TG›</td></tr> -<tr><td><code>H</code></td><td><a href="/API/interfaces/itype">IType</a>‹CH, SH, TH›</td></tr> -<tr><td><code>I</code></td><td><a href="/API/interfaces/itype">IType</a>‹CI, SI, TI›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹CA | CB | CC | CD | CE | CF | CG | CH | CI, SA | SB | SC | SD | SE | SF | SG | SH | SI, TA | TB | TC | TD | TE | TF | TG | TH | TI›</em></p> -<p>▸ <strong>union</strong><<strong>CA</strong>, <strong>SA</strong>, <strong>TA</strong>, <strong>CB</strong>, <strong>SB</strong>, <strong>TB</strong>, <strong>CC</strong>, <strong>SC</strong>, <strong>TC</strong>, <strong>CD</strong>, <strong>SD</strong>, <strong>TD</strong>, <strong>CE</strong>, <strong>SE</strong>, <strong>TE</strong>, <strong>CF</strong>, <strong>SF</strong>, <strong>TF</strong>, <strong>CG</strong>, <strong>SG</strong>, <strong>TG</strong>, <strong>CH</strong>, <strong>SH</strong>, <strong>TH</strong>, <strong>CI</strong>, <strong>SI</strong>, <strong>TI</strong>>(<code>options</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a>, <code>A</code>: <a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›, <code>B</code>: <a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›, <code>C</code>: <a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›, <code>D</code>: <a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›, <code>E</code>: <a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›, <code>F</code>: <a href="/API/interfaces/itype">IType</a>‹CF, SF, TF›, <code>G</code>: <a href="/API/interfaces/itype">IType</a>‹CG, SG, TG›, <code>H</code>: <a href="/API/interfaces/itype">IType</a>‹CH, SH, TH›, <code>I</code>: <a href="/API/interfaces/itype">IType</a>‹CI, SI, TI›): <em>ITypeUnion‹CA | CB | CC | CD | CE | CF | CG | CH | CI, SA | SB | SC | SD | SE | SF | SG | SH | SI, TA | TB | TC | TD | TE | TF | TG | TH | TI›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L240">src/types/utility-types/union.ts:240</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Type parameters:</strong></p> -<p>▪ <strong>CA</strong></p> -<p>▪ <strong>SA</strong></p> -<p>▪ <strong>TA</strong></p> -<p>▪ <strong>CB</strong></p> -<p>▪ <strong>SB</strong></p> -<p>▪ <strong>TB</strong></p> -<p>▪ <strong>CC</strong></p> -<p>▪ <strong>SC</strong></p> -<p>▪ <strong>TC</strong></p> -<p>▪ <strong>CD</strong></p> -<p>▪ <strong>SD</strong></p> -<p>▪ <strong>TD</strong></p> -<p>▪ <strong>CE</strong></p> -<p>▪ <strong>SE</strong></p> -<p>▪ <strong>TE</strong></p> -<p>▪ <strong>CF</strong></p> -<p>▪ <strong>SF</strong></p> -<p>▪ <strong>TF</strong></p> -<p>▪ <strong>CG</strong></p> -<p>▪ <strong>SG</strong></p> -<p>▪ <strong>TG</strong></p> -<p>▪ <strong>CH</strong></p> -<p>▪ <strong>SH</strong></p> -<p>▪ <strong>TH</strong></p> -<p>▪ <strong>CI</strong></p> -<p>▪ <strong>SI</strong></p> -<p>▪ <strong>TI</strong></p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>options</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a></td></tr> -<tr><td><code>A</code></td><td><a href="/API/interfaces/itype">IType</a>‹CA, SA, TA›</td></tr> -<tr><td><code>B</code></td><td><a href="/API/interfaces/itype">IType</a>‹CB, SB, TB›</td></tr> -<tr><td><code>C</code></td><td><a href="/API/interfaces/itype">IType</a>‹CC, SC, TC›</td></tr> -<tr><td><code>D</code></td><td><a href="/API/interfaces/itype">IType</a>‹CD, SD, TD›</td></tr> -<tr><td><code>E</code></td><td><a href="/API/interfaces/itype">IType</a>‹CE, SE, TE›</td></tr> -<tr><td><code>F</code></td><td><a href="/API/interfaces/itype">IType</a>‹CF, SF, TF›</td></tr> -<tr><td><code>G</code></td><td><a href="/API/interfaces/itype">IType</a>‹CG, SG, TG›</td></tr> -<tr><td><code>H</code></td><td><a href="/API/interfaces/itype">IType</a>‹CH, SH, TH›</td></tr> -<tr><td><code>I</code></td><td><a href="/API/interfaces/itype">IType</a>‹CI, SI, TI›</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em>ITypeUnion‹CA | CB | CC | CD | CE | CF | CG | CH | CI, SA | SB | SC | SD | SE | SF | SG | SH | SI, TA | TB | TC | TD | TE | TF | TG | TH | TI›</em></p> -<p>▸ <strong>union</strong>(...<code>types</code>: <a href="/API/interfaces/ianytype">IAnyType</a>[]): <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L243">src/types/utility-types/union.ts:243</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>...types</code></td><td><a href="/API/interfaces/ianytype">IAnyType</a>[]</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> -<p>▸ <strong>union</strong>(<code>dispatchOrType</code>: <a href="/API/interfaces/unionoptions">UnionOptions</a> | <a href="/API/interfaces/ianytype">IAnyType</a>, ...<code>otherTypes</code>: <a href="/API/interfaces/ianytype">IAnyType</a>[]): <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L244">src/types/utility-types/union.ts:244</a></em></p> -<p><code>types.union</code> - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form <code>(snapshot) => Type</code>.</p> -<p><strong>Parameters:</strong></p> -<table> -<thead> -<tr><th>Name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td><code>dispatchOrType</code></td><td><a href="/API/interfaces/unionoptions">UnionOptions</a> | <a href="/API/interfaces/ianytype">IAnyType</a></td></tr> -<tr><td><code>...otherTypes</code></td><td><a href="/API/interfaces/ianytype">IAnyType</a>[]</td></tr> -</tbody> -</table> -<p><strong>Returns:</strong> <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> +<p><strong>Returns:</strong> <em>IUnionType‹Types›</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="unprotect"></a><a href="#unprotect" 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>unprotect</h3> <p>▸ <strong>unprotect</strong>(<code>target</code>: IAnyStateTreeNode): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L299">src/core/mst-operations.ts:299</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L298">src/core/mst-operations.ts:298</a></em></p> <p>By default it is not allowed to directly modify a model. Models can only be modified through actions. However, in some cases you don't care about the advantages (like replayability, traceability, etc) this yields. For example because you are building a PoC or don't have any middleware attached to your tree.</p> @@ -4754,7 +3551,7 @@ <h3><a class="anchor" aria-hidden="true" id="unprotect"></a><a href="#unprotect" <hr> <h3><a class="anchor" aria-hidden="true" id="walk"></a><a href="#walk" 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>walk</h3> <p>▸ <strong>walk</strong>(<code>target</code>: IAnyStateTreeNode, <code>processor</code>: function): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L787">src/core/mst-operations.ts:787</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L808">src/core/mst-operations.ts:808</a></em></p> <p>Performs a depth first walk through a tree.</p> <p><strong>Parameters:</strong></p> <p>▪ <strong>target</strong>: <em>IAnyStateTreeNode</em></p> @@ -4773,95 +3570,95 @@ <h3><a class="anchor" aria-hidden="true" id="walk"></a><a href="#walk" aria-hidd <h2><a class="anchor" aria-hidden="true" id="object-literals-1"></a><a href="#object-literals-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>Object literals</h2> <h3><a class="anchor" aria-hidden="true" id="const-types"></a><a href="#const-types" 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><code>Const</code> types</h3> <h3><a class="anchor" aria-hidden="true" id="-types-object"></a><a href="#-types-object" 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>▪ <strong>types</strong>: <em>object</em></h3> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L34">src/types/index.ts:34</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L34">src/types/index.ts:34</a></em></p> <h3><a class="anchor" aria-hidden="true" id="date"></a><a href="#date" 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>Date</h3> <p>• <strong>Date</strong>: <em><a href="/API/interfaces/itype">IType</a>‹number | Date, number, Date›</em> = DatePrimitive</p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L53">src/types/index.ts:53</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L53">src/types/index.ts:53</a></em></p> <h3><a class="anchor" aria-hidden="true" id="array-1"></a><a href="#array-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>array</h3> <p>• <strong>array</strong>: <em><a href="/API/#array">array</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L55">src/types/index.ts:55</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L55">src/types/index.ts:55</a></em></p> <h3><a class="anchor" aria-hidden="true" id="boolean"></a><a href="#boolean" 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>boolean</h3> <p>• <strong>boolean</strong>: <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹boolean›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L48">src/types/index.ts:48</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L48">src/types/index.ts:48</a></em></p> <h3><a class="anchor" aria-hidden="true" id="compose-1"></a><a href="#compose-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>compose</h3> <p>• <strong>compose</strong>: <em><a href="/API/#compose">compose</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L37">src/types/index.ts:37</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L37">src/types/index.ts:37</a></em></p> <h3><a class="anchor" aria-hidden="true" id="custom-1"></a><a href="#custom-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>custom</h3> <p>• <strong>custom</strong>: <em><a href="/API/#custom">custom</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L38">src/types/index.ts:38</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L38">src/types/index.ts:38</a></em></p> <h3><a class="anchor" aria-hidden="true" id="enumeration-1"></a><a href="#enumeration-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>enumeration</h3> <p>• <strong>enumeration</strong>: <em><a href="/API/#enumeration">enumeration</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L35">src/types/index.ts:35</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L35">src/types/index.ts:35</a></em></p> <h3><a class="anchor" aria-hidden="true" id="finite"></a><a href="#finite" 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>finite</h3> <p>• <strong>finite</strong>: <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹number›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L52">src/types/index.ts:52</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L52">src/types/index.ts:52</a></em></p> <h3><a class="anchor" aria-hidden="true" id="float"></a><a href="#float" 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>float</h3> <p>• <strong>float</strong>: <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹number›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L51">src/types/index.ts:51</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L51">src/types/index.ts:51</a></em></p> <h3><a class="anchor" aria-hidden="true" id="frozen-1"></a><a href="#frozen-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>frozen</h3> <p>• <strong>frozen</strong>: <em><a href="/API/#frozen">frozen</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L56">src/types/index.ts:56</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L56">src/types/index.ts:56</a></em></p> <h3><a class="anchor" aria-hidden="true" id="identifier"></a><a href="#identifier" 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>identifier</h3> <p>• <strong>identifier</strong>: <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹string›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L57">src/types/index.ts:57</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L57">src/types/index.ts:57</a></em></p> <h3><a class="anchor" aria-hidden="true" id="identifiernumber"></a><a href="#identifiernumber" 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>identifierNumber</h3> <p>• <strong>identifierNumber</strong>: <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹number›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L58">src/types/index.ts:58</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L58">src/types/index.ts:58</a></em></p> <h3><a class="anchor" aria-hidden="true" id="integer"></a><a href="#integer" 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>integer</h3> <p>• <strong>integer</strong>: <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹number›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L50">src/types/index.ts:50</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L50">src/types/index.ts:50</a></em></p> <h3><a class="anchor" aria-hidden="true" id="late-1"></a><a href="#late-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>late</h3> <p>• <strong>late</strong>: <em><a href="/API/#late">late</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L59">src/types/index.ts:59</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L59">src/types/index.ts:59</a></em></p> <h3><a class="anchor" aria-hidden="true" id="lazy-1"></a><a href="#lazy-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>lazy</h3> <p>• <strong>lazy</strong>: <em><a href="/API/#lazy">lazy</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L60">src/types/index.ts:60</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L60">src/types/index.ts:60</a></em></p> <h3><a class="anchor" aria-hidden="true" id="literal-1"></a><a href="#literal-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>literal</h3> <p>• <strong>literal</strong>: <em><a href="/API/#literal">literal</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L43">src/types/index.ts:43</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L43">src/types/index.ts:43</a></em></p> <h3><a class="anchor" aria-hidden="true" id="map-1"></a><a href="#map-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>map</h3> <p>• <strong>map</strong>: <em><a href="/API/#map">map</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L54">src/types/index.ts:54</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L54">src/types/index.ts:54</a></em></p> <h3><a class="anchor" aria-hidden="true" id="maybe-1"></a><a href="#maybe-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>maybe</h3> <p>• <strong>maybe</strong>: <em><a href="/API/#maybe">maybe</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L44">src/types/index.ts:44</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L44">src/types/index.ts:44</a></em></p> <h3><a class="anchor" aria-hidden="true" id="maybenull-1"></a><a href="#maybenull-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>maybeNull</h3> <p>• <strong>maybeNull</strong>: <em><a href="/API/#maybenull">maybeNull</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L45">src/types/index.ts:45</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L45">src/types/index.ts:45</a></em></p> <h3><a class="anchor" aria-hidden="true" id="model-1"></a><a href="#model-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>model</h3> <p>• <strong>model</strong>: <em><a href="/API/#model">model</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L36">src/types/index.ts:36</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L36">src/types/index.ts:36</a></em></p> <h3><a class="anchor" aria-hidden="true" id="null"></a><a href="#null" 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>null</h3> <p>• <strong>null</strong>: <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹null›</em> = nullType</p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L62">src/types/index.ts:62</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L62">src/types/index.ts:62</a></em></p> <h3><a class="anchor" aria-hidden="true" id="number"></a><a href="#number" 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>number</h3> <p>• <strong>number</strong>: <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹number›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L49">src/types/index.ts:49</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L49">src/types/index.ts:49</a></em></p> <h3><a class="anchor" aria-hidden="true" id="optional-1"></a><a href="#optional-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>optional</h3> <p>• <strong>optional</strong>: <em><a href="/API/#optional">optional</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L42">src/types/index.ts:42</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L42">src/types/index.ts:42</a></em></p> <h3><a class="anchor" aria-hidden="true" id="reference-1"></a><a href="#reference-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>reference</h3> <p>• <strong>reference</strong>: <em><a href="/API/#reference">reference</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L39">src/types/index.ts:39</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L39">src/types/index.ts:39</a></em></p> <h3><a class="anchor" aria-hidden="true" id="refinement-1"></a><a href="#refinement-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>refinement</h3> <p>• <strong>refinement</strong>: <em><a href="/API/#refinement">refinement</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L46">src/types/index.ts:46</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L46">src/types/index.ts:46</a></em></p> <h3><a class="anchor" aria-hidden="true" id="safereference-1"></a><a href="#safereference-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>safeReference</h3> <p>• <strong>safeReference</strong>: <em><a href="/API/#safereference">safeReference</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L40">src/types/index.ts:40</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L40">src/types/index.ts:40</a></em></p> <h3><a class="anchor" aria-hidden="true" id="snapshotprocessor-1"></a><a href="#snapshotprocessor-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>snapshotProcessor</h3> <p>• <strong>snapshotProcessor</strong>: <em><a href="/API/#snapshotprocessor">snapshotProcessor</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L63">src/types/index.ts:63</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L63">src/types/index.ts:63</a></em></p> <h3><a class="anchor" aria-hidden="true" id="string"></a><a href="#string" 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>string</h3> <p>• <strong>string</strong>: <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹string›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L47">src/types/index.ts:47</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L47">src/types/index.ts:47</a></em></p> <h3><a class="anchor" aria-hidden="true" id="undefined"></a><a href="#undefined" 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>undefined</h3> <p>• <strong>undefined</strong>: <em><a href="/API/interfaces/isimpletype">ISimpleType</a>‹undefined›</em> = undefinedType</p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L61">src/types/index.ts:61</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L61">src/types/index.ts:61</a></em></p> <h3><a class="anchor" aria-hidden="true" id="union-1"></a><a href="#union-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>union</h3> <p>• <strong>union</strong>: <em><a href="/API/#union">union</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/index.ts#L41">src/types/index.ts:41</a></em></p> -</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/API/interfaces/customtypeoptions"><span class="function-name-prevnext">CustomTypeOptions</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#interfaces">Interfaces</a></li><li><a href="#type-aliases">Type aliases</a></li><li><a href="#variables">Variables</a></li><li><a href="#functions">Functions</a></li><li><a href="#object-literals">Object literals</a></li></ul></li><li><a href="#type-aliases-1">Type aliases</a><ul class="toc-headings"><li><a href="#idisposer">IDisposer</a></li><li><a href="#ihooksgetter">IHooksGetter</a></li><li><a href="#imiddlewareeventtype">IMiddlewareEventType</a></li><li><a href="#imiddlewarehandler">IMiddlewareHandler</a></li><li><a href="#itypedispatcher">ITypeDispatcher</a></li><li><a href="#ivalidationcontext">IValidationContext</a></li><li><a href="#ivalidationresult">IValidationResult</a></li><li><a href="#instance">Instance</a></li><li><a href="#livelinessmode">LivelinessMode</a></li><li><a href="#onreferenceinvalidated">OnReferenceInvalidated</a></li><li><a href="#onreferenceinvalidatedevent">OnReferenceInvalidatedEvent</a></li><li><a href="#referenceidentifier">ReferenceIdentifier</a></li><li><a href="#referenceoptions">ReferenceOptions</a></li><li><a href="#snapshotin">SnapshotIn</a></li><li><a href="#snapshotorinstance">SnapshotOrInstance</a></li><li><a href="#snapshotout">SnapshotOut</a></li></ul></li><li><a href="#variables-1">Variables</a><ul class="toc-headings"><li><a href="#const-dateprimitive"><code>Const</code> DatePrimitive</a></li><li><a href="#const-boolean"><code>Const</code> boolean</a></li><li><a href="#const-finite"><code>Const</code> finite</a></li><li><a href="#const-float"><code>Const</code> float</a></li><li><a href="#const-identifier"><code>Const</code> identifier</a></li><li><a href="#const-identifiernumber"><code>Const</code> identifierNumber</a></li><li><a href="#const-integer"><code>Const</code> integer</a></li><li><a href="#const-nulltype"><code>Const</code> nullType</a></li><li><a href="#const-number"><code>Const</code> number</a></li><li><a href="#const-string"><code>Const</code> string</a></li><li><a href="#const-undefinedtype"><code>Const</code> undefinedType</a></li></ul></li><li><a href="#functions-1">Functions</a><ul class="toc-headings"><li><a href="#adddisposer">addDisposer</a></li><li><a href="#addmiddleware">addMiddleware</a></li><li><a href="#applyaction">applyAction</a></li><li><a href="#applypatch">applyPatch</a></li><li><a href="#applysnapshot">applySnapshot</a></li><li><a href="#array">array</a></li><li><a href="#cast">cast</a></li><li><a href="#castflowreturn">castFlowReturn</a></li><li><a href="#casttoreferencesnapshot">castToReferenceSnapshot</a></li><li><a href="#casttosnapshot">castToSnapshot</a></li><li><a href="#clone">clone</a></li><li><a href="#compose">compose</a></li><li><a href="#createactiontrackingmiddleware">createActionTrackingMiddleware</a></li><li><a href="#createactiontrackingmiddleware2">createActionTrackingMiddleware2</a></li><li><a href="#custom">custom</a></li><li><a href="#decorate">decorate</a></li><li><a href="#destroy">destroy</a></li><li><a href="#detach">detach</a></li><li><a href="#enumeration">enumeration</a></li><li><a href="#escapejsonpath">escapeJsonPath</a></li><li><a href="#flow">flow</a></li><li><a href="#frozen">frozen</a></li><li><a href="#getchildtype">getChildType</a></li><li><a href="#getenv">getEnv</a></li><li><a href="#getidentifier">getIdentifier</a></li><li><a href="#getlivelinesschecking">getLivelinessChecking</a></li><li><a href="#getmembers">getMembers</a></li><li><a href="#getnodeid">getNodeId</a></li><li><a href="#getparent">getParent</a></li><li><a href="#getparentoftype">getParentOfType</a></li><li><a href="#getpath">getPath</a></li><li><a href="#getpathparts">getPathParts</a></li><li><a href="#getpropertymembers">getPropertyMembers</a></li><li><a href="#getrelativepath">getRelativePath</a></li><li><a href="#getroot">getRoot</a></li><li><a href="#getrunningactioncontext">getRunningActionContext</a></li><li><a href="#getsnapshot">getSnapshot</a></li><li><a href="#gettype">getType</a></li><li><a href="#hasparent">hasParent</a></li><li><a href="#hasparentoftype">hasParentOfType</a></li><li><a href="#isactioncontextchildof">isActionContextChildOf</a></li><li><a href="#isactioncontextthisorchildof">isActionContextThisOrChildOf</a></li><li><a href="#isalive">isAlive</a></li><li><a href="#isarraytype">isArrayType</a></li><li><a href="#isfrozentype">isFrozenType</a></li><li><a href="#isidentifiertype">isIdentifierType</a></li><li><a href="#islatetype">isLateType</a></li><li><a href="#isliteraltype">isLiteralType</a></li><li><a href="#ismaptype">isMapType</a></li><li><a href="#ismodeltype">isModelType</a></li><li><a href="#isoptionaltype">isOptionalType</a></li><li><a href="#isprimitivetype">isPrimitiveType</a></li><li><a href="#isprotected">isProtected</a></li><li><a href="#isreferencetype">isReferenceType</a></li><li><a href="#isrefinementtype">isRefinementType</a></li><li><a href="#isroot">isRoot</a></li><li><a href="#isstatetreenode">isStateTreeNode</a></li><li><a href="#istype">isType</a></li><li><a href="#isuniontype">isUnionType</a></li><li><a href="#isvalidreference">isValidReference</a></li><li><a href="#joinjsonpath">joinJsonPath</a></li><li><a href="#late">late</a></li><li><a href="#lazy">lazy</a></li><li><a href="#literal">literal</a></li><li><a href="#map">map</a></li><li><a href="#maybe">maybe</a></li><li><a href="#maybenull">maybeNull</a></li><li><a href="#model">model</a></li><li><a href="#onaction">onAction</a></li><li><a href="#onpatch">onPatch</a></li><li><a href="#onsnapshot">onSnapshot</a></li><li><a href="#optional">optional</a></li><li><a href="#protect">protect</a></li><li><a href="#recordactions">recordActions</a></li><li><a href="#recordpatches">recordPatches</a></li><li><a href="#reference">reference</a></li><li><a href="#refinement">refinement</a></li><li><a href="#resolveidentifier">resolveIdentifier</a></li><li><a href="#resolvepath">resolvePath</a></li><li><a href="#safereference">safeReference</a></li><li><a href="#setlivelinesschecking">setLivelinessChecking</a></li><li><a href="#snapshotprocessor">snapshotProcessor</a></li><li><a href="#splitjsonpath">splitJsonPath</a></li><li><a href="#togenerator">toGenerator</a></li><li><a href="#togeneratorfunction">toGeneratorFunction</a></li><li><a href="#tryreference">tryReference</a></li><li><a href="#tryresolve">tryResolve</a></li><li><a href="#typecheck">typecheck</a></li><li><a href="#unescapejsonpath">unescapeJsonPath</a></li><li><a href="#union">union</a></li><li><a href="#unprotect">unprotect</a></li><li><a href="#walk">walk</a></li></ul></li><li><a href="#object-literals-1">Object literals</a><ul class="toc-headings"><li><a href="#const-types"><code>Const</code> types</a></li><li><a href="#-types-object">▪ <strong>types</strong>: <em>object</em></a></li><li><a href="#date">Date</a></li><li><a href="#array-1">array</a></li><li><a href="#boolean">boolean</a></li><li><a href="#compose-1">compose</a></li><li><a href="#custom-1">custom</a></li><li><a href="#enumeration-1">enumeration</a></li><li><a href="#finite">finite</a></li><li><a href="#float">float</a></li><li><a href="#frozen-1">frozen</a></li><li><a href="#identifier">identifier</a></li><li><a href="#identifiernumber">identifierNumber</a></li><li><a href="#integer">integer</a></li><li><a href="#late-1">late</a></li><li><a href="#lazy-1">lazy</a></li><li><a href="#literal-1">literal</a></li><li><a href="#map-1">map</a></li><li><a href="#maybe-1">maybe</a></li><li><a href="#maybenull-1">maybeNull</a></li><li><a href="#model-1">model</a></li><li><a href="#null">null</a></li><li><a href="#number">number</a></li><li><a href="#optional-1">optional</a></li><li><a href="#reference-1">reference</a></li><li><a href="#refinement-1">refinement</a></li><li><a href="#safereference-1">safeReference</a></li><li><a href="#snapshotprocessor-1">snapshotProcessor</a></li><li><a href="#string">string</a></li><li><a href="#undefined">undefined</a></li><li><a href="#union-1">union</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> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/index.ts#L41">src/types/index.ts:41</a></em></p> +</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/API/interfaces/customtypeoptions"><span class="function-name-prevnext">CustomTypeOptions</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#interfaces">Interfaces</a></li><li><a href="#type-aliases">Type aliases</a></li><li><a href="#variables">Variables</a></li><li><a href="#functions">Functions</a></li><li><a href="#object-literals">Object literals</a></li></ul></li><li><a href="#type-aliases-1">Type aliases</a><ul class="toc-headings"><li><a href="#idisposer">IDisposer</a></li><li><a href="#ihooksgetter">IHooksGetter</a></li><li><a href="#imiddlewareeventtype">IMiddlewareEventType</a></li><li><a href="#imiddlewarehandler">IMiddlewareHandler</a></li><li><a href="#itypedispatcher">ITypeDispatcher</a></li><li><a href="#ivalidationcontext">IValidationContext</a></li><li><a href="#ivalidationresult">IValidationResult</a></li><li><a href="#instance">Instance</a></li><li><a href="#livelinessmode">LivelinessMode</a></li><li><a href="#onreferenceinvalidated">OnReferenceInvalidated</a></li><li><a href="#onreferenceinvalidatedevent">OnReferenceInvalidatedEvent</a></li><li><a href="#referenceidentifier">ReferenceIdentifier</a></li><li><a href="#referenceoptions">ReferenceOptions</a></li><li><a href="#snapshotin">SnapshotIn</a></li><li><a href="#snapshotorinstance">SnapshotOrInstance</a></li><li><a href="#snapshotout">SnapshotOut</a></li></ul></li><li><a href="#variables-1">Variables</a><ul class="toc-headings"><li><a href="#const-dateprimitive"><code>Const</code> DatePrimitive</a></li><li><a href="#const-boolean"><code>Const</code> boolean</a></li><li><a href="#const-finite"><code>Const</code> finite</a></li><li><a href="#const-float"><code>Const</code> float</a></li><li><a href="#const-identifier"><code>Const</code> identifier</a></li><li><a href="#const-identifiernumber"><code>Const</code> identifierNumber</a></li><li><a href="#const-integer"><code>Const</code> integer</a></li><li><a href="#const-nulltype"><code>Const</code> nullType</a></li><li><a href="#const-number"><code>Const</code> number</a></li><li><a href="#const-string"><code>Const</code> string</a></li><li><a href="#const-undefinedtype"><code>Const</code> undefinedType</a></li></ul></li><li><a href="#functions-1">Functions</a><ul class="toc-headings"><li><a href="#adddisposer">addDisposer</a></li><li><a href="#addmiddleware">addMiddleware</a></li><li><a href="#applyaction">applyAction</a></li><li><a href="#applypatch">applyPatch</a></li><li><a href="#applysnapshot">applySnapshot</a></li><li><a href="#array">array</a></li><li><a href="#cast">cast</a></li><li><a href="#castflowreturn">castFlowReturn</a></li><li><a href="#casttoreferencesnapshot">castToReferenceSnapshot</a></li><li><a href="#casttosnapshot">castToSnapshot</a></li><li><a href="#clone">clone</a></li><li><a href="#compose">compose</a></li><li><a href="#createactiontrackingmiddleware">createActionTrackingMiddleware</a></li><li><a href="#createactiontrackingmiddleware2">createActionTrackingMiddleware2</a></li><li><a href="#custom">custom</a></li><li><a href="#decorate">decorate</a></li><li><a href="#destroy">destroy</a></li><li><a href="#detach">detach</a></li><li><a href="#enumeration">enumeration</a></li><li><a href="#escapejsonpath">escapeJsonPath</a></li><li><a href="#flow">flow</a></li><li><a href="#frozen">frozen</a></li><li><a href="#getchildtype">getChildType</a></li><li><a href="#getenv">getEnv</a></li><li><a href="#getidentifier">getIdentifier</a></li><li><a href="#getlivelinesschecking">getLivelinessChecking</a></li><li><a href="#getmembers">getMembers</a></li><li><a href="#getnodeid">getNodeId</a></li><li><a href="#getparent">getParent</a></li><li><a href="#getparentoftype">getParentOfType</a></li><li><a href="#getpath">getPath</a></li><li><a href="#getpathparts">getPathParts</a></li><li><a href="#getpropertymembers">getPropertyMembers</a></li><li><a href="#getrelativepath">getRelativePath</a></li><li><a href="#getroot">getRoot</a></li><li><a href="#getrunningactioncontext">getRunningActionContext</a></li><li><a href="#getsnapshot">getSnapshot</a></li><li><a href="#gettype">getType</a></li><li><a href="#hasenv">hasEnv</a></li><li><a href="#hasparent">hasParent</a></li><li><a href="#hasparentoftype">hasParentOfType</a></li><li><a href="#isactioncontextchildof">isActionContextChildOf</a></li><li><a href="#isactioncontextthisorchildof">isActionContextThisOrChildOf</a></li><li><a href="#isalive">isAlive</a></li><li><a href="#isarraytype">isArrayType</a></li><li><a href="#isfrozentype">isFrozenType</a></li><li><a href="#isidentifiertype">isIdentifierType</a></li><li><a href="#islatetype">isLateType</a></li><li><a href="#isliteraltype">isLiteralType</a></li><li><a href="#ismaptype">isMapType</a></li><li><a href="#ismodeltype">isModelType</a></li><li><a href="#isoptionaltype">isOptionalType</a></li><li><a href="#isprimitivetype">isPrimitiveType</a></li><li><a href="#isprotected">isProtected</a></li><li><a href="#isreferencetype">isReferenceType</a></li><li><a href="#isrefinementtype">isRefinementType</a></li><li><a href="#isroot">isRoot</a></li><li><a href="#isstatetreenode">isStateTreeNode</a></li><li><a href="#istype">isType</a></li><li><a href="#isuniontype">isUnionType</a></li><li><a href="#isvalidreference">isValidReference</a></li><li><a href="#joinjsonpath">joinJsonPath</a></li><li><a href="#late">late</a></li><li><a href="#lazy">lazy</a></li><li><a href="#literal">literal</a></li><li><a href="#map">map</a></li><li><a href="#maybe">maybe</a></li><li><a href="#maybenull">maybeNull</a></li><li><a href="#model">model</a></li><li><a href="#onaction">onAction</a></li><li><a href="#onpatch">onPatch</a></li><li><a href="#onsnapshot">onSnapshot</a></li><li><a href="#optional">optional</a></li><li><a href="#protect">protect</a></li><li><a href="#recordactions">recordActions</a></li><li><a href="#recordpatches">recordPatches</a></li><li><a href="#reference">reference</a></li><li><a href="#refinement">refinement</a></li><li><a href="#resolveidentifier">resolveIdentifier</a></li><li><a href="#resolvepath">resolvePath</a></li><li><a href="#safereference">safeReference</a></li><li><a href="#setlivelinesschecking">setLivelinessChecking</a></li><li><a href="#snapshotprocessor">snapshotProcessor</a></li><li><a href="#splitjsonpath">splitJsonPath</a></li><li><a href="#togenerator">toGenerator</a></li><li><a href="#togeneratorfunction">toGeneratorFunction</a></li><li><a href="#tryreference">tryReference</a></li><li><a href="#tryresolve">tryResolve</a></li><li><a href="#typecheck">typecheck</a></li><li><a href="#unescapejsonpath">unescapeJsonPath</a></li><li><a href="#union">union</a></li><li><a href="#unprotect">unprotect</a></li><li><a href="#walk">walk</a></li></ul></li><li><a href="#object-literals-1">Object literals</a><ul class="toc-headings"><li><a href="#const-types"><code>Const</code> types</a></li><li><a href="#-types-object">▪ <strong>types</strong>: <em>object</em></a></li><li><a href="#date">Date</a></li><li><a href="#array-1">array</a></li><li><a href="#boolean">boolean</a></li><li><a href="#compose-1">compose</a></li><li><a href="#custom-1">custom</a></li><li><a href="#enumeration-1">enumeration</a></li><li><a href="#finite">finite</a></li><li><a href="#float">float</a></li><li><a href="#frozen-1">frozen</a></li><li><a href="#identifier">identifier</a></li><li><a href="#identifiernumber">identifierNumber</a></li><li><a href="#integer">integer</a></li><li><a href="#late-1">late</a></li><li><a href="#lazy-1">lazy</a></li><li><a href="#literal-1">literal</a></li><li><a href="#map-1">map</a></li><li><a href="#maybe-1">maybe</a></li><li><a href="#maybenull-1">maybeNull</a></li><li><a href="#model-1">model</a></li><li><a href="#null">null</a></li><li><a href="#number">number</a></li><li><a href="#optional-1">optional</a></li><li><a href="#reference-1">reference</a></li><li><a href="#refinement-1">refinement</a></li><li><a href="#safereference-1">safeReference</a></li><li><a href="#snapshotprocessor-1">snapshotProcessor</a></li><li><a href="#string">string</a></li><li><a href="#undefined">undefined</a></li><li><a href="#union-1">union</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; diff --git a/API/interfaces/customtypeoptions.html b/API/interfaces/customtypeoptions.html index 2060aebaa..5e2f7ccc3 100644 --- a/API/interfaces/customtypeoptions.html +++ b/API/interfaces/customtypeoptions.html @@ -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, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/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.2](/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, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.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 - v6.0.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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">CustomTypeOptions</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/customtypeoptions">CustomTypeOptions</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">CustomTypeOptions</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.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> @@ -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/700ab6f8/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/72f4f644/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/700ab6f8/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/72f4f644/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> @@ -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/700ab6f8/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/72f4f644/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> @@ -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/700ab6f8/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/72f4f644/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> @@ -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/700ab6f8/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/72f4f644/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> diff --git a/API/interfaces/customtypeoptions/index.html b/API/interfaces/customtypeoptions/index.html index 2060aebaa..5e2f7ccc3 100644 --- a/API/interfaces/customtypeoptions/index.html +++ b/API/interfaces/customtypeoptions/index.html @@ -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, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/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.2](/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, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.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 - v6.0.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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">CustomTypeOptions</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/customtypeoptions">CustomTypeOptions</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">CustomTypeOptions</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.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> @@ -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/700ab6f8/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/72f4f644/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/700ab6f8/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/72f4f644/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> @@ -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/700ab6f8/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/72f4f644/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> @@ -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/700ab6f8/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/72f4f644/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> @@ -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/700ab6f8/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/72f4f644/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> diff --git a/API/interfaces/functionwithflag.html b/API/interfaces/functionwithflag.html index d79b76368..4b544ce2f 100644 --- a/API/interfaces/functionwithflag.html +++ b/API/interfaces/functionwithflag.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>FunctionWithFlag · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [FunctionWithFlag](/API/interfaces/functionwithflag)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="FunctionWithFlag · 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.2](/API/) › [FunctionWithFlag](/API/interfaces/functionwithflag)"/><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>FunctionWithFlag · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [FunctionWithFlag](/API/interfaces/functionwithflag)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="FunctionWithFlag · 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 - v6.0.0](/API/) › [FunctionWithFlag](/API/interfaces/functionwithflag)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/functionwithflag.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">FunctionWithFlag</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/functionwithflag">FunctionWithFlag</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/functionwithflag.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">FunctionWithFlag</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/functionwithflag">FunctionWithFlag</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><p>Function</p> @@ -72,6 +72,7 @@ <h2><a class="anchor" aria-hidden="true" id="index"></a><a href="#index" aria-hi <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#properties" 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</h3> <ul> <li><a href="/API/interfaces/functionwithflag#function">Function</a></li> +<li><a href="/API/interfaces/functionwithflag#[symbol.metadata]">[Symbol.metadata]</a></li> <li><a href="/API/interfaces/functionwithflag#optional-_isflowaction">_isFlowAction</a></li> <li><a href="/API/interfaces/functionwithflag#optional-_ismstaction">_isMSTAction</a></li> <li><a href="/API/interfaces/functionwithflag#arguments">arguments</a></li> @@ -91,46 +92,51 @@ <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="function"></a><a href="#function" 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>Function</h3> <p>• <strong>Function</strong>: <em>FunctionConstructor</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:316</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:319</p> +<hr> +<h3><a class="anchor" aria-hidden="true" id="symbolmetadata"></a><a href="#symbolmetadata" 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>[Symbol.metadata]</h3> +<p>• <strong>[Symbol.metadata]</strong>: <em>DecoratorMetadata | null</em></p> +<p><em>Inherited from void</em></p> +<p>Defined in node_modules/typescript/lib/lib.esnext.decorators.d.ts:27</p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-_isflowaction"></a><a href="#optional-_isflowaction" 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><code>Optional</code> _isFlowAction</h3> <p>• <strong>_isFlowAction</strong>? : <em>undefined | false | true</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L42">src/core/action.ts:42</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L42">src/core/action.ts:42</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-_ismstaction"></a><a href="#optional-_ismstaction" 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><code>Optional</code> _isMSTAction</h3> <p>• <strong>_isMSTAction</strong>? : <em>undefined | false | true</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L41">src/core/action.ts:41</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L41">src/core/action.ts:41</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="arguments"></a><a href="#arguments" 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>arguments</h3> <p>• <strong>arguments</strong>: <em>any</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:302</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:305</p> <hr> <h3><a class="anchor" aria-hidden="true" id="caller"></a><a href="#caller" 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>caller</h3> <p>• <strong>caller</strong>: <em>Function</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:303</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:306</p> <hr> <h3><a class="anchor" aria-hidden="true" id="length"></a><a href="#length" 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>length</h3> <p>• <strong>length</strong>: <em>number</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:299</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:302</p> <hr> <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>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:97</p> +<p>Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:95</p> <p>Returns the name of the function. Function names are read-only and can not be changed.</p> <hr> <h3><a class="anchor" aria-hidden="true" id="prototype"></a><a href="#prototype" 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>prototype</h3> <p>• <strong>prototype</strong>: <em>any</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:298</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:301</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="symbolhasinstance"></a><a href="#symbolhasinstance" 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>[Symbol.hasInstance]</h3> <p>▸ <strong>[Symbol.hasInstance]</strong>(<code>value</code>: any): <em>boolean</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:157</p> +<p>Defined in node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:164</p> <p>Determines whether the given value inherits from this function if this function was used as a constructor function.</p> <p>A constructor function can control which objects are recognized as its instances by @@ -149,7 +155,7 @@ <h3><a class="anchor" aria-hidden="true" id="symbolhasinstance"></a><a href="#sy <h3><a class="anchor" aria-hidden="true" id="apply"></a><a href="#apply" 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>apply</h3> <p>▸ <strong>apply</strong>(<code>this</code>: Function, <code>thisArg</code>: any, <code>argArray?</code>: any): <em>any</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:278</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:281</p> <p>Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.</p> <p><strong>Parameters:</strong></p> <table> @@ -167,7 +173,7 @@ <h3><a class="anchor" aria-hidden="true" id="apply"></a><a href="#apply" aria-hi <h3><a class="anchor" aria-hidden="true" id="bind"></a><a href="#bind" 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>bind</h3> <p>▸ <strong>bind</strong>(<code>this</code>: Function, <code>thisArg</code>: any, ...<code>argArray</code>: any[]): <em>any</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:293</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:296</p> <p>For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.</p> <p><strong>Parameters:</strong></p> @@ -186,7 +192,7 @@ <h3><a class="anchor" aria-hidden="true" id="bind"></a><a href="#bind" aria-hidd <h3><a class="anchor" aria-hidden="true" id="call"></a><a href="#call" 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>call</h3> <p>▸ <strong>call</strong>(<code>this</code>: Function, <code>thisArg</code>: any, ...<code>argArray</code>: any[]): <em>any</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:285</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:288</p> <p>Calls a method of an object, substituting another object for the current object.</p> <p><strong>Parameters:</strong></p> <table> @@ -204,10 +210,10 @@ <h3><a class="anchor" aria-hidden="true" id="call"></a><a href="#call" aria-hidd <h3><a class="anchor" aria-hidden="true" id="tostring"></a><a href="#tostring" 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>toString</h3> <p>▸ <strong>toString</strong>(): <em>string</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:296</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:299</p> <p>Returns a string representation of a function.</p> <p><strong>Returns:</strong> <em>string</em></p> -</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/customtypeoptions"><span class="arrow-prev">← </span><span class="function-name-prevnext">CustomTypeOptions</span></a><a class="docs-next button" href="/API/interfaces/iactioncontext"><span class="function-name-prevnext">IActionContext</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><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="#function">Function</a></li><li><a href="#optional-_isflowaction"><code>Optional</code> _isFlowAction</a></li><li><a href="#optional-_ismstaction"><code>Optional</code> _isMSTAction</a></li><li><a href="#arguments">arguments</a></li><li><a href="#caller">caller</a></li><li><a href="#length">length</a></li><li><a href="#name">name</a></li><li><a href="#prototype">prototype</a></li></ul></li><li><a href="#methods-1">Methods</a><ul class="toc-headings"><li><a href="#symbolhasinstance">[Symbol.hasInstance]</a></li><li><a href="#apply">apply</a></li><li><a href="#bind">bind</a></li><li><a href="#call">call</a></li><li><a href="#tostring">toString</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> +</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/customtypeoptions"><span class="arrow-prev">← </span><span class="function-name-prevnext">CustomTypeOptions</span></a><a class="docs-next button" href="/API/interfaces/iactioncontext"><span class="function-name-prevnext">IActionContext</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><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="#function">Function</a></li><li><a href="#symbolmetadata">[Symbol.metadata]</a></li><li><a href="#optional-_isflowaction"><code>Optional</code> _isFlowAction</a></li><li><a href="#optional-_ismstaction"><code>Optional</code> _isMSTAction</a></li><li><a href="#arguments">arguments</a></li><li><a href="#caller">caller</a></li><li><a href="#length">length</a></li><li><a href="#name">name</a></li><li><a href="#prototype">prototype</a></li></ul></li><li><a href="#methods-1">Methods</a><ul class="toc-headings"><li><a href="#symbolhasinstance">[Symbol.hasInstance]</a></li><li><a href="#apply">apply</a></li><li><a href="#bind">bind</a></li><li><a href="#call">call</a></li><li><a href="#tostring">toString</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; diff --git a/API/interfaces/functionwithflag/index.html b/API/interfaces/functionwithflag/index.html index d79b76368..4b544ce2f 100644 --- a/API/interfaces/functionwithflag/index.html +++ b/API/interfaces/functionwithflag/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>FunctionWithFlag · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [FunctionWithFlag](/API/interfaces/functionwithflag)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="FunctionWithFlag · 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.2](/API/) › [FunctionWithFlag](/API/interfaces/functionwithflag)"/><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>FunctionWithFlag · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [FunctionWithFlag](/API/interfaces/functionwithflag)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="FunctionWithFlag · 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 - v6.0.0](/API/) › [FunctionWithFlag](/API/interfaces/functionwithflag)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/functionwithflag.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">FunctionWithFlag</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/functionwithflag">FunctionWithFlag</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/functionwithflag.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">FunctionWithFlag</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/functionwithflag">FunctionWithFlag</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><p>Function</p> @@ -72,6 +72,7 @@ <h2><a class="anchor" aria-hidden="true" id="index"></a><a href="#index" aria-hi <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#properties" 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</h3> <ul> <li><a href="/API/interfaces/functionwithflag#function">Function</a></li> +<li><a href="/API/interfaces/functionwithflag#[symbol.metadata]">[Symbol.metadata]</a></li> <li><a href="/API/interfaces/functionwithflag#optional-_isflowaction">_isFlowAction</a></li> <li><a href="/API/interfaces/functionwithflag#optional-_ismstaction">_isMSTAction</a></li> <li><a href="/API/interfaces/functionwithflag#arguments">arguments</a></li> @@ -91,46 +92,51 @@ <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="function"></a><a href="#function" 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>Function</h3> <p>• <strong>Function</strong>: <em>FunctionConstructor</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:316</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:319</p> +<hr> +<h3><a class="anchor" aria-hidden="true" id="symbolmetadata"></a><a href="#symbolmetadata" 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>[Symbol.metadata]</h3> +<p>• <strong>[Symbol.metadata]</strong>: <em>DecoratorMetadata | null</em></p> +<p><em>Inherited from void</em></p> +<p>Defined in node_modules/typescript/lib/lib.esnext.decorators.d.ts:27</p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-_isflowaction"></a><a href="#optional-_isflowaction" 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><code>Optional</code> _isFlowAction</h3> <p>• <strong>_isFlowAction</strong>? : <em>undefined | false | true</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L42">src/core/action.ts:42</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L42">src/core/action.ts:42</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-_ismstaction"></a><a href="#optional-_ismstaction" 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><code>Optional</code> _isMSTAction</h3> <p>• <strong>_isMSTAction</strong>? : <em>undefined | false | true</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L41">src/core/action.ts:41</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L41">src/core/action.ts:41</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="arguments"></a><a href="#arguments" 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>arguments</h3> <p>• <strong>arguments</strong>: <em>any</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:302</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:305</p> <hr> <h3><a class="anchor" aria-hidden="true" id="caller"></a><a href="#caller" 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>caller</h3> <p>• <strong>caller</strong>: <em>Function</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:303</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:306</p> <hr> <h3><a class="anchor" aria-hidden="true" id="length"></a><a href="#length" 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>length</h3> <p>• <strong>length</strong>: <em>number</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:299</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:302</p> <hr> <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>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:97</p> +<p>Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:95</p> <p>Returns the name of the function. Function names are read-only and can not be changed.</p> <hr> <h3><a class="anchor" aria-hidden="true" id="prototype"></a><a href="#prototype" 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>prototype</h3> <p>• <strong>prototype</strong>: <em>any</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:298</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:301</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="symbolhasinstance"></a><a href="#symbolhasinstance" 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>[Symbol.hasInstance]</h3> <p>▸ <strong>[Symbol.hasInstance]</strong>(<code>value</code>: any): <em>boolean</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:157</p> +<p>Defined in node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:164</p> <p>Determines whether the given value inherits from this function if this function was used as a constructor function.</p> <p>A constructor function can control which objects are recognized as its instances by @@ -149,7 +155,7 @@ <h3><a class="anchor" aria-hidden="true" id="symbolhasinstance"></a><a href="#sy <h3><a class="anchor" aria-hidden="true" id="apply"></a><a href="#apply" 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>apply</h3> <p>▸ <strong>apply</strong>(<code>this</code>: Function, <code>thisArg</code>: any, <code>argArray?</code>: any): <em>any</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:278</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:281</p> <p>Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.</p> <p><strong>Parameters:</strong></p> <table> @@ -167,7 +173,7 @@ <h3><a class="anchor" aria-hidden="true" id="apply"></a><a href="#apply" aria-hi <h3><a class="anchor" aria-hidden="true" id="bind"></a><a href="#bind" 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>bind</h3> <p>▸ <strong>bind</strong>(<code>this</code>: Function, <code>thisArg</code>: any, ...<code>argArray</code>: any[]): <em>any</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:293</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:296</p> <p>For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.</p> <p><strong>Parameters:</strong></p> @@ -186,7 +192,7 @@ <h3><a class="anchor" aria-hidden="true" id="bind"></a><a href="#bind" aria-hidd <h3><a class="anchor" aria-hidden="true" id="call"></a><a href="#call" 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>call</h3> <p>▸ <strong>call</strong>(<code>this</code>: Function, <code>thisArg</code>: any, ...<code>argArray</code>: any[]): <em>any</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:285</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:288</p> <p>Calls a method of an object, substituting another object for the current object.</p> <p><strong>Parameters:</strong></p> <table> @@ -204,10 +210,10 @@ <h3><a class="anchor" aria-hidden="true" id="call"></a><a href="#call" aria-hidd <h3><a class="anchor" aria-hidden="true" id="tostring"></a><a href="#tostring" 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>toString</h3> <p>▸ <strong>toString</strong>(): <em>string</em></p> <p><em>Inherited from void</em></p> -<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:296</p> +<p>Defined in node_modules/typescript/lib/lib.es5.d.ts:299</p> <p>Returns a string representation of a function.</p> <p><strong>Returns:</strong> <em>string</em></p> -</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/customtypeoptions"><span class="arrow-prev">← </span><span class="function-name-prevnext">CustomTypeOptions</span></a><a class="docs-next button" href="/API/interfaces/iactioncontext"><span class="function-name-prevnext">IActionContext</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><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="#function">Function</a></li><li><a href="#optional-_isflowaction"><code>Optional</code> _isFlowAction</a></li><li><a href="#optional-_ismstaction"><code>Optional</code> _isMSTAction</a></li><li><a href="#arguments">arguments</a></li><li><a href="#caller">caller</a></li><li><a href="#length">length</a></li><li><a href="#name">name</a></li><li><a href="#prototype">prototype</a></li></ul></li><li><a href="#methods-1">Methods</a><ul class="toc-headings"><li><a href="#symbolhasinstance">[Symbol.hasInstance]</a></li><li><a href="#apply">apply</a></li><li><a href="#bind">bind</a></li><li><a href="#call">call</a></li><li><a href="#tostring">toString</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> +</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/customtypeoptions"><span class="arrow-prev">← </span><span class="function-name-prevnext">CustomTypeOptions</span></a><a class="docs-next button" href="/API/interfaces/iactioncontext"><span class="function-name-prevnext">IActionContext</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><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="#function">Function</a></li><li><a href="#symbolmetadata">[Symbol.metadata]</a></li><li><a href="#optional-_isflowaction"><code>Optional</code> _isFlowAction</a></li><li><a href="#optional-_ismstaction"><code>Optional</code> _isMSTAction</a></li><li><a href="#arguments">arguments</a></li><li><a href="#caller">caller</a></li><li><a href="#length">length</a></li><li><a href="#name">name</a></li><li><a href="#prototype">prototype</a></li></ul></li><li><a href="#methods-1">Methods</a><ul class="toc-headings"><li><a href="#symbolhasinstance">[Symbol.hasInstance]</a></li><li><a href="#apply">apply</a></li><li><a href="#bind">bind</a></li><li><a href="#call">call</a></li><li><a href="#tostring">toString</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; diff --git a/API/interfaces/iactioncontext.html b/API/interfaces/iactioncontext.html index 86ddde4f9..4f54dfb25 100644 --- a/API/interfaces/iactioncontext.html +++ b/API/interfaces/iactioncontext.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IActionContext · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IActionContext](/API/interfaces/iactioncontext)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionContext · 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.2](/API/) › [IActionContext](/API/interfaces/iactioncontext)"/><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>IActionContext · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IActionContext](/API/interfaces/iactioncontext)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionContext · 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 - v6.0.0](/API/) › [IActionContext](/API/interfaces/iactioncontext)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/iactioncontext.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionContext</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/iactioncontext">IActionContext</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/iactioncontext.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionContext</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/iactioncontext">IActionContext</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><p><strong>IActionContext</strong></p> @@ -81,32 +81,32 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="args"></a><a href="#args" 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>args</h3> <p>• <strong>args</strong>: <em>any[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L20">src/core/actionContext.ts:20</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L20">src/core/actionContext.ts:20</a></em></p> <p>Event arguments in an array (action arguments for actions)</p> <hr> <h3><a class="anchor" aria-hidden="true" id="context"></a><a href="#context" 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>context</h3> <p>• <strong>context</strong>: <em>IAnyStateTreeNode</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L15">src/core/actionContext.ts:15</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L15">src/core/actionContext.ts:15</a></em></p> <p>Event context (node where the action was invoked)</p> <hr> <h3><a class="anchor" aria-hidden="true" id="id"></a><a href="#id" 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>id</h3> <p>• <strong>id</strong>: <em>number</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L9">src/core/actionContext.ts:9</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L9">src/core/actionContext.ts:9</a></em></p> <p>Event unique id</p> <hr> <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/700ab6f8/src/core/actionContext.ts#L6">src/core/actionContext.ts:6</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L6">src/core/actionContext.ts:6</a></em></p> <p>Event name (action name for actions)</p> <hr> <h3><a class="anchor" aria-hidden="true" id="parentactionevent"></a><a href="#parentactionevent" 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>parentActionEvent</h3> <p>• <strong>parentActionEvent</strong>: <em><a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a> | undefined</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L12">src/core/actionContext.ts:12</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L12">src/core/actionContext.ts:12</a></em></p> <p>Parent action event object</p> <hr> <h3><a class="anchor" aria-hidden="true" id="tree"></a><a href="#tree" 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>tree</h3> <p>• <strong>tree</strong>: <em>IAnyStateTreeNode</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L17">src/core/actionContext.ts:17</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L17">src/core/actionContext.ts:17</a></em></p> <p>Event tree (root node of the node where the action was invoked)</p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/functionwithflag"><span class="arrow-prev">← </span><span class="function-name-prevnext">FunctionWithFlag</span></a><a class="docs-next button" href="/API/interfaces/iactionrecorder"><span class="function-name-prevnext">IActionRecorder</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#args">args</a></li><li><a href="#context">context</a></li><li><a href="#id">id</a></li><li><a href="#name">name</a></li><li><a href="#parentactionevent">parentActionEvent</a></li><li><a href="#tree">tree</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) { diff --git a/API/interfaces/iactioncontext/index.html b/API/interfaces/iactioncontext/index.html index 86ddde4f9..4f54dfb25 100644 --- a/API/interfaces/iactioncontext/index.html +++ b/API/interfaces/iactioncontext/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IActionContext · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IActionContext](/API/interfaces/iactioncontext)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionContext · 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.2](/API/) › [IActionContext](/API/interfaces/iactioncontext)"/><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>IActionContext · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IActionContext](/API/interfaces/iactioncontext)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionContext · 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 - v6.0.0](/API/) › [IActionContext](/API/interfaces/iactioncontext)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/iactioncontext.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionContext</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/iactioncontext">IActionContext</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/iactioncontext.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionContext</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/iactioncontext">IActionContext</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><p><strong>IActionContext</strong></p> @@ -81,32 +81,32 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="args"></a><a href="#args" 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>args</h3> <p>• <strong>args</strong>: <em>any[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L20">src/core/actionContext.ts:20</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L20">src/core/actionContext.ts:20</a></em></p> <p>Event arguments in an array (action arguments for actions)</p> <hr> <h3><a class="anchor" aria-hidden="true" id="context"></a><a href="#context" 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>context</h3> <p>• <strong>context</strong>: <em>IAnyStateTreeNode</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L15">src/core/actionContext.ts:15</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L15">src/core/actionContext.ts:15</a></em></p> <p>Event context (node where the action was invoked)</p> <hr> <h3><a class="anchor" aria-hidden="true" id="id"></a><a href="#id" 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>id</h3> <p>• <strong>id</strong>: <em>number</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L9">src/core/actionContext.ts:9</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L9">src/core/actionContext.ts:9</a></em></p> <p>Event unique id</p> <hr> <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/700ab6f8/src/core/actionContext.ts#L6">src/core/actionContext.ts:6</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L6">src/core/actionContext.ts:6</a></em></p> <p>Event name (action name for actions)</p> <hr> <h3><a class="anchor" aria-hidden="true" id="parentactionevent"></a><a href="#parentactionevent" 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>parentActionEvent</h3> <p>• <strong>parentActionEvent</strong>: <em><a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a> | undefined</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L12">src/core/actionContext.ts:12</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L12">src/core/actionContext.ts:12</a></em></p> <p>Parent action event object</p> <hr> <h3><a class="anchor" aria-hidden="true" id="tree"></a><a href="#tree" 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>tree</h3> <p>• <strong>tree</strong>: <em>IAnyStateTreeNode</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L17">src/core/actionContext.ts:17</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L17">src/core/actionContext.ts:17</a></em></p> <p>Event tree (root node of the node where the action was invoked)</p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/functionwithflag"><span class="arrow-prev">← </span><span class="function-name-prevnext">FunctionWithFlag</span></a><a class="docs-next button" href="/API/interfaces/iactionrecorder"><span class="function-name-prevnext">IActionRecorder</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#args">args</a></li><li><a href="#context">context</a></li><li><a href="#id">id</a></li><li><a href="#name">name</a></li><li><a href="#parentactionevent">parentActionEvent</a></li><li><a href="#tree">tree</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) { diff --git a/API/interfaces/iactionrecorder.html b/API/interfaces/iactionrecorder.html index 8947c7c7c..b42e56f5e 100644 --- a/API/interfaces/iactionrecorder.html +++ b/API/interfaces/iactionrecorder.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IActionRecorder · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IActionRecorder](/API/interfaces/iactionrecorder)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionRecorder · 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.2](/API/) › [IActionRecorder](/API/interfaces/iactionrecorder)"/><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>IActionRecorder · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IActionRecorder](/API/interfaces/iactionrecorder)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionRecorder · 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 - v6.0.0](/API/) › [IActionRecorder](/API/interfaces/iactionrecorder)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/iactionrecorder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionRecorder</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/iactionrecorder">IActionRecorder</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/iactionrecorder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionRecorder</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/iactionrecorder">IActionRecorder</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><strong>IActionRecorder</strong></li> @@ -82,15 +82,15 @@ <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="actions"></a><a href="#actions" 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>actions</h3> <p>• <strong>actions</strong>: <em>ReadonlyArray‹<a href="/API/interfaces/iserializedactioncall">ISerializedActionCall</a>›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L37">src/middlewares/on-action.ts:37</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L37">src/middlewares/on-action.ts:37</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="recording"></a><a href="#recording" 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>recording</h3> <p>• <strong>recording</strong>: <em>boolean</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L38">src/middlewares/on-action.ts:38</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L38">src/middlewares/on-action.ts:38</a></em></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="replay"></a><a href="#replay" 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>replay</h3> <p>▸ <strong>replay</strong>(<code>target</code>: IAnyStateTreeNode): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L41">src/middlewares/on-action.ts:41</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L41">src/middlewares/on-action.ts:41</a></em></p> <p><strong>Parameters:</strong></p> <table> <thead> @@ -104,12 +104,12 @@ <h3><a class="anchor" aria-hidden="true" id="replay"></a><a href="#replay" aria- <hr> <h3><a class="anchor" aria-hidden="true" id="resume"></a><a href="#resume" 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>resume</h3> <p>▸ <strong>resume</strong>(): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L40">src/middlewares/on-action.ts:40</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L40">src/middlewares/on-action.ts:40</a></em></p> <p><strong>Returns:</strong> <em>void</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="stop"></a><a href="#stop" 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>stop</h3> <p>▸ <strong>stop</strong>(): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L39">src/middlewares/on-action.ts:39</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L39">src/middlewares/on-action.ts:39</a></em></p> <p><strong>Returns:</strong> <em>void</em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/iactioncontext"><span class="arrow-prev">← </span><span class="function-name-prevnext">IActionContext</span></a><a class="docs-next button" href="/API/interfaces/iactiontrackingmiddleware2call"><span class="function-name-prevnext">IActionTrackingMiddleware2Call</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><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="#actions">actions</a></li><li><a href="#recording">recording</a></li></ul></li><li><a href="#methods-1">Methods</a><ul class="toc-headings"><li><a href="#replay">replay</a></li><li><a href="#resume">resume</a></li><li><a href="#stop">stop</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) { diff --git a/API/interfaces/iactionrecorder/index.html b/API/interfaces/iactionrecorder/index.html index 8947c7c7c..b42e56f5e 100644 --- a/API/interfaces/iactionrecorder/index.html +++ b/API/interfaces/iactionrecorder/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IActionRecorder · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IActionRecorder](/API/interfaces/iactionrecorder)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionRecorder · 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.2](/API/) › [IActionRecorder](/API/interfaces/iactionrecorder)"/><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>IActionRecorder · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IActionRecorder](/API/interfaces/iactionrecorder)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionRecorder · 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 - v6.0.0](/API/) › [IActionRecorder](/API/interfaces/iactionrecorder)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/iactionrecorder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionRecorder</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/iactionrecorder">IActionRecorder</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/iactionrecorder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionRecorder</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/iactionrecorder">IActionRecorder</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><strong>IActionRecorder</strong></li> @@ -82,15 +82,15 @@ <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="actions"></a><a href="#actions" 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>actions</h3> <p>• <strong>actions</strong>: <em>ReadonlyArray‹<a href="/API/interfaces/iserializedactioncall">ISerializedActionCall</a>›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L37">src/middlewares/on-action.ts:37</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L37">src/middlewares/on-action.ts:37</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="recording"></a><a href="#recording" 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>recording</h3> <p>• <strong>recording</strong>: <em>boolean</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L38">src/middlewares/on-action.ts:38</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L38">src/middlewares/on-action.ts:38</a></em></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="replay"></a><a href="#replay" 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>replay</h3> <p>▸ <strong>replay</strong>(<code>target</code>: IAnyStateTreeNode): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L41">src/middlewares/on-action.ts:41</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L41">src/middlewares/on-action.ts:41</a></em></p> <p><strong>Parameters:</strong></p> <table> <thead> @@ -104,12 +104,12 @@ <h3><a class="anchor" aria-hidden="true" id="replay"></a><a href="#replay" aria- <hr> <h3><a class="anchor" aria-hidden="true" id="resume"></a><a href="#resume" 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>resume</h3> <p>▸ <strong>resume</strong>(): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L40">src/middlewares/on-action.ts:40</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L40">src/middlewares/on-action.ts:40</a></em></p> <p><strong>Returns:</strong> <em>void</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="stop"></a><a href="#stop" 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>stop</h3> <p>▸ <strong>stop</strong>(): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L39">src/middlewares/on-action.ts:39</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L39">src/middlewares/on-action.ts:39</a></em></p> <p><strong>Returns:</strong> <em>void</em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/iactioncontext"><span class="arrow-prev">← </span><span class="function-name-prevnext">IActionContext</span></a><a class="docs-next button" href="/API/interfaces/iactiontrackingmiddleware2call"><span class="function-name-prevnext">IActionTrackingMiddleware2Call</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><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="#actions">actions</a></li><li><a href="#recording">recording</a></li></ul></li><li><a href="#methods-1">Methods</a><ul class="toc-headings"><li><a href="#replay">replay</a></li><li><a href="#resume">resume</a></li><li><a href="#stop">stop</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) { diff --git a/API/interfaces/iactiontrackingmiddleware2call.html b/API/interfaces/iactiontrackingmiddleware2call.html index b1b69f885..c9b6b294f 100644 --- a/API/interfaces/iactiontrackingmiddleware2call.html +++ b/API/interfaces/iactiontrackingmiddleware2call.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IActionTrackingMiddleware2Call · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IActionTrackingMiddleware2Call](/API/interfaces/iactiontrackingmiddleware2call)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionTrackingMiddleware2Call · 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.2](/API/) › [IActionTrackingMiddleware2Call](/API/interfaces/iactiontrackingmiddleware2call)"/><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>IActionTrackingMiddleware2Call · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IActionTrackingMiddleware2Call](/API/interfaces/iactiontrackingmiddleware2call)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionTrackingMiddleware2Call · 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 - v6.0.0](/API/) › [IActionTrackingMiddleware2Call](/API/interfaces/iactiontrackingmiddleware2call)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/iactiontrackingmiddleware2call.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionTrackingMiddleware2Call</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/iactiontrackingmiddleware2call">IActionTrackingMiddleware2Call</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/iactiontrackingmiddleware2call.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionTrackingMiddleware2Call</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/iactiontrackingmiddleware2call">IActionTrackingMiddleware2Call</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>TEnv</strong></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> @@ -79,11 +79,11 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="env"></a><a href="#env" 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>env</h3> <p>• <strong>env</strong>: <em>TEnv | undefined</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/createActionTrackingMiddleware2.ts#L6">src/middlewares/createActionTrackingMiddleware2.ts:6</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/createActionTrackingMiddleware2.ts#L4">src/middlewares/createActionTrackingMiddleware2.ts:4</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-parentcall"></a><a href="#optional-parentcall" 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><code>Optional</code> parentCall</h3> <p>• <strong>parentCall</strong>? : <em><a href="/API/interfaces/iactiontrackingmiddleware2call">IActionTrackingMiddleware2Call</a>‹TEnv›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/createActionTrackingMiddleware2.ts#L7">src/middlewares/createActionTrackingMiddleware2.ts:7</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/createActionTrackingMiddleware2.ts#L5">src/middlewares/createActionTrackingMiddleware2.ts:5</a></em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/iactionrecorder"><span class="arrow-prev">← </span><span class="function-name-prevnext">IActionRecorder</span></a><a class="docs-next button" href="/API/interfaces/iactiontrackingmiddleware2hooks"><span class="function-name-prevnext">IActionTrackingMiddleware2Hooks</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></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#env">env</a></li><li><a href="#optional-parentcall"><code>Optional</code> parentCall</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) { diff --git a/API/interfaces/iactiontrackingmiddleware2call/index.html b/API/interfaces/iactiontrackingmiddleware2call/index.html index b1b69f885..c9b6b294f 100644 --- a/API/interfaces/iactiontrackingmiddleware2call/index.html +++ b/API/interfaces/iactiontrackingmiddleware2call/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IActionTrackingMiddleware2Call · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IActionTrackingMiddleware2Call](/API/interfaces/iactiontrackingmiddleware2call)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionTrackingMiddleware2Call · 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.2](/API/) › [IActionTrackingMiddleware2Call](/API/interfaces/iactiontrackingmiddleware2call)"/><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>IActionTrackingMiddleware2Call · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IActionTrackingMiddleware2Call](/API/interfaces/iactiontrackingmiddleware2call)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionTrackingMiddleware2Call · 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 - v6.0.0](/API/) › [IActionTrackingMiddleware2Call](/API/interfaces/iactiontrackingmiddleware2call)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/iactiontrackingmiddleware2call.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionTrackingMiddleware2Call</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/iactiontrackingmiddleware2call">IActionTrackingMiddleware2Call</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/iactiontrackingmiddleware2call.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionTrackingMiddleware2Call</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/iactiontrackingmiddleware2call">IActionTrackingMiddleware2Call</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>TEnv</strong></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> @@ -79,11 +79,11 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="env"></a><a href="#env" 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>env</h3> <p>• <strong>env</strong>: <em>TEnv | undefined</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/createActionTrackingMiddleware2.ts#L6">src/middlewares/createActionTrackingMiddleware2.ts:6</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/createActionTrackingMiddleware2.ts#L4">src/middlewares/createActionTrackingMiddleware2.ts:4</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-parentcall"></a><a href="#optional-parentcall" 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><code>Optional</code> parentCall</h3> <p>• <strong>parentCall</strong>? : <em><a href="/API/interfaces/iactiontrackingmiddleware2call">IActionTrackingMiddleware2Call</a>‹TEnv›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/createActionTrackingMiddleware2.ts#L7">src/middlewares/createActionTrackingMiddleware2.ts:7</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/createActionTrackingMiddleware2.ts#L5">src/middlewares/createActionTrackingMiddleware2.ts:5</a></em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/iactionrecorder"><span class="arrow-prev">← </span><span class="function-name-prevnext">IActionRecorder</span></a><a class="docs-next button" href="/API/interfaces/iactiontrackingmiddleware2hooks"><span class="function-name-prevnext">IActionTrackingMiddleware2Hooks</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></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#env">env</a></li><li><a href="#optional-parentcall"><code>Optional</code> parentCall</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) { diff --git a/API/interfaces/iactiontrackingmiddleware2hooks.html b/API/interfaces/iactiontrackingmiddleware2hooks.html index 2c5dabfdf..146d29657 100644 --- a/API/interfaces/iactiontrackingmiddleware2hooks.html +++ b/API/interfaces/iactiontrackingmiddleware2hooks.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IActionTrackingMiddleware2Hooks · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IActionTrackingMiddleware2Hooks](/API/interfaces/iactiontrackingmiddleware2hooks)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionTrackingMiddleware2Hooks · 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.2](/API/) › [IActionTrackingMiddleware2Hooks](/API/interfaces/iactiontrackingmiddleware2hooks)"/><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>IActionTrackingMiddleware2Hooks · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IActionTrackingMiddleware2Hooks](/API/interfaces/iactiontrackingmiddleware2hooks)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionTrackingMiddleware2Hooks · 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 - v6.0.0](/API/) › [IActionTrackingMiddleware2Hooks](/API/interfaces/iactiontrackingmiddleware2hooks)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/iactiontrackingmiddleware2hooks.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionTrackingMiddleware2Hooks</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/iactiontrackingmiddleware2hooks">IActionTrackingMiddleware2Hooks</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/iactiontrackingmiddleware2hooks.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionTrackingMiddleware2Hooks</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/iactiontrackingmiddleware2hooks">IActionTrackingMiddleware2Hooks</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>TEnv</strong></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> @@ -79,11 +79,11 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="optional-filter"></a><a href="#optional-filter" 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><code>Optional</code> filter</h3> <p>• <strong>filter</strong>? : <em>undefined | function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/createActionTrackingMiddleware2.ts#L11">src/middlewares/createActionTrackingMiddleware2.ts:11</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/createActionTrackingMiddleware2.ts#L9">src/middlewares/createActionTrackingMiddleware2.ts:9</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="onfinish"></a><a href="#onfinish" 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>onFinish</h3> <p>• <strong>onFinish</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/createActionTrackingMiddleware2.ts#L13">src/middlewares/createActionTrackingMiddleware2.ts:13</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/createActionTrackingMiddleware2.ts#L11">src/middlewares/createActionTrackingMiddleware2.ts:11</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration"></a><a href="#type-declaration" 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 declaration:</h4> <p>▸ (<code>call</code>: <a href="/API/interfaces/iactiontrackingmiddleware2call">IActionTrackingMiddleware2Call</a>‹TEnv›, <code>error?</code>: any): <em>void</em></p> <p><strong>Parameters:</strong></p> @@ -99,7 +99,7 @@ <h4><a class="anchor" aria-hidden="true" id="type-declaration"></a><a href="#typ <hr> <h3><a class="anchor" aria-hidden="true" id="onstart"></a><a href="#onstart" 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>onStart</h3> <p>• <strong>onStart</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/createActionTrackingMiddleware2.ts#L12">src/middlewares/createActionTrackingMiddleware2.ts:12</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/createActionTrackingMiddleware2.ts#L10">src/middlewares/createActionTrackingMiddleware2.ts:10</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration-1"></a><a href="#type-declaration-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>Type declaration:</h4> <p>▸ (<code>call</code>: <a href="/API/interfaces/iactiontrackingmiddleware2call">IActionTrackingMiddleware2Call</a>‹TEnv›): <em>void</em></p> <p><strong>Parameters:</strong></p> diff --git a/API/interfaces/iactiontrackingmiddleware2hooks/index.html b/API/interfaces/iactiontrackingmiddleware2hooks/index.html index 2c5dabfdf..146d29657 100644 --- a/API/interfaces/iactiontrackingmiddleware2hooks/index.html +++ b/API/interfaces/iactiontrackingmiddleware2hooks/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IActionTrackingMiddleware2Hooks · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IActionTrackingMiddleware2Hooks](/API/interfaces/iactiontrackingmiddleware2hooks)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionTrackingMiddleware2Hooks · 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.2](/API/) › [IActionTrackingMiddleware2Hooks](/API/interfaces/iactiontrackingmiddleware2hooks)"/><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>IActionTrackingMiddleware2Hooks · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IActionTrackingMiddleware2Hooks](/API/interfaces/iactiontrackingmiddleware2hooks)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionTrackingMiddleware2Hooks · 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 - v6.0.0](/API/) › [IActionTrackingMiddleware2Hooks](/API/interfaces/iactiontrackingmiddleware2hooks)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/iactiontrackingmiddleware2hooks.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionTrackingMiddleware2Hooks</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/iactiontrackingmiddleware2hooks">IActionTrackingMiddleware2Hooks</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/iactiontrackingmiddleware2hooks.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionTrackingMiddleware2Hooks</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/iactiontrackingmiddleware2hooks">IActionTrackingMiddleware2Hooks</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>TEnv</strong></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> @@ -79,11 +79,11 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="optional-filter"></a><a href="#optional-filter" 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><code>Optional</code> filter</h3> <p>• <strong>filter</strong>? : <em>undefined | function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/createActionTrackingMiddleware2.ts#L11">src/middlewares/createActionTrackingMiddleware2.ts:11</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/createActionTrackingMiddleware2.ts#L9">src/middlewares/createActionTrackingMiddleware2.ts:9</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="onfinish"></a><a href="#onfinish" 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>onFinish</h3> <p>• <strong>onFinish</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/createActionTrackingMiddleware2.ts#L13">src/middlewares/createActionTrackingMiddleware2.ts:13</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/createActionTrackingMiddleware2.ts#L11">src/middlewares/createActionTrackingMiddleware2.ts:11</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration"></a><a href="#type-declaration" 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 declaration:</h4> <p>▸ (<code>call</code>: <a href="/API/interfaces/iactiontrackingmiddleware2call">IActionTrackingMiddleware2Call</a>‹TEnv›, <code>error?</code>: any): <em>void</em></p> <p><strong>Parameters:</strong></p> @@ -99,7 +99,7 @@ <h4><a class="anchor" aria-hidden="true" id="type-declaration"></a><a href="#typ <hr> <h3><a class="anchor" aria-hidden="true" id="onstart"></a><a href="#onstart" 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>onStart</h3> <p>• <strong>onStart</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/createActionTrackingMiddleware2.ts#L12">src/middlewares/createActionTrackingMiddleware2.ts:12</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/createActionTrackingMiddleware2.ts#L10">src/middlewares/createActionTrackingMiddleware2.ts:10</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration-1"></a><a href="#type-declaration-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>Type declaration:</h4> <p>▸ (<code>call</code>: <a href="/API/interfaces/iactiontrackingmiddleware2call">IActionTrackingMiddleware2Call</a>‹TEnv›): <em>void</em></p> <p><strong>Parameters:</strong></p> diff --git a/API/interfaces/iactiontrackingmiddlewarehooks.html b/API/interfaces/iactiontrackingmiddlewarehooks.html index 42d1f0bb2..8e07c162f 100644 --- a/API/interfaces/iactiontrackingmiddlewarehooks.html +++ b/API/interfaces/iactiontrackingmiddlewarehooks.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IActionTrackingMiddlewareHooks · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IActionTrackingMiddlewareHooks](/API/interfaces/iactiontrackingmiddlewarehooks)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionTrackingMiddlewareHooks · 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.2](/API/) › [IActionTrackingMiddlewareHooks](/API/interfaces/iactiontrackingmiddlewarehooks)"/><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>IActionTrackingMiddlewareHooks · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IActionTrackingMiddlewareHooks](/API/interfaces/iactiontrackingmiddlewarehooks)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionTrackingMiddlewareHooks · 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 - v6.0.0](/API/) › [IActionTrackingMiddlewareHooks](/API/interfaces/iactiontrackingmiddlewarehooks)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/iactiontrackingmiddlewarehooks.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionTrackingMiddlewareHooks</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/iactiontrackingmiddlewarehooks">IActionTrackingMiddlewareHooks</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/iactiontrackingmiddlewarehooks.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionTrackingMiddlewareHooks</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/iactiontrackingmiddlewarehooks">IActionTrackingMiddlewareHooks</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>T</strong></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> @@ -82,11 +82,11 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="optional-filter"></a><a href="#optional-filter" 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><code>Optional</code> filter</h3> <p>• <strong>filter</strong>? : <em>undefined | function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/create-action-tracking-middleware.ts#L6">src/middlewares/create-action-tracking-middleware.ts:6</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/create-action-tracking-middleware.ts#L6">src/middlewares/create-action-tracking-middleware.ts:6</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="onfail"></a><a href="#onfail" 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>onFail</h3> <p>• <strong>onFail</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/create-action-tracking-middleware.ts#L11">src/middlewares/create-action-tracking-middleware.ts:11</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/create-action-tracking-middleware.ts#L11">src/middlewares/create-action-tracking-middleware.ts:11</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration"></a><a href="#type-declaration" 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 declaration:</h4> <p>▸ (<code>call</code>: <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a>, <code>context</code>: T, <code>error</code>: any): <em>void</em></p> <p><strong>Parameters:</strong></p> @@ -103,7 +103,7 @@ <h4><a class="anchor" aria-hidden="true" id="type-declaration"></a><a href="#typ <hr> <h3><a class="anchor" aria-hidden="true" id="onresume"></a><a href="#onresume" 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>onResume</h3> <p>• <strong>onResume</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/create-action-tracking-middleware.ts#L8">src/middlewares/create-action-tracking-middleware.ts:8</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/create-action-tracking-middleware.ts#L8">src/middlewares/create-action-tracking-middleware.ts:8</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration-1"></a><a href="#type-declaration-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>Type declaration:</h4> <p>▸ (<code>call</code>: <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a>, <code>context</code>: T): <em>void</em></p> <p><strong>Parameters:</strong></p> @@ -119,7 +119,7 @@ <h4><a class="anchor" aria-hidden="true" id="type-declaration-1"></a><a href="#t <hr> <h3><a class="anchor" aria-hidden="true" id="onstart"></a><a href="#onstart" 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>onStart</h3> <p>• <strong>onStart</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/create-action-tracking-middleware.ts#L7">src/middlewares/create-action-tracking-middleware.ts:7</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/create-action-tracking-middleware.ts#L7">src/middlewares/create-action-tracking-middleware.ts:7</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration-2"></a><a href="#type-declaration-2" 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 declaration:</h4> <p>▸ (<code>call</code>: <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a>): <em>T</em></p> <p><strong>Parameters:</strong></p> @@ -134,7 +134,7 @@ <h4><a class="anchor" aria-hidden="true" id="type-declaration-2"></a><a href="#t <hr> <h3><a class="anchor" aria-hidden="true" id="onsuccess"></a><a href="#onsuccess" 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>onSuccess</h3> <p>• <strong>onSuccess</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/create-action-tracking-middleware.ts#L10">src/middlewares/create-action-tracking-middleware.ts:10</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/create-action-tracking-middleware.ts#L10">src/middlewares/create-action-tracking-middleware.ts:10</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration-3"></a><a href="#type-declaration-3" 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 declaration:</h4> <p>▸ (<code>call</code>: <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a>, <code>context</code>: T, <code>result</code>: any): <em>void</em></p> <p><strong>Parameters:</strong></p> @@ -151,7 +151,7 @@ <h4><a class="anchor" aria-hidden="true" id="type-declaration-3"></a><a href="#t <hr> <h3><a class="anchor" aria-hidden="true" id="onsuspend"></a><a href="#onsuspend" 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>onSuspend</h3> <p>• <strong>onSuspend</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/create-action-tracking-middleware.ts#L9">src/middlewares/create-action-tracking-middleware.ts:9</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/create-action-tracking-middleware.ts#L9">src/middlewares/create-action-tracking-middleware.ts:9</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration-4"></a><a href="#type-declaration-4" 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 declaration:</h4> <p>▸ (<code>call</code>: <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a>, <code>context</code>: T): <em>void</em></p> <p><strong>Parameters:</strong></p> diff --git a/API/interfaces/iactiontrackingmiddlewarehooks/index.html b/API/interfaces/iactiontrackingmiddlewarehooks/index.html index 42d1f0bb2..8e07c162f 100644 --- a/API/interfaces/iactiontrackingmiddlewarehooks/index.html +++ b/API/interfaces/iactiontrackingmiddlewarehooks/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IActionTrackingMiddlewareHooks · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IActionTrackingMiddlewareHooks](/API/interfaces/iactiontrackingmiddlewarehooks)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionTrackingMiddlewareHooks · 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.2](/API/) › [IActionTrackingMiddlewareHooks](/API/interfaces/iactiontrackingmiddlewarehooks)"/><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>IActionTrackingMiddlewareHooks · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IActionTrackingMiddlewareHooks](/API/interfaces/iactiontrackingmiddlewarehooks)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IActionTrackingMiddlewareHooks · 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 - v6.0.0](/API/) › [IActionTrackingMiddlewareHooks](/API/interfaces/iactiontrackingmiddlewarehooks)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/iactiontrackingmiddlewarehooks.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionTrackingMiddlewareHooks</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/iactiontrackingmiddlewarehooks">IActionTrackingMiddlewareHooks</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/iactiontrackingmiddlewarehooks.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IActionTrackingMiddlewareHooks</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/iactiontrackingmiddlewarehooks">IActionTrackingMiddlewareHooks</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>T</strong></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> @@ -82,11 +82,11 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="optional-filter"></a><a href="#optional-filter" 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><code>Optional</code> filter</h3> <p>• <strong>filter</strong>? : <em>undefined | function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/create-action-tracking-middleware.ts#L6">src/middlewares/create-action-tracking-middleware.ts:6</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/create-action-tracking-middleware.ts#L6">src/middlewares/create-action-tracking-middleware.ts:6</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="onfail"></a><a href="#onfail" 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>onFail</h3> <p>• <strong>onFail</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/create-action-tracking-middleware.ts#L11">src/middlewares/create-action-tracking-middleware.ts:11</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/create-action-tracking-middleware.ts#L11">src/middlewares/create-action-tracking-middleware.ts:11</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration"></a><a href="#type-declaration" 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 declaration:</h4> <p>▸ (<code>call</code>: <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a>, <code>context</code>: T, <code>error</code>: any): <em>void</em></p> <p><strong>Parameters:</strong></p> @@ -103,7 +103,7 @@ <h4><a class="anchor" aria-hidden="true" id="type-declaration"></a><a href="#typ <hr> <h3><a class="anchor" aria-hidden="true" id="onresume"></a><a href="#onresume" 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>onResume</h3> <p>• <strong>onResume</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/create-action-tracking-middleware.ts#L8">src/middlewares/create-action-tracking-middleware.ts:8</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/create-action-tracking-middleware.ts#L8">src/middlewares/create-action-tracking-middleware.ts:8</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration-1"></a><a href="#type-declaration-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>Type declaration:</h4> <p>▸ (<code>call</code>: <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a>, <code>context</code>: T): <em>void</em></p> <p><strong>Parameters:</strong></p> @@ -119,7 +119,7 @@ <h4><a class="anchor" aria-hidden="true" id="type-declaration-1"></a><a href="#t <hr> <h3><a class="anchor" aria-hidden="true" id="onstart"></a><a href="#onstart" 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>onStart</h3> <p>• <strong>onStart</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/create-action-tracking-middleware.ts#L7">src/middlewares/create-action-tracking-middleware.ts:7</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/create-action-tracking-middleware.ts#L7">src/middlewares/create-action-tracking-middleware.ts:7</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration-2"></a><a href="#type-declaration-2" 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 declaration:</h4> <p>▸ (<code>call</code>: <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a>): <em>T</em></p> <p><strong>Parameters:</strong></p> @@ -134,7 +134,7 @@ <h4><a class="anchor" aria-hidden="true" id="type-declaration-2"></a><a href="#t <hr> <h3><a class="anchor" aria-hidden="true" id="onsuccess"></a><a href="#onsuccess" 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>onSuccess</h3> <p>• <strong>onSuccess</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/create-action-tracking-middleware.ts#L10">src/middlewares/create-action-tracking-middleware.ts:10</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/create-action-tracking-middleware.ts#L10">src/middlewares/create-action-tracking-middleware.ts:10</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration-3"></a><a href="#type-declaration-3" 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 declaration:</h4> <p>▸ (<code>call</code>: <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a>, <code>context</code>: T, <code>result</code>: any): <em>void</em></p> <p><strong>Parameters:</strong></p> @@ -151,7 +151,7 @@ <h4><a class="anchor" aria-hidden="true" id="type-declaration-3"></a><a href="#t <hr> <h3><a class="anchor" aria-hidden="true" id="onsuspend"></a><a href="#onsuspend" 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>onSuspend</h3> <p>• <strong>onSuspend</strong>: <em>function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/create-action-tracking-middleware.ts#L9">src/middlewares/create-action-tracking-middleware.ts:9</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/create-action-tracking-middleware.ts#L9">src/middlewares/create-action-tracking-middleware.ts:9</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration-4"></a><a href="#type-declaration-4" 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 declaration:</h4> <p>▸ (<code>call</code>: <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a>, <code>context</code>: T): <em>void</em></p> <p><strong>Parameters:</strong></p> diff --git a/API/interfaces/ianycomplextype.html b/API/interfaces/ianycomplextype.html index c4e77b3d1..b335e4995 100644 --- a/API/interfaces/ianycomplextype.html +++ b/API/interfaces/ianycomplextype.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IAnyComplexType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IAnyComplexType](/API/interfaces/ianycomplextype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IAnyComplexType · 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.2](/API/) › [IAnyComplexType](/API/interfaces/ianycomplextype)"/><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>IAnyComplexType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IAnyComplexType](/API/interfaces/ianycomplextype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IAnyComplexType · 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 - v6.0.0](/API/) › [IAnyComplexType](/API/interfaces/ianycomplextype)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ianycomplextype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IAnyComplexType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ianycomplextype">IAnyComplexType</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ianycomplextype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IAnyComplexType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ianycomplextype">IAnyComplexType</a></p> <p>Any kind of complex type.</p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> @@ -86,19 +86,19 @@ <h2><a class="anchor" aria-hidden="true" id="properties-1"></a><a href="#propert <h3><a class="anchor" aria-hidden="true" id="optional-identifierattribute"></a><a href="#optional-identifierattribute" 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><code>Optional</code> identifierAttribute</h3> <p>• <strong>identifierAttribute</strong>? : <em>undefined | string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#optional-identifierattribute">identifierAttribute</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> <p>Name of the identifier attribute or null if none.</p> <hr> <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>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#name">name</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> <p>Friendly type 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="create"></a><a href="#create" 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>create</h3> <p>▸ <strong>create</strong>(<code>snapshot?</code>: <a href="undefined">C</a>, <code>env?</code>: any): <em>this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#create">create</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> <p>Creates an instance for the type given an snapshot input.</p> <p><strong>Parameters:</strong></p> <table> @@ -116,14 +116,14 @@ <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" aria- <h3><a class="anchor" aria-hidden="true" id="describe"></a><a href="#describe" 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>describe</h3> <p>▸ <strong>describe</strong>(): <em>string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#describe">describe</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> <p>Gets the textual representation of the type as a string.</p> <p><strong>Returns:</strong> <em>string</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" 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>is</h3> <p>▸ <strong>is</strong>(<code>thing</code>: any): <em>thing is any | this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#is">is</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> <p>Checks if a given snapshot / instance is of the given type.</p> <p><strong>Parameters:</strong></p> <table> @@ -140,7 +140,7 @@ <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" aria-hidden=" <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" 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>validate</h3> <p>▸ <strong>validate</strong>(<code>thing</code>: any, <code>context</code>: <a href="/API/#ivalidationcontext">IValidationContext</a>): <em><a href="/API/#ivalidationresult">IValidationResult</a></em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#validate">validate</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> <p>Run's the type's typechecker on the given value with the given validation context.</p> <p><strong>Parameters:</strong></p> <table> diff --git a/API/interfaces/ianycomplextype/index.html b/API/interfaces/ianycomplextype/index.html index c4e77b3d1..b335e4995 100644 --- a/API/interfaces/ianycomplextype/index.html +++ b/API/interfaces/ianycomplextype/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IAnyComplexType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IAnyComplexType](/API/interfaces/ianycomplextype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IAnyComplexType · 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.2](/API/) › [IAnyComplexType](/API/interfaces/ianycomplextype)"/><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>IAnyComplexType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IAnyComplexType](/API/interfaces/ianycomplextype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IAnyComplexType · 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 - v6.0.0](/API/) › [IAnyComplexType](/API/interfaces/ianycomplextype)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ianycomplextype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IAnyComplexType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ianycomplextype">IAnyComplexType</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ianycomplextype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IAnyComplexType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ianycomplextype">IAnyComplexType</a></p> <p>Any kind of complex type.</p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> @@ -86,19 +86,19 @@ <h2><a class="anchor" aria-hidden="true" id="properties-1"></a><a href="#propert <h3><a class="anchor" aria-hidden="true" id="optional-identifierattribute"></a><a href="#optional-identifierattribute" 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><code>Optional</code> identifierAttribute</h3> <p>• <strong>identifierAttribute</strong>? : <em>undefined | string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#optional-identifierattribute">identifierAttribute</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> <p>Name of the identifier attribute or null if none.</p> <hr> <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>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#name">name</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> <p>Friendly type 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="create"></a><a href="#create" 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>create</h3> <p>▸ <strong>create</strong>(<code>snapshot?</code>: <a href="undefined">C</a>, <code>env?</code>: any): <em>this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#create">create</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> <p>Creates an instance for the type given an snapshot input.</p> <p><strong>Parameters:</strong></p> <table> @@ -116,14 +116,14 @@ <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" aria- <h3><a class="anchor" aria-hidden="true" id="describe"></a><a href="#describe" 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>describe</h3> <p>▸ <strong>describe</strong>(): <em>string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#describe">describe</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> <p>Gets the textual representation of the type as a string.</p> <p><strong>Returns:</strong> <em>string</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" 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>is</h3> <p>▸ <strong>is</strong>(<code>thing</code>: any): <em>thing is any | this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#is">is</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> <p>Checks if a given snapshot / instance is of the given type.</p> <p><strong>Parameters:</strong></p> <table> @@ -140,7 +140,7 @@ <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" aria-hidden=" <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" 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>validate</h3> <p>▸ <strong>validate</strong>(<code>thing</code>: any, <code>context</code>: <a href="/API/#ivalidationcontext">IValidationContext</a>): <em><a href="/API/#ivalidationresult">IValidationResult</a></em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#validate">validate</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> <p>Run's the type's typechecker on the given value with the given validation context.</p> <p><strong>Parameters:</strong></p> <table> diff --git a/API/interfaces/ianymodeltype.html b/API/interfaces/ianymodeltype.html index 08bb29efd..8381a742e 100644 --- a/API/interfaces/ianymodeltype.html +++ b/API/interfaces/ianymodeltype.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IAnyModelType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IAnyModelType](/API/interfaces/ianymodeltype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IAnyModelType · 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.2](/API/) › [IAnyModelType](/API/interfaces/ianymodeltype)"/><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>IAnyModelType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IAnyModelType](/API/interfaces/ianymodeltype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IAnyModelType · 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 - v6.0.0](/API/) › [IAnyModelType](/API/interfaces/ianymodeltype)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ianymodeltype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IAnyModelType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ianymodeltype">IAnyModelType</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ianymodeltype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IAnyModelType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ianymodeltype">IAnyModelType</a></p> <p>Any model type.</p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <p>↳ <a href="/API/interfaces/imodeltype">IModelType</a>‹any, any, any, any›</p> @@ -93,24 +93,24 @@ <h2><a class="anchor" aria-hidden="true" id="properties-1"></a><a href="#propert <h3><a class="anchor" aria-hidden="true" id="optional-identifierattribute"></a><a href="#optional-identifierattribute" 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><code>Optional</code> identifierAttribute</h3> <p>• <strong>identifierAttribute</strong>? : <em>undefined | string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#optional-identifierattribute">identifierAttribute</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> <p>Name of the identifier attribute or null if none.</p> <hr> <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>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#name">name</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> <p>Friendly type name.</p> <hr> <h3><a class="anchor" aria-hidden="true" id="properties-2"></a><a href="#properties-2" 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</h3> <p>• <strong>properties</strong>: <em>any</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#properties">properties</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L193">src/types/complex-types/model.ts:193</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L190">src/types/complex-types/model.ts:190</a></em></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="actions"></a><a href="#actions" 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>actions</h3> <p>▸ <strong>actions</strong><<strong>A</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹any, any & A, any, any›</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#actions">actions</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L207">src/types/complex-types/model.ts:207</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L204">src/types/complex-types/model.ts:204</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>A</strong>: <em>ModelActions</em></p> <p><strong>Parameters:</strong></p> @@ -130,7 +130,7 @@ <h3><a class="anchor" aria-hidden="true" id="actions"></a><a href="#actions" ari <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" 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>create</h3> <p>▸ <strong>create</strong>(<code>snapshot?</code>: <a href="undefined">C</a>, <code>env?</code>: any): <em>this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#create">create</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> <p>Creates an instance for the type given an snapshot input.</p> <p><strong>Parameters:</strong></p> <table> @@ -148,14 +148,14 @@ <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" aria- <h3><a class="anchor" aria-hidden="true" id="describe"></a><a href="#describe" 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>describe</h3> <p>▸ <strong>describe</strong>(): <em>string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#describe">describe</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> <p>Gets the textual representation of the type as a string.</p> <p><strong>Returns:</strong> <em>string</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="extend"></a><a href="#extend" 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>extend</h3> <p>▸ <strong>extend</strong><<strong>A</strong>, <strong>V</strong>, <strong>VS</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹any, any & A & V & VS, any, any›</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#extend">extend</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L215">src/types/complex-types/model.ts:215</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L212">src/types/complex-types/model.ts:212</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>A</strong>: <em>ModelActions</em></p> <p>▪ <strong>V</strong>: <em>Object</em></p> @@ -177,7 +177,7 @@ <h3><a class="anchor" aria-hidden="true" id="extend"></a><a href="#extend" aria- <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" 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>is</h3> <p>▸ <strong>is</strong>(<code>thing</code>: any): <em>thing is ModelCreationType2<any, any> | this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#is">is</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> <p>Checks if a given snapshot / instance is of the given type.</p> <p><strong>Parameters:</strong></p> <table> @@ -194,7 +194,7 @@ <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" aria-hidden=" <h3><a class="anchor" aria-hidden="true" id="named"></a><a href="#named" 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>named</h3> <p>▸ <strong>named</strong>(<code>newName</code>: string): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹any, any, any, any›</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#named">named</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L195">src/types/complex-types/model.ts:195</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L192">src/types/complex-types/model.ts:192</a></em></p> <p><strong>Parameters:</strong></p> <table> <thead> @@ -209,7 +209,7 @@ <h3><a class="anchor" aria-hidden="true" id="named"></a><a href="#named" aria-hi <h3><a class="anchor" aria-hidden="true" id="postprocesssnapshot"></a><a href="#postprocesssnapshot" 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>postProcessSnapshot</h3> <p>▸ <strong>postProcessSnapshot</strong><<strong>NewS</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹any, any, any, NewS›</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#postprocesssnapshot">postProcessSnapshot</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L223">src/types/complex-types/model.ts:223</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L220">src/types/complex-types/model.ts:220</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>NewS</strong></p> <p><strong>Parameters:</strong></p> @@ -229,12 +229,12 @@ <h3><a class="anchor" aria-hidden="true" id="postprocesssnapshot"></a><a href="# <h3><a class="anchor" aria-hidden="true" id="preprocesssnapshot"></a><a href="#preprocesssnapshot" 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>preProcessSnapshot</h3> <p>▸ <strong>preProcessSnapshot</strong><<strong>NewC</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹any, any, NewC, any›</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#preprocesssnapshot">preProcessSnapshot</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L219">src/types/complex-types/model.ts:219</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L216">src/types/complex-types/model.ts:216</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>NewC</strong></p> <p><strong>Parameters:</strong></p> <p>▪ <strong>fn</strong>: <em>function</em></p> -<p>▸ (<code>snapshot</code>: NewC): <em>ModelCreationType2‹any, any›</em></p> +<p>▸ (<code>snapshot</code>: NewC): <em>WithAdditionalProperties‹ModelCreationType2‹any, any››</em></p> <p><strong>Parameters:</strong></p> <table> <thead> @@ -249,7 +249,7 @@ <h3><a class="anchor" aria-hidden="true" id="preprocesssnapshot"></a><a href="#p <h3><a class="anchor" aria-hidden="true" id="props"></a><a href="#props" 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>props</h3> <p>▸ <strong>props</strong><<strong>PROPS2</strong>>(<code>props</code>: PROPS2): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹any & ModelPropertiesDeclarationToProperties‹PROPS2›, any, any, any›</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#props">props</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L199">src/types/complex-types/model.ts:199</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L196">src/types/complex-types/model.ts:196</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>PROPS2</strong>: <em>ModelPropertiesDeclaration</em></p> <p><strong>Parameters:</strong></p> @@ -266,7 +266,7 @@ <h3><a class="anchor" aria-hidden="true" id="props"></a><a href="#props" aria-hi <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" 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>validate</h3> <p>▸ <strong>validate</strong>(<code>thing</code>: ModelCreationType2‹any, any›, <code>context</code>: <a href="/API/#ivalidationcontext">IValidationContext</a>): <em><a href="/API/#ivalidationresult">IValidationResult</a></em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#validate">validate</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> <p>Run's the type's typechecker on the given value with the given validation context.</p> <p><strong>Parameters:</strong></p> <table> @@ -284,7 +284,7 @@ <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" a <h3><a class="anchor" aria-hidden="true" id="views"></a><a href="#views" 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>views</h3> <p>▸ <strong>views</strong><<strong>V</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹any, any & V, any, any›</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#views">views</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L203">src/types/complex-types/model.ts:203</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L200">src/types/complex-types/model.ts:200</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>V</strong>: <em>Object</em></p> <p><strong>Parameters:</strong></p> @@ -304,7 +304,7 @@ <h3><a class="anchor" aria-hidden="true" id="views"></a><a href="#views" aria-hi <h3><a class="anchor" aria-hidden="true" id="volatile"></a><a href="#volatile" 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>volatile</h3> <p>▸ <strong>volatile</strong><<strong>TP</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹any, any & TP, any, any›</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#volatile">volatile</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L211">src/types/complex-types/model.ts:211</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L208">src/types/complex-types/model.ts:208</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>TP</strong>: <em>object</em></p> <p><strong>Parameters:</strong></p> diff --git a/API/interfaces/ianymodeltype/index.html b/API/interfaces/ianymodeltype/index.html index 08bb29efd..8381a742e 100644 --- a/API/interfaces/ianymodeltype/index.html +++ b/API/interfaces/ianymodeltype/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IAnyModelType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IAnyModelType](/API/interfaces/ianymodeltype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IAnyModelType · 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.2](/API/) › [IAnyModelType](/API/interfaces/ianymodeltype)"/><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>IAnyModelType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IAnyModelType](/API/interfaces/ianymodeltype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IAnyModelType · 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 - v6.0.0](/API/) › [IAnyModelType](/API/interfaces/ianymodeltype)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ianymodeltype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IAnyModelType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ianymodeltype">IAnyModelType</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ianymodeltype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IAnyModelType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ianymodeltype">IAnyModelType</a></p> <p>Any model type.</p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <p>↳ <a href="/API/interfaces/imodeltype">IModelType</a>‹any, any, any, any›</p> @@ -93,24 +93,24 @@ <h2><a class="anchor" aria-hidden="true" id="properties-1"></a><a href="#propert <h3><a class="anchor" aria-hidden="true" id="optional-identifierattribute"></a><a href="#optional-identifierattribute" 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><code>Optional</code> identifierAttribute</h3> <p>• <strong>identifierAttribute</strong>? : <em>undefined | string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#optional-identifierattribute">identifierAttribute</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> <p>Name of the identifier attribute or null if none.</p> <hr> <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>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#name">name</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> <p>Friendly type name.</p> <hr> <h3><a class="anchor" aria-hidden="true" id="properties-2"></a><a href="#properties-2" 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</h3> <p>• <strong>properties</strong>: <em>any</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#properties">properties</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L193">src/types/complex-types/model.ts:193</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L190">src/types/complex-types/model.ts:190</a></em></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="actions"></a><a href="#actions" 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>actions</h3> <p>▸ <strong>actions</strong><<strong>A</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹any, any & A, any, any›</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#actions">actions</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L207">src/types/complex-types/model.ts:207</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L204">src/types/complex-types/model.ts:204</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>A</strong>: <em>ModelActions</em></p> <p><strong>Parameters:</strong></p> @@ -130,7 +130,7 @@ <h3><a class="anchor" aria-hidden="true" id="actions"></a><a href="#actions" ari <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" 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>create</h3> <p>▸ <strong>create</strong>(<code>snapshot?</code>: <a href="undefined">C</a>, <code>env?</code>: any): <em>this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#create">create</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> <p>Creates an instance for the type given an snapshot input.</p> <p><strong>Parameters:</strong></p> <table> @@ -148,14 +148,14 @@ <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" aria- <h3><a class="anchor" aria-hidden="true" id="describe"></a><a href="#describe" 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>describe</h3> <p>▸ <strong>describe</strong>(): <em>string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#describe">describe</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> <p>Gets the textual representation of the type as a string.</p> <p><strong>Returns:</strong> <em>string</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="extend"></a><a href="#extend" 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>extend</h3> <p>▸ <strong>extend</strong><<strong>A</strong>, <strong>V</strong>, <strong>VS</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹any, any & A & V & VS, any, any›</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#extend">extend</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L215">src/types/complex-types/model.ts:215</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L212">src/types/complex-types/model.ts:212</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>A</strong>: <em>ModelActions</em></p> <p>▪ <strong>V</strong>: <em>Object</em></p> @@ -177,7 +177,7 @@ <h3><a class="anchor" aria-hidden="true" id="extend"></a><a href="#extend" aria- <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" 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>is</h3> <p>▸ <strong>is</strong>(<code>thing</code>: any): <em>thing is ModelCreationType2<any, any> | this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#is">is</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> <p>Checks if a given snapshot / instance is of the given type.</p> <p><strong>Parameters:</strong></p> <table> @@ -194,7 +194,7 @@ <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" aria-hidden=" <h3><a class="anchor" aria-hidden="true" id="named"></a><a href="#named" 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>named</h3> <p>▸ <strong>named</strong>(<code>newName</code>: string): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹any, any, any, any›</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#named">named</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L195">src/types/complex-types/model.ts:195</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L192">src/types/complex-types/model.ts:192</a></em></p> <p><strong>Parameters:</strong></p> <table> <thead> @@ -209,7 +209,7 @@ <h3><a class="anchor" aria-hidden="true" id="named"></a><a href="#named" aria-hi <h3><a class="anchor" aria-hidden="true" id="postprocesssnapshot"></a><a href="#postprocesssnapshot" 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>postProcessSnapshot</h3> <p>▸ <strong>postProcessSnapshot</strong><<strong>NewS</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹any, any, any, NewS›</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#postprocesssnapshot">postProcessSnapshot</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L223">src/types/complex-types/model.ts:223</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L220">src/types/complex-types/model.ts:220</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>NewS</strong></p> <p><strong>Parameters:</strong></p> @@ -229,12 +229,12 @@ <h3><a class="anchor" aria-hidden="true" id="postprocesssnapshot"></a><a href="# <h3><a class="anchor" aria-hidden="true" id="preprocesssnapshot"></a><a href="#preprocesssnapshot" 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>preProcessSnapshot</h3> <p>▸ <strong>preProcessSnapshot</strong><<strong>NewC</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹any, any, NewC, any›</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#preprocesssnapshot">preProcessSnapshot</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L219">src/types/complex-types/model.ts:219</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L216">src/types/complex-types/model.ts:216</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>NewC</strong></p> <p><strong>Parameters:</strong></p> <p>▪ <strong>fn</strong>: <em>function</em></p> -<p>▸ (<code>snapshot</code>: NewC): <em>ModelCreationType2‹any, any›</em></p> +<p>▸ (<code>snapshot</code>: NewC): <em>WithAdditionalProperties‹ModelCreationType2‹any, any››</em></p> <p><strong>Parameters:</strong></p> <table> <thead> @@ -249,7 +249,7 @@ <h3><a class="anchor" aria-hidden="true" id="preprocesssnapshot"></a><a href="#p <h3><a class="anchor" aria-hidden="true" id="props"></a><a href="#props" 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>props</h3> <p>▸ <strong>props</strong><<strong>PROPS2</strong>>(<code>props</code>: PROPS2): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹any & ModelPropertiesDeclarationToProperties‹PROPS2›, any, any, any›</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#props">props</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L199">src/types/complex-types/model.ts:199</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L196">src/types/complex-types/model.ts:196</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>PROPS2</strong>: <em>ModelPropertiesDeclaration</em></p> <p><strong>Parameters:</strong></p> @@ -266,7 +266,7 @@ <h3><a class="anchor" aria-hidden="true" id="props"></a><a href="#props" aria-hi <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" 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>validate</h3> <p>▸ <strong>validate</strong>(<code>thing</code>: ModelCreationType2‹any, any›, <code>context</code>: <a href="/API/#ivalidationcontext">IValidationContext</a>): <em><a href="/API/#ivalidationresult">IValidationResult</a></em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#validate">validate</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> <p>Run's the type's typechecker on the given value with the given validation context.</p> <p><strong>Parameters:</strong></p> <table> @@ -284,7 +284,7 @@ <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" a <h3><a class="anchor" aria-hidden="true" id="views"></a><a href="#views" 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>views</h3> <p>▸ <strong>views</strong><<strong>V</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹any, any & V, any, any›</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#views">views</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L203">src/types/complex-types/model.ts:203</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L200">src/types/complex-types/model.ts:200</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>V</strong>: <em>Object</em></p> <p><strong>Parameters:</strong></p> @@ -304,7 +304,7 @@ <h3><a class="anchor" aria-hidden="true" id="views"></a><a href="#views" aria-hi <h3><a class="anchor" aria-hidden="true" id="volatile"></a><a href="#volatile" 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>volatile</h3> <p>▸ <strong>volatile</strong><<strong>TP</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹any, any & TP, any, any›</em></p> <p><em>Inherited from <a href="/API/interfaces/imodeltype">IModelType</a>.<a href="/API/interfaces/imodeltype#volatile">volatile</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L211">src/types/complex-types/model.ts:211</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L208">src/types/complex-types/model.ts:208</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>TP</strong>: <em>object</em></p> <p><strong>Parameters:</strong></p> diff --git a/API/interfaces/ianytype.html b/API/interfaces/ianytype.html index df94b29f2..cc453e2a3 100644 --- a/API/interfaces/ianytype.html +++ b/API/interfaces/ianytype.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IAnyType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IAnyType](/API/interfaces/ianytype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IAnyType · 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.2](/API/) › [IAnyType](/API/interfaces/ianytype)"/><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>IAnyType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IAnyType](/API/interfaces/ianytype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IAnyType · 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 - v6.0.0](/API/) › [IAnyType](/API/interfaces/ianytype)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ianytype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IAnyType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ianytype">IAnyType</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ianytype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IAnyType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ianytype">IAnyType</a></p> <p>Any kind of type.</p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> @@ -86,19 +86,19 @@ <h2><a class="anchor" aria-hidden="true" id="properties-1"></a><a href="#propert <h3><a class="anchor" aria-hidden="true" id="optional-identifierattribute"></a><a href="#optional-identifierattribute" 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><code>Optional</code> identifierAttribute</h3> <p>• <strong>identifierAttribute</strong>? : <em>undefined | string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#optional-identifierattribute">identifierAttribute</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> <p>Name of the identifier attribute or null if none.</p> <hr> <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>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#name">name</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> <p>Friendly type 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="create"></a><a href="#create" 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>create</h3> <p>▸ <strong>create</strong>(<code>snapshot?</code>: <a href="undefined">C</a>, <code>env?</code>: any): <em>this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#create">create</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> <p>Creates an instance for the type given an snapshot input.</p> <p><strong>Parameters:</strong></p> <table> @@ -116,14 +116,14 @@ <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" aria- <h3><a class="anchor" aria-hidden="true" id="describe"></a><a href="#describe" 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>describe</h3> <p>▸ <strong>describe</strong>(): <em>string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#describe">describe</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> <p>Gets the textual representation of the type as a string.</p> <p><strong>Returns:</strong> <em>string</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" 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>is</h3> <p>▸ <strong>is</strong>(<code>thing</code>: any): <em>thing is any | this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#is">is</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> <p>Checks if a given snapshot / instance is of the given type.</p> <p><strong>Parameters:</strong></p> <table> @@ -140,7 +140,7 @@ <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" aria-hidden=" <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" 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>validate</h3> <p>▸ <strong>validate</strong>(<code>thing</code>: any, <code>context</code>: <a href="/API/#ivalidationcontext">IValidationContext</a>): <em><a href="/API/#ivalidationresult">IValidationResult</a></em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#validate">validate</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> <p>Run's the type's typechecker on the given value with the given validation context.</p> <p><strong>Parameters:</strong></p> <table> diff --git a/API/interfaces/ianytype/index.html b/API/interfaces/ianytype/index.html index df94b29f2..cc453e2a3 100644 --- a/API/interfaces/ianytype/index.html +++ b/API/interfaces/ianytype/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IAnyType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IAnyType](/API/interfaces/ianytype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IAnyType · 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.2](/API/) › [IAnyType](/API/interfaces/ianytype)"/><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>IAnyType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IAnyType](/API/interfaces/ianytype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IAnyType · 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 - v6.0.0](/API/) › [IAnyType](/API/interfaces/ianytype)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ianytype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IAnyType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ianytype">IAnyType</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ianytype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IAnyType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ianytype">IAnyType</a></p> <p>Any kind of type.</p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> @@ -86,19 +86,19 @@ <h2><a class="anchor" aria-hidden="true" id="properties-1"></a><a href="#propert <h3><a class="anchor" aria-hidden="true" id="optional-identifierattribute"></a><a href="#optional-identifierattribute" 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><code>Optional</code> identifierAttribute</h3> <p>• <strong>identifierAttribute</strong>? : <em>undefined | string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#optional-identifierattribute">identifierAttribute</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> <p>Name of the identifier attribute or null if none.</p> <hr> <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>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#name">name</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> <p>Friendly type 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="create"></a><a href="#create" 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>create</h3> <p>▸ <strong>create</strong>(<code>snapshot?</code>: <a href="undefined">C</a>, <code>env?</code>: any): <em>this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#create">create</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> <p>Creates an instance for the type given an snapshot input.</p> <p><strong>Parameters:</strong></p> <table> @@ -116,14 +116,14 @@ <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" aria- <h3><a class="anchor" aria-hidden="true" id="describe"></a><a href="#describe" 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>describe</h3> <p>▸ <strong>describe</strong>(): <em>string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#describe">describe</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> <p>Gets the textual representation of the type as a string.</p> <p><strong>Returns:</strong> <em>string</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" 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>is</h3> <p>▸ <strong>is</strong>(<code>thing</code>: any): <em>thing is any | this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#is">is</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> <p>Checks if a given snapshot / instance is of the given type.</p> <p><strong>Parameters:</strong></p> <table> @@ -140,7 +140,7 @@ <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" aria-hidden=" <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" 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>validate</h3> <p>▸ <strong>validate</strong>(<code>thing</code>: any, <code>context</code>: <a href="/API/#ivalidationcontext">IValidationContext</a>): <em><a href="/API/#ivalidationresult">IValidationResult</a></em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#validate">validate</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> <p>Run's the type's typechecker on the given value with the given validation context.</p> <p><strong>Parameters:</strong></p> <table> diff --git a/API/interfaces/ihooks.html b/API/interfaces/ihooks.html index 2573f52e7..c5295b8ff 100644 --- a/API/interfaces/ihooks.html +++ b/API/interfaces/ihooks.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IHooks · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IHooks](/API/interfaces/ihooks)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IHooks · 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.2](/API/) › [IHooks](/API/interfaces/ihooks)"/><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>IHooks · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IHooks](/API/interfaces/ihooks)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IHooks · 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 - v6.0.0](/API/) › [IHooks](/API/interfaces/ihooks)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ihooks.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IHooks</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ihooks">IHooks</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ihooks.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IHooks</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ihooks">IHooks</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><strong>IHooks</strong></li> @@ -78,19 +78,19 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="optional-hookafterattach"></a><a href="#optional-hookafterattach" 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><code>Optional</code> [Hook.afterAttach]</h3> <p>• <strong>[Hook.afterAttach]</strong>? : <em>undefined | function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/node/Hook.ts#L14">src/core/node/Hook.ts:14</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/node/Hook.ts#L14">src/core/node/Hook.ts:14</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-hookaftercreate"></a><a href="#optional-hookaftercreate" 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><code>Optional</code> [Hook.afterCreate]</h3> <p>• <strong>[Hook.afterCreate]</strong>? : <em>undefined | function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/node/Hook.ts#L13">src/core/node/Hook.ts:13</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/node/Hook.ts#L13">src/core/node/Hook.ts:13</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-hookbeforedestroy"></a><a href="#optional-hookbeforedestroy" 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><code>Optional</code> [Hook.beforeDestroy]</h3> <p>• <strong>[Hook.beforeDestroy]</strong>? : <em>undefined | function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/node/Hook.ts#L16">src/core/node/Hook.ts:16</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/node/Hook.ts#L16">src/core/node/Hook.ts:16</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-hookbeforedetach"></a><a href="#optional-hookbeforedetach" 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><code>Optional</code> [Hook.beforeDetach]</h3> <p>• <strong>[Hook.beforeDetach]</strong>? : <em>undefined | function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/node/Hook.ts#L15">src/core/node/Hook.ts:15</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/node/Hook.ts#L15">src/core/node/Hook.ts:15</a></em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/ianytype"><span class="arrow-prev">← </span><span class="function-name-prevnext">IAnyType</span></a><a class="docs-next button" href="/API/interfaces/ijsonpatch"><span class="function-name-prevnext">IJsonPatch</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#optional-hookafterattach"><code>Optional</code> [Hook.afterAttach]</a></li><li><a href="#optional-hookaftercreate"><code>Optional</code> [Hook.afterCreate]</a></li><li><a href="#optional-hookbeforedestroy"><code>Optional</code> [Hook.beforeDestroy]</a></li><li><a href="#optional-hookbeforedetach"><code>Optional</code> [Hook.beforeDetach]</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) { diff --git a/API/interfaces/ihooks/index.html b/API/interfaces/ihooks/index.html index 2573f52e7..c5295b8ff 100644 --- a/API/interfaces/ihooks/index.html +++ b/API/interfaces/ihooks/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IHooks · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IHooks](/API/interfaces/ihooks)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IHooks · 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.2](/API/) › [IHooks](/API/interfaces/ihooks)"/><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>IHooks · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IHooks](/API/interfaces/ihooks)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IHooks · 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 - v6.0.0](/API/) › [IHooks](/API/interfaces/ihooks)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ihooks.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IHooks</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ihooks">IHooks</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ihooks.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IHooks</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ihooks">IHooks</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><strong>IHooks</strong></li> @@ -78,19 +78,19 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="optional-hookafterattach"></a><a href="#optional-hookafterattach" 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><code>Optional</code> [Hook.afterAttach]</h3> <p>• <strong>[Hook.afterAttach]</strong>? : <em>undefined | function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/node/Hook.ts#L14">src/core/node/Hook.ts:14</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/node/Hook.ts#L14">src/core/node/Hook.ts:14</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-hookaftercreate"></a><a href="#optional-hookaftercreate" 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><code>Optional</code> [Hook.afterCreate]</h3> <p>• <strong>[Hook.afterCreate]</strong>? : <em>undefined | function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/node/Hook.ts#L13">src/core/node/Hook.ts:13</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/node/Hook.ts#L13">src/core/node/Hook.ts:13</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-hookbeforedestroy"></a><a href="#optional-hookbeforedestroy" 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><code>Optional</code> [Hook.beforeDestroy]</h3> <p>• <strong>[Hook.beforeDestroy]</strong>? : <em>undefined | function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/node/Hook.ts#L16">src/core/node/Hook.ts:16</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/node/Hook.ts#L16">src/core/node/Hook.ts:16</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-hookbeforedetach"></a><a href="#optional-hookbeforedetach" 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><code>Optional</code> [Hook.beforeDetach]</h3> <p>• <strong>[Hook.beforeDetach]</strong>? : <em>undefined | function</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/node/Hook.ts#L15">src/core/node/Hook.ts:15</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/node/Hook.ts#L15">src/core/node/Hook.ts:15</a></em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/ianytype"><span class="arrow-prev">← </span><span class="function-name-prevnext">IAnyType</span></a><a class="docs-next button" href="/API/interfaces/ijsonpatch"><span class="function-name-prevnext">IJsonPatch</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#optional-hookafterattach"><code>Optional</code> [Hook.afterAttach]</a></li><li><a href="#optional-hookaftercreate"><code>Optional</code> [Hook.afterCreate]</a></li><li><a href="#optional-hookbeforedestroy"><code>Optional</code> [Hook.beforeDestroy]</a></li><li><a href="#optional-hookbeforedetach"><code>Optional</code> [Hook.beforeDetach]</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) { diff --git a/API/interfaces/ijsonpatch.html b/API/interfaces/ijsonpatch.html index 9b032003e..ca51ac207 100644 --- a/API/interfaces/ijsonpatch.html +++ b/API/interfaces/ijsonpatch.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IJsonPatch · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IJsonPatch](/API/interfaces/ijsonpatch)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IJsonPatch · 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.2](/API/) › [IJsonPatch](/API/interfaces/ijsonpatch)"/><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>IJsonPatch · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IJsonPatch](/API/interfaces/ijsonpatch)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IJsonPatch · 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 - v6.0.0](/API/) › [IJsonPatch](/API/interfaces/ijsonpatch)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ijsonpatch.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IJsonPatch</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ijsonpatch">IJsonPatch</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ijsonpatch.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IJsonPatch</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ijsonpatch">IJsonPatch</a></p> <p><a href="https://tools.ietf.org/html/rfc6902">https://tools.ietf.org/html/rfc6902</a> <a href="http://jsonpatch.com/">http://jsonpatch.com/</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> @@ -80,15 +80,15 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="op"></a><a href="#op" 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>op</h3> <p>• <strong>op</strong>: <em>"replace" | "add" | "remove"</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L8">src/core/json-patch.ts:8</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L8">src/core/json-patch.ts:8</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="path"></a><a href="#path" 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>path</h3> <p>• <strong>path</strong>: <em>string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L9">src/core/json-patch.ts:9</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L9">src/core/json-patch.ts:9</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-value"></a><a href="#optional-value" 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><code>Optional</code> value</h3> <p>• <strong>value</strong>? : <em>any</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L10">src/core/json-patch.ts:10</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L10">src/core/json-patch.ts:10</a></em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/ihooks"><span class="arrow-prev">← </span><span>IHooks</span></a><a class="docs-next button" href="/API/interfaces/imiddlewareevent"><span class="function-name-prevnext">IMiddlewareEvent</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#op">op</a></li><li><a href="#path">path</a></li><li><a href="#optional-value"><code>Optional</code> value</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) { diff --git a/API/interfaces/ijsonpatch/index.html b/API/interfaces/ijsonpatch/index.html index 9b032003e..ca51ac207 100644 --- a/API/interfaces/ijsonpatch/index.html +++ b/API/interfaces/ijsonpatch/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IJsonPatch · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IJsonPatch](/API/interfaces/ijsonpatch)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IJsonPatch · 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.2](/API/) › [IJsonPatch](/API/interfaces/ijsonpatch)"/><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>IJsonPatch · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IJsonPatch](/API/interfaces/ijsonpatch)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IJsonPatch · 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 - v6.0.0](/API/) › [IJsonPatch](/API/interfaces/ijsonpatch)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ijsonpatch.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IJsonPatch</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ijsonpatch">IJsonPatch</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ijsonpatch.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IJsonPatch</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ijsonpatch">IJsonPatch</a></p> <p><a href="https://tools.ietf.org/html/rfc6902">https://tools.ietf.org/html/rfc6902</a> <a href="http://jsonpatch.com/">http://jsonpatch.com/</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> @@ -80,15 +80,15 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="op"></a><a href="#op" 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>op</h3> <p>• <strong>op</strong>: <em>"replace" | "add" | "remove"</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L8">src/core/json-patch.ts:8</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L8">src/core/json-patch.ts:8</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="path"></a><a href="#path" 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>path</h3> <p>• <strong>path</strong>: <em>string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L9">src/core/json-patch.ts:9</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L9">src/core/json-patch.ts:9</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-value"></a><a href="#optional-value" 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><code>Optional</code> value</h3> <p>• <strong>value</strong>? : <em>any</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L10">src/core/json-patch.ts:10</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L10">src/core/json-patch.ts:10</a></em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/ihooks"><span class="arrow-prev">← </span><span>IHooks</span></a><a class="docs-next button" href="/API/interfaces/imiddlewareevent"><span class="function-name-prevnext">IMiddlewareEvent</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#op">op</a></li><li><a href="#path">path</a></li><li><a href="#optional-value"><code>Optional</code> value</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) { diff --git a/API/interfaces/imiddlewareevent.html b/API/interfaces/imiddlewareevent.html index 462ff1a7a..7426e56c6 100644 --- a/API/interfaces/imiddlewareevent.html +++ b/API/interfaces/imiddlewareevent.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IMiddlewareEvent · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IMiddlewareEvent](/API/interfaces/imiddlewareevent)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IMiddlewareEvent · 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.2](/API/) › [IMiddlewareEvent](/API/interfaces/imiddlewareevent)"/><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>IMiddlewareEvent · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IMiddlewareEvent](/API/interfaces/imiddlewareevent)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IMiddlewareEvent · 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 - v6.0.0](/API/) › [IMiddlewareEvent](/API/interfaces/imiddlewareevent)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/imiddlewareevent.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IMiddlewareEvent</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/imiddlewareevent.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IMiddlewareEvent</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><p><a href="/API/interfaces/iactioncontext">IActionContext</a></p> @@ -86,63 +86,63 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="allparentids"></a><a href="#allparentids" 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>allParentIds</h3> <p>• <strong>allParentIds</strong>: <em>number[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L37">src/core/action.ts:37</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L37">src/core/action.ts:37</a></em></p> <p>Id of all events, from root until current (excluding current)</p> <hr> <h3><a class="anchor" aria-hidden="true" id="args"></a><a href="#args" 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>args</h3> <p>• <strong>args</strong>: <em>any[]</em></p> <p><em>Inherited from <a href="/API/interfaces/iactioncontext">IActionContext</a>.<a href="/API/interfaces/iactioncontext#args">args</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L20">src/core/actionContext.ts:20</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L20">src/core/actionContext.ts:20</a></em></p> <p>Event arguments in an array (action arguments for actions)</p> <hr> <h3><a class="anchor" aria-hidden="true" id="context"></a><a href="#context" 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>context</h3> <p>• <strong>context</strong>: <em>IAnyStateTreeNode</em></p> <p><em>Inherited from <a href="/API/interfaces/iactioncontext">IActionContext</a>.<a href="/API/interfaces/iactioncontext#context">context</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L15">src/core/actionContext.ts:15</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L15">src/core/actionContext.ts:15</a></em></p> <p>Event context (node where the action was invoked)</p> <hr> <h3><a class="anchor" aria-hidden="true" id="id"></a><a href="#id" 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>id</h3> <p>• <strong>id</strong>: <em>number</em></p> <p><em>Inherited from <a href="/API/interfaces/iactioncontext">IActionContext</a>.<a href="/API/interfaces/iactioncontext#id">id</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L9">src/core/actionContext.ts:9</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L9">src/core/actionContext.ts:9</a></em></p> <p>Event unique id</p> <hr> <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>Inherited from <a href="/API/interfaces/iactioncontext">IActionContext</a>.<a href="/API/interfaces/iactioncontext#name">name</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L6">src/core/actionContext.ts:6</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L6">src/core/actionContext.ts:6</a></em></p> <p>Event name (action name for actions)</p> <hr> <h3><a class="anchor" aria-hidden="true" id="parentactionevent"></a><a href="#parentactionevent" 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>parentActionEvent</h3> <p>• <strong>parentActionEvent</strong>: <em><a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a> | undefined</em></p> <p><em>Inherited from <a href="/API/interfaces/iactioncontext">IActionContext</a>.<a href="/API/interfaces/iactioncontext#parentactionevent">parentActionEvent</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L12">src/core/actionContext.ts:12</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L12">src/core/actionContext.ts:12</a></em></p> <p>Parent action event object</p> <hr> <h3><a class="anchor" aria-hidden="true" id="parentevent"></a><a href="#parentevent" 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>parentEvent</h3> <p>• <strong>parentEvent</strong>: <em><a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a> | undefined</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L32">src/core/action.ts:32</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L32">src/core/action.ts:32</a></em></p> <p>Parent event object</p> <hr> <h3><a class="anchor" aria-hidden="true" id="parentid"></a><a href="#parentid" 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>parentId</h3> <p>• <strong>parentId</strong>: <em>number</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L30">src/core/action.ts:30</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L30">src/core/action.ts:30</a></em></p> <p>Parent event unique id</p> <hr> <h3><a class="anchor" aria-hidden="true" id="rootid"></a><a href="#rootid" 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>rootId</h3> <p>• <strong>rootId</strong>: <em>number</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L35">src/core/action.ts:35</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L35">src/core/action.ts:35</a></em></p> <p>Root event unique id</p> <hr> <h3><a class="anchor" aria-hidden="true" id="tree"></a><a href="#tree" 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>tree</h3> <p>• <strong>tree</strong>: <em>IAnyStateTreeNode</em></p> <p><em>Inherited from <a href="/API/interfaces/iactioncontext">IActionContext</a>.<a href="/API/interfaces/iactioncontext#tree">tree</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L17">src/core/actionContext.ts:17</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L17">src/core/actionContext.ts:17</a></em></p> <p>Event tree (root node of the node where the action was invoked)</p> <hr> <h3><a class="anchor" aria-hidden="true" id="type"></a><a href="#type" 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</h3> <p>• <strong>type</strong>: <em><a href="/API/#imiddlewareeventtype">IMiddlewareEventType</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L27">src/core/action.ts:27</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L27">src/core/action.ts:27</a></em></p> <p>Event type</p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/ijsonpatch"><span class="arrow-prev">← </span><span class="function-name-prevnext">IJsonPatch</span></a><a class="docs-next button" href="/API/interfaces/imodelreflectiondata"><span class="function-name-prevnext">IModelReflectionData</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#allparentids">allParentIds</a></li><li><a href="#args">args</a></li><li><a href="#context">context</a></li><li><a href="#id">id</a></li><li><a href="#name">name</a></li><li><a href="#parentactionevent">parentActionEvent</a></li><li><a href="#parentevent">parentEvent</a></li><li><a href="#parentid">parentId</a></li><li><a href="#rootid">rootId</a></li><li><a href="#tree">tree</a></li><li><a href="#type">type</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) { diff --git a/API/interfaces/imiddlewareevent/index.html b/API/interfaces/imiddlewareevent/index.html index 462ff1a7a..7426e56c6 100644 --- a/API/interfaces/imiddlewareevent/index.html +++ b/API/interfaces/imiddlewareevent/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IMiddlewareEvent · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IMiddlewareEvent](/API/interfaces/imiddlewareevent)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IMiddlewareEvent · 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.2](/API/) › [IMiddlewareEvent](/API/interfaces/imiddlewareevent)"/><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>IMiddlewareEvent · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IMiddlewareEvent](/API/interfaces/imiddlewareevent)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IMiddlewareEvent · 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 - v6.0.0](/API/) › [IMiddlewareEvent](/API/interfaces/imiddlewareevent)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/imiddlewareevent.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IMiddlewareEvent</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/imiddlewareevent.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IMiddlewareEvent</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><p><a href="/API/interfaces/iactioncontext">IActionContext</a></p> @@ -86,63 +86,63 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="allparentids"></a><a href="#allparentids" 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>allParentIds</h3> <p>• <strong>allParentIds</strong>: <em>number[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L37">src/core/action.ts:37</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L37">src/core/action.ts:37</a></em></p> <p>Id of all events, from root until current (excluding current)</p> <hr> <h3><a class="anchor" aria-hidden="true" id="args"></a><a href="#args" 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>args</h3> <p>• <strong>args</strong>: <em>any[]</em></p> <p><em>Inherited from <a href="/API/interfaces/iactioncontext">IActionContext</a>.<a href="/API/interfaces/iactioncontext#args">args</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L20">src/core/actionContext.ts:20</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L20">src/core/actionContext.ts:20</a></em></p> <p>Event arguments in an array (action arguments for actions)</p> <hr> <h3><a class="anchor" aria-hidden="true" id="context"></a><a href="#context" 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>context</h3> <p>• <strong>context</strong>: <em>IAnyStateTreeNode</em></p> <p><em>Inherited from <a href="/API/interfaces/iactioncontext">IActionContext</a>.<a href="/API/interfaces/iactioncontext#context">context</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L15">src/core/actionContext.ts:15</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L15">src/core/actionContext.ts:15</a></em></p> <p>Event context (node where the action was invoked)</p> <hr> <h3><a class="anchor" aria-hidden="true" id="id"></a><a href="#id" 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>id</h3> <p>• <strong>id</strong>: <em>number</em></p> <p><em>Inherited from <a href="/API/interfaces/iactioncontext">IActionContext</a>.<a href="/API/interfaces/iactioncontext#id">id</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L9">src/core/actionContext.ts:9</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L9">src/core/actionContext.ts:9</a></em></p> <p>Event unique id</p> <hr> <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>Inherited from <a href="/API/interfaces/iactioncontext">IActionContext</a>.<a href="/API/interfaces/iactioncontext#name">name</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L6">src/core/actionContext.ts:6</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L6">src/core/actionContext.ts:6</a></em></p> <p>Event name (action name for actions)</p> <hr> <h3><a class="anchor" aria-hidden="true" id="parentactionevent"></a><a href="#parentactionevent" 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>parentActionEvent</h3> <p>• <strong>parentActionEvent</strong>: <em><a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a> | undefined</em></p> <p><em>Inherited from <a href="/API/interfaces/iactioncontext">IActionContext</a>.<a href="/API/interfaces/iactioncontext#parentactionevent">parentActionEvent</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L12">src/core/actionContext.ts:12</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L12">src/core/actionContext.ts:12</a></em></p> <p>Parent action event object</p> <hr> <h3><a class="anchor" aria-hidden="true" id="parentevent"></a><a href="#parentevent" 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>parentEvent</h3> <p>• <strong>parentEvent</strong>: <em><a href="/API/interfaces/imiddlewareevent">IMiddlewareEvent</a> | undefined</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L32">src/core/action.ts:32</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L32">src/core/action.ts:32</a></em></p> <p>Parent event object</p> <hr> <h3><a class="anchor" aria-hidden="true" id="parentid"></a><a href="#parentid" 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>parentId</h3> <p>• <strong>parentId</strong>: <em>number</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L30">src/core/action.ts:30</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L30">src/core/action.ts:30</a></em></p> <p>Parent event unique id</p> <hr> <h3><a class="anchor" aria-hidden="true" id="rootid"></a><a href="#rootid" 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>rootId</h3> <p>• <strong>rootId</strong>: <em>number</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L35">src/core/action.ts:35</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L35">src/core/action.ts:35</a></em></p> <p>Root event unique id</p> <hr> <h3><a class="anchor" aria-hidden="true" id="tree"></a><a href="#tree" 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>tree</h3> <p>• <strong>tree</strong>: <em>IAnyStateTreeNode</em></p> <p><em>Inherited from <a href="/API/interfaces/iactioncontext">IActionContext</a>.<a href="/API/interfaces/iactioncontext#tree">tree</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/actionContext.ts#L17">src/core/actionContext.ts:17</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/actionContext.ts#L17">src/core/actionContext.ts:17</a></em></p> <p>Event tree (root node of the node where the action was invoked)</p> <hr> <h3><a class="anchor" aria-hidden="true" id="type"></a><a href="#type" 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</h3> <p>• <strong>type</strong>: <em><a href="/API/#imiddlewareeventtype">IMiddlewareEventType</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/action.ts#L27">src/core/action.ts:27</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/action.ts#L27">src/core/action.ts:27</a></em></p> <p>Event type</p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/ijsonpatch"><span class="arrow-prev">← </span><span class="function-name-prevnext">IJsonPatch</span></a><a class="docs-next button" href="/API/interfaces/imodelreflectiondata"><span class="function-name-prevnext">IModelReflectionData</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#allparentids">allParentIds</a></li><li><a href="#args">args</a></li><li><a href="#context">context</a></li><li><a href="#id">id</a></li><li><a href="#name">name</a></li><li><a href="#parentactionevent">parentActionEvent</a></li><li><a href="#parentevent">parentEvent</a></li><li><a href="#parentid">parentId</a></li><li><a href="#rootid">rootId</a></li><li><a href="#tree">tree</a></li><li><a href="#type">type</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) { diff --git a/API/interfaces/imodelreflectiondata.html b/API/interfaces/imodelreflectiondata.html index 794fb026e..39828ec15 100644 --- a/API/interfaces/imodelreflectiondata.html +++ b/API/interfaces/imodelreflectiondata.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IModelReflectionData · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IModelReflectionData](/API/interfaces/imodelreflectiondata)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IModelReflectionData · 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.2](/API/) › [IModelReflectionData](/API/interfaces/imodelreflectiondata)"/><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>IModelReflectionData · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IModelReflectionData](/API/interfaces/imodelreflectiondata)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IModelReflectionData · 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 - v6.0.0](/API/) › [IModelReflectionData](/API/interfaces/imodelreflectiondata)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/imodelreflectiondata.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IModelReflectionData</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/imodelreflectiondata">IModelReflectionData</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/imodelreflectiondata.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IModelReflectionData</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/imodelreflectiondata">IModelReflectionData</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><p><a href="/API/interfaces/imodelreflectionpropertiesdata">IModelReflectionPropertiesData</a></p> @@ -81,21 +81,21 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="actions"></a><a href="#actions" 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>actions</h3> <p>• <strong>actions</strong>: <em>string[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L834">src/core/mst-operations.ts:834</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L855">src/core/mst-operations.ts:855</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="flowactions"></a><a href="#flowactions" 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>flowActions</h3> <p>• <strong>flowActions</strong>: <em>string[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L837">src/core/mst-operations.ts:837</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L858">src/core/mst-operations.ts:858</a></em></p> <hr> <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>Inherited from <a href="/API/interfaces/imodelreflectionpropertiesdata">IModelReflectionPropertiesData</a>.<a href="/API/interfaces/imodelreflectionpropertiesdata#name">name</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L804">src/core/mst-operations.ts:804</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L825">src/core/mst-operations.ts:825</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="properties-2"></a><a href="#properties-2" 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</h3> <p>• <strong>properties</strong>: <em>object</em></p> <p><em>Inherited from <a href="/API/interfaces/imodelreflectionpropertiesdata">IModelReflectionPropertiesData</a>.<a href="/API/interfaces/imodelreflectionpropertiesdata#properties">properties</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L805">src/core/mst-operations.ts:805</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L826">src/core/mst-operations.ts:826</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration"></a><a href="#type-declaration" 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 declaration:</h4> <ul> <li>[ <strong>K</strong>: <em>string</em>]: <a href="/API/interfaces/ianytype">IAnyType</a></li> @@ -103,11 +103,11 @@ <h4><a class="anchor" aria-hidden="true" id="type-declaration"></a><a href="#typ <hr> <h3><a class="anchor" aria-hidden="true" id="views"></a><a href="#views" 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>views</h3> <p>• <strong>views</strong>: <em>string[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L835">src/core/mst-operations.ts:835</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L856">src/core/mst-operations.ts:856</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="volatile"></a><a href="#volatile" 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>volatile</h3> <p>• <strong>volatile</strong>: <em>string[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L836">src/core/mst-operations.ts:836</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L857">src/core/mst-operations.ts:857</a></em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/imiddlewareevent"><span class="arrow-prev">← </span><span class="function-name-prevnext">IMiddlewareEvent</span></a><a class="docs-next button" href="/API/interfaces/imodelreflectionpropertiesdata"><span class="function-name-prevnext">IModelReflectionPropertiesData</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#actions">actions</a></li><li><a href="#flowactions">flowActions</a></li><li><a href="#name">name</a></li><li><a href="#properties-2">properties</a></li><li><a href="#views">views</a></li><li><a href="#volatile">volatile</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) { diff --git a/API/interfaces/imodelreflectiondata/index.html b/API/interfaces/imodelreflectiondata/index.html index 794fb026e..39828ec15 100644 --- a/API/interfaces/imodelreflectiondata/index.html +++ b/API/interfaces/imodelreflectiondata/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IModelReflectionData · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IModelReflectionData](/API/interfaces/imodelreflectiondata)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IModelReflectionData · 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.2](/API/) › [IModelReflectionData](/API/interfaces/imodelreflectiondata)"/><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>IModelReflectionData · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IModelReflectionData](/API/interfaces/imodelreflectiondata)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IModelReflectionData · 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 - v6.0.0](/API/) › [IModelReflectionData](/API/interfaces/imodelreflectiondata)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/imodelreflectiondata.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IModelReflectionData</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/imodelreflectiondata">IModelReflectionData</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/imodelreflectiondata.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IModelReflectionData</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/imodelreflectiondata">IModelReflectionData</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><p><a href="/API/interfaces/imodelreflectionpropertiesdata">IModelReflectionPropertiesData</a></p> @@ -81,21 +81,21 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="actions"></a><a href="#actions" 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>actions</h3> <p>• <strong>actions</strong>: <em>string[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L834">src/core/mst-operations.ts:834</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L855">src/core/mst-operations.ts:855</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="flowactions"></a><a href="#flowactions" 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>flowActions</h3> <p>• <strong>flowActions</strong>: <em>string[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L837">src/core/mst-operations.ts:837</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L858">src/core/mst-operations.ts:858</a></em></p> <hr> <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>Inherited from <a href="/API/interfaces/imodelreflectionpropertiesdata">IModelReflectionPropertiesData</a>.<a href="/API/interfaces/imodelreflectionpropertiesdata#name">name</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L804">src/core/mst-operations.ts:804</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L825">src/core/mst-operations.ts:825</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="properties-2"></a><a href="#properties-2" 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</h3> <p>• <strong>properties</strong>: <em>object</em></p> <p><em>Inherited from <a href="/API/interfaces/imodelreflectionpropertiesdata">IModelReflectionPropertiesData</a>.<a href="/API/interfaces/imodelreflectionpropertiesdata#properties">properties</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L805">src/core/mst-operations.ts:805</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L826">src/core/mst-operations.ts:826</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration"></a><a href="#type-declaration" 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 declaration:</h4> <ul> <li>[ <strong>K</strong>: <em>string</em>]: <a href="/API/interfaces/ianytype">IAnyType</a></li> @@ -103,11 +103,11 @@ <h4><a class="anchor" aria-hidden="true" id="type-declaration"></a><a href="#typ <hr> <h3><a class="anchor" aria-hidden="true" id="views"></a><a href="#views" 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>views</h3> <p>• <strong>views</strong>: <em>string[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L835">src/core/mst-operations.ts:835</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L856">src/core/mst-operations.ts:856</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="volatile"></a><a href="#volatile" 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>volatile</h3> <p>• <strong>volatile</strong>: <em>string[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L836">src/core/mst-operations.ts:836</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L857">src/core/mst-operations.ts:857</a></em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/imiddlewareevent"><span class="arrow-prev">← </span><span class="function-name-prevnext">IMiddlewareEvent</span></a><a class="docs-next button" href="/API/interfaces/imodelreflectionpropertiesdata"><span class="function-name-prevnext">IModelReflectionPropertiesData</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#actions">actions</a></li><li><a href="#flowactions">flowActions</a></li><li><a href="#name">name</a></li><li><a href="#properties-2">properties</a></li><li><a href="#views">views</a></li><li><a href="#volatile">volatile</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) { diff --git a/API/interfaces/imodelreflectionpropertiesdata.html b/API/interfaces/imodelreflectionpropertiesdata.html index 657e3a46c..2f68645d7 100644 --- a/API/interfaces/imodelreflectionpropertiesdata.html +++ b/API/interfaces/imodelreflectionpropertiesdata.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IModelReflectionPropertiesData · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IModelReflectionPropertiesData](/API/interfaces/imodelreflectionpropertiesdata)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IModelReflectionPropertiesData · 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.2](/API/) › [IModelReflectionPropertiesData](/API/interfaces/imodelreflectionpropertiesdata)"/><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>IModelReflectionPropertiesData · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IModelReflectionPropertiesData](/API/interfaces/imodelreflectionpropertiesdata)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IModelReflectionPropertiesData · 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 - v6.0.0](/API/) › [IModelReflectionPropertiesData](/API/interfaces/imodelreflectionpropertiesdata)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/imodelreflectionpropertiesdata.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IModelReflectionPropertiesData</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/imodelreflectionpropertiesdata">IModelReflectionPropertiesData</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/imodelreflectionpropertiesdata.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IModelReflectionPropertiesData</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/imodelreflectionpropertiesdata">IModelReflectionPropertiesData</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><p><strong>IModelReflectionPropertiesData</strong></p> @@ -77,11 +77,11 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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/700ab6f8/src/core/mst-operations.ts#L804">src/core/mst-operations.ts:804</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L825">src/core/mst-operations.ts:825</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="properties-2"></a><a href="#properties-2" 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</h3> <p>• <strong>properties</strong>: <em>object</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L805">src/core/mst-operations.ts:805</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L826">src/core/mst-operations.ts:826</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration"></a><a href="#type-declaration" 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 declaration:</h4> <ul> <li>[ <strong>K</strong>: <em>string</em>]: <a href="/API/interfaces/ianytype">IAnyType</a></li> diff --git a/API/interfaces/imodelreflectionpropertiesdata/index.html b/API/interfaces/imodelreflectionpropertiesdata/index.html index 657e3a46c..2f68645d7 100644 --- a/API/interfaces/imodelreflectionpropertiesdata/index.html +++ b/API/interfaces/imodelreflectionpropertiesdata/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IModelReflectionPropertiesData · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IModelReflectionPropertiesData](/API/interfaces/imodelreflectionpropertiesdata)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IModelReflectionPropertiesData · 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.2](/API/) › [IModelReflectionPropertiesData](/API/interfaces/imodelreflectionpropertiesdata)"/><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>IModelReflectionPropertiesData · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IModelReflectionPropertiesData](/API/interfaces/imodelreflectionpropertiesdata)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IModelReflectionPropertiesData · 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 - v6.0.0](/API/) › [IModelReflectionPropertiesData](/API/interfaces/imodelreflectionpropertiesdata)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/imodelreflectionpropertiesdata.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IModelReflectionPropertiesData</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/imodelreflectionpropertiesdata">IModelReflectionPropertiesData</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/imodelreflectionpropertiesdata.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IModelReflectionPropertiesData</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/imodelreflectionpropertiesdata">IModelReflectionPropertiesData</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><p><strong>IModelReflectionPropertiesData</strong></p> @@ -77,11 +77,11 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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/700ab6f8/src/core/mst-operations.ts#L804">src/core/mst-operations.ts:804</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L825">src/core/mst-operations.ts:825</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="properties-2"></a><a href="#properties-2" 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</h3> <p>• <strong>properties</strong>: <em>object</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L805">src/core/mst-operations.ts:805</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L826">src/core/mst-operations.ts:826</a></em></p> <h4><a class="anchor" aria-hidden="true" id="type-declaration"></a><a href="#type-declaration" 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 declaration:</h4> <ul> <li>[ <strong>K</strong>: <em>string</em>]: <a href="/API/interfaces/ianytype">IAnyType</a></li> diff --git a/API/interfaces/imodeltype.html b/API/interfaces/imodeltype.html index 16709655d..06459dc1d 100644 --- a/API/interfaces/imodeltype.html +++ b/API/interfaces/imodeltype.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IModelType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IModelType](/API/interfaces/imodeltype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IModelType · 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.2](/API/) › [IModelType](/API/interfaces/imodeltype)"/><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>IModelType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IModelType](/API/interfaces/imodeltype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IModelType · 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 - v6.0.0](/API/) › [IModelType](/API/interfaces/imodeltype)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/imodeltype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IModelType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/imodeltype">IModelType</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/imodeltype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IModelType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/imodeltype">IModelType</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>PROPS</strong>: <em>ModelProperties</em></p> <p>▪ <strong>OTHERS</strong></p> @@ -100,22 +100,22 @@ <h2><a class="anchor" aria-hidden="true" id="properties-1"></a><a href="#propert <h3><a class="anchor" aria-hidden="true" id="optional-identifierattribute"></a><a href="#optional-identifierattribute" 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><code>Optional</code> identifierAttribute</h3> <p>• <strong>identifierAttribute</strong>? : <em>undefined | string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#optional-identifierattribute">identifierAttribute</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> <p>Name of the identifier attribute or null if none.</p> <hr> <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>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#name">name</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> <p>Friendly type name.</p> <hr> <h3><a class="anchor" aria-hidden="true" id="properties-2"></a><a href="#properties-2" 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</h3> <p>• <strong>properties</strong>: <em>PROPS</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L193">src/types/complex-types/model.ts:193</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L190">src/types/complex-types/model.ts:190</a></em></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="actions"></a><a href="#actions" 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>actions</h3> <p>▸ <strong>actions</strong><<strong>A</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PROPS, OTHERS & A, CustomC, CustomS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L207">src/types/complex-types/model.ts:207</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L204">src/types/complex-types/model.ts:204</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>A</strong>: <em>ModelActions</em></p> <p><strong>Parameters:</strong></p> @@ -135,7 +135,7 @@ <h3><a class="anchor" aria-hidden="true" id="actions"></a><a href="#actions" ari <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" 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>create</h3> <p>▸ <strong>create</strong>(<code>snapshot?</code>: <a href="undefined">C</a>, <code>env?</code>: any): <em>this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#create">create</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> <p>Creates an instance for the type given an snapshot input.</p> <p><strong>Parameters:</strong></p> <table> @@ -153,13 +153,13 @@ <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" aria- <h3><a class="anchor" aria-hidden="true" id="describe"></a><a href="#describe" 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>describe</h3> <p>▸ <strong>describe</strong>(): <em>string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#describe">describe</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> <p>Gets the textual representation of the type as a string.</p> <p><strong>Returns:</strong> <em>string</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="extend"></a><a href="#extend" 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>extend</h3> <p>▸ <strong>extend</strong><<strong>A</strong>, <strong>V</strong>, <strong>VS</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PROPS, OTHERS & A & V & VS, CustomC, CustomS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L215">src/types/complex-types/model.ts:215</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L212">src/types/complex-types/model.ts:212</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>A</strong>: <em>ModelActions</em></p> <p>▪ <strong>V</strong>: <em>Object</em></p> @@ -181,7 +181,7 @@ <h3><a class="anchor" aria-hidden="true" id="extend"></a><a href="#extend" aria- <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" 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>is</h3> <p>▸ <strong>is</strong>(<code>thing</code>: any): <em>thing is ModelCreationType2<PROPS, CustomC> | this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#is">is</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> <p>Checks if a given snapshot / instance is of the given type.</p> <p><strong>Parameters:</strong></p> <table> @@ -197,7 +197,7 @@ <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" aria-hidden=" <hr> <h3><a class="anchor" aria-hidden="true" id="named"></a><a href="#named" 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>named</h3> <p>▸ <strong>named</strong>(<code>newName</code>: string): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PROPS, OTHERS, CustomC, CustomS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L195">src/types/complex-types/model.ts:195</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L192">src/types/complex-types/model.ts:192</a></em></p> <p><strong>Parameters:</strong></p> <table> <thead> @@ -211,7 +211,7 @@ <h3><a class="anchor" aria-hidden="true" id="named"></a><a href="#named" aria-hi <hr> <h3><a class="anchor" aria-hidden="true" id="postprocesssnapshot"></a><a href="#postprocesssnapshot" 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>postProcessSnapshot</h3> <p>▸ <strong>postProcessSnapshot</strong><<strong>NewS</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PROPS, OTHERS, CustomC, NewS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L223">src/types/complex-types/model.ts:223</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L220">src/types/complex-types/model.ts:220</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>NewS</strong></p> <p><strong>Parameters:</strong></p> @@ -230,12 +230,12 @@ <h3><a class="anchor" aria-hidden="true" id="postprocesssnapshot"></a><a href="# <hr> <h3><a class="anchor" aria-hidden="true" id="preprocesssnapshot"></a><a href="#preprocesssnapshot" 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>preProcessSnapshot</h3> <p>▸ <strong>preProcessSnapshot</strong><<strong>NewC</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PROPS, OTHERS, NewC, CustomS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L219">src/types/complex-types/model.ts:219</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L216">src/types/complex-types/model.ts:216</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>NewC</strong></p> <p><strong>Parameters:</strong></p> <p>▪ <strong>fn</strong>: <em>function</em></p> -<p>▸ (<code>snapshot</code>: NewC): <em>ModelCreationType2‹PROPS, CustomC›</em></p> +<p>▸ (<code>snapshot</code>: NewC): <em>WithAdditionalProperties‹ModelCreationType2‹PROPS, CustomC››</em></p> <p><strong>Parameters:</strong></p> <table> <thead> @@ -249,7 +249,7 @@ <h3><a class="anchor" aria-hidden="true" id="preprocesssnapshot"></a><a href="#p <hr> <h3><a class="anchor" aria-hidden="true" id="props"></a><a href="#props" 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>props</h3> <p>▸ <strong>props</strong><<strong>PROPS2</strong>>(<code>props</code>: PROPS2): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PROPS & ModelPropertiesDeclarationToProperties‹PROPS2›, OTHERS, CustomC, CustomS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L199">src/types/complex-types/model.ts:199</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L196">src/types/complex-types/model.ts:196</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>PROPS2</strong>: <em>ModelPropertiesDeclaration</em></p> <p><strong>Parameters:</strong></p> @@ -266,7 +266,7 @@ <h3><a class="anchor" aria-hidden="true" id="props"></a><a href="#props" aria-hi <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" 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>validate</h3> <p>▸ <strong>validate</strong>(<code>thing</code>: ModelCreationType2‹PROPS, CustomC›, <code>context</code>: <a href="/API/#ivalidationcontext">IValidationContext</a>): <em><a href="/API/#ivalidationresult">IValidationResult</a></em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#validate">validate</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> <p>Run's the type's typechecker on the given value with the given validation context.</p> <p><strong>Parameters:</strong></p> <table> @@ -283,7 +283,7 @@ <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" a <hr> <h3><a class="anchor" aria-hidden="true" id="views"></a><a href="#views" 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>views</h3> <p>▸ <strong>views</strong><<strong>V</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PROPS, OTHERS & V, CustomC, CustomS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L203">src/types/complex-types/model.ts:203</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L200">src/types/complex-types/model.ts:200</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>V</strong>: <em>Object</em></p> <p><strong>Parameters:</strong></p> @@ -302,7 +302,7 @@ <h3><a class="anchor" aria-hidden="true" id="views"></a><a href="#views" aria-hi <hr> <h3><a class="anchor" aria-hidden="true" id="volatile"></a><a href="#volatile" 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>volatile</h3> <p>▸ <strong>volatile</strong><<strong>TP</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PROPS, OTHERS & TP, CustomC, CustomS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L211">src/types/complex-types/model.ts:211</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L208">src/types/complex-types/model.ts:208</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>TP</strong>: <em>object</em></p> <p><strong>Parameters:</strong></p> diff --git a/API/interfaces/imodeltype/index.html b/API/interfaces/imodeltype/index.html index 16709655d..06459dc1d 100644 --- a/API/interfaces/imodeltype/index.html +++ b/API/interfaces/imodeltype/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IModelType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IModelType](/API/interfaces/imodeltype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IModelType · 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.2](/API/) › [IModelType](/API/interfaces/imodeltype)"/><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>IModelType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IModelType](/API/interfaces/imodeltype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IModelType · 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 - v6.0.0](/API/) › [IModelType](/API/interfaces/imodeltype)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/imodeltype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IModelType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/imodeltype">IModelType</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/imodeltype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IModelType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/imodeltype">IModelType</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>PROPS</strong>: <em>ModelProperties</em></p> <p>▪ <strong>OTHERS</strong></p> @@ -100,22 +100,22 @@ <h2><a class="anchor" aria-hidden="true" id="properties-1"></a><a href="#propert <h3><a class="anchor" aria-hidden="true" id="optional-identifierattribute"></a><a href="#optional-identifierattribute" 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><code>Optional</code> identifierAttribute</h3> <p>• <strong>identifierAttribute</strong>? : <em>undefined | string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#optional-identifierattribute">identifierAttribute</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> <p>Name of the identifier attribute or null if none.</p> <hr> <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>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#name">name</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> <p>Friendly type name.</p> <hr> <h3><a class="anchor" aria-hidden="true" id="properties-2"></a><a href="#properties-2" 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</h3> <p>• <strong>properties</strong>: <em>PROPS</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L193">src/types/complex-types/model.ts:193</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L190">src/types/complex-types/model.ts:190</a></em></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="actions"></a><a href="#actions" 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>actions</h3> <p>▸ <strong>actions</strong><<strong>A</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PROPS, OTHERS & A, CustomC, CustomS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L207">src/types/complex-types/model.ts:207</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L204">src/types/complex-types/model.ts:204</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>A</strong>: <em>ModelActions</em></p> <p><strong>Parameters:</strong></p> @@ -135,7 +135,7 @@ <h3><a class="anchor" aria-hidden="true" id="actions"></a><a href="#actions" ari <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" 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>create</h3> <p>▸ <strong>create</strong>(<code>snapshot?</code>: <a href="undefined">C</a>, <code>env?</code>: any): <em>this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#create">create</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> <p>Creates an instance for the type given an snapshot input.</p> <p><strong>Parameters:</strong></p> <table> @@ -153,13 +153,13 @@ <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" aria- <h3><a class="anchor" aria-hidden="true" id="describe"></a><a href="#describe" 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>describe</h3> <p>▸ <strong>describe</strong>(): <em>string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#describe">describe</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> <p>Gets the textual representation of the type as a string.</p> <p><strong>Returns:</strong> <em>string</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="extend"></a><a href="#extend" 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>extend</h3> <p>▸ <strong>extend</strong><<strong>A</strong>, <strong>V</strong>, <strong>VS</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PROPS, OTHERS & A & V & VS, CustomC, CustomS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L215">src/types/complex-types/model.ts:215</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L212">src/types/complex-types/model.ts:212</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>A</strong>: <em>ModelActions</em></p> <p>▪ <strong>V</strong>: <em>Object</em></p> @@ -181,7 +181,7 @@ <h3><a class="anchor" aria-hidden="true" id="extend"></a><a href="#extend" aria- <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" 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>is</h3> <p>▸ <strong>is</strong>(<code>thing</code>: any): <em>thing is ModelCreationType2<PROPS, CustomC> | this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#is">is</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> <p>Checks if a given snapshot / instance is of the given type.</p> <p><strong>Parameters:</strong></p> <table> @@ -197,7 +197,7 @@ <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" aria-hidden=" <hr> <h3><a class="anchor" aria-hidden="true" id="named"></a><a href="#named" 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>named</h3> <p>▸ <strong>named</strong>(<code>newName</code>: string): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PROPS, OTHERS, CustomC, CustomS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L195">src/types/complex-types/model.ts:195</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L192">src/types/complex-types/model.ts:192</a></em></p> <p><strong>Parameters:</strong></p> <table> <thead> @@ -211,7 +211,7 @@ <h3><a class="anchor" aria-hidden="true" id="named"></a><a href="#named" aria-hi <hr> <h3><a class="anchor" aria-hidden="true" id="postprocesssnapshot"></a><a href="#postprocesssnapshot" 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>postProcessSnapshot</h3> <p>▸ <strong>postProcessSnapshot</strong><<strong>NewS</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PROPS, OTHERS, CustomC, NewS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L223">src/types/complex-types/model.ts:223</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L220">src/types/complex-types/model.ts:220</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>NewS</strong></p> <p><strong>Parameters:</strong></p> @@ -230,12 +230,12 @@ <h3><a class="anchor" aria-hidden="true" id="postprocesssnapshot"></a><a href="# <hr> <h3><a class="anchor" aria-hidden="true" id="preprocesssnapshot"></a><a href="#preprocesssnapshot" 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>preProcessSnapshot</h3> <p>▸ <strong>preProcessSnapshot</strong><<strong>NewC</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PROPS, OTHERS, NewC, CustomS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L219">src/types/complex-types/model.ts:219</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L216">src/types/complex-types/model.ts:216</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>NewC</strong></p> <p><strong>Parameters:</strong></p> <p>▪ <strong>fn</strong>: <em>function</em></p> -<p>▸ (<code>snapshot</code>: NewC): <em>ModelCreationType2‹PROPS, CustomC›</em></p> +<p>▸ (<code>snapshot</code>: NewC): <em>WithAdditionalProperties‹ModelCreationType2‹PROPS, CustomC››</em></p> <p><strong>Parameters:</strong></p> <table> <thead> @@ -249,7 +249,7 @@ <h3><a class="anchor" aria-hidden="true" id="preprocesssnapshot"></a><a href="#p <hr> <h3><a class="anchor" aria-hidden="true" id="props"></a><a href="#props" 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>props</h3> <p>▸ <strong>props</strong><<strong>PROPS2</strong>>(<code>props</code>: PROPS2): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PROPS & ModelPropertiesDeclarationToProperties‹PROPS2›, OTHERS, CustomC, CustomS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L199">src/types/complex-types/model.ts:199</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L196">src/types/complex-types/model.ts:196</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>PROPS2</strong>: <em>ModelPropertiesDeclaration</em></p> <p><strong>Parameters:</strong></p> @@ -266,7 +266,7 @@ <h3><a class="anchor" aria-hidden="true" id="props"></a><a href="#props" aria-hi <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" 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>validate</h3> <p>▸ <strong>validate</strong>(<code>thing</code>: ModelCreationType2‹PROPS, CustomC›, <code>context</code>: <a href="/API/#ivalidationcontext">IValidationContext</a>): <em><a href="/API/#ivalidationresult">IValidationResult</a></em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#validate">validate</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> <p>Run's the type's typechecker on the given value with the given validation context.</p> <p><strong>Parameters:</strong></p> <table> @@ -283,7 +283,7 @@ <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" a <hr> <h3><a class="anchor" aria-hidden="true" id="views"></a><a href="#views" 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>views</h3> <p>▸ <strong>views</strong><<strong>V</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PROPS, OTHERS & V, CustomC, CustomS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L203">src/types/complex-types/model.ts:203</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L200">src/types/complex-types/model.ts:200</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>V</strong>: <em>Object</em></p> <p><strong>Parameters:</strong></p> @@ -302,7 +302,7 @@ <h3><a class="anchor" aria-hidden="true" id="views"></a><a href="#views" aria-hi <hr> <h3><a class="anchor" aria-hidden="true" id="volatile"></a><a href="#volatile" 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>volatile</h3> <p>▸ <strong>volatile</strong><<strong>TP</strong>>(<code>fn</code>: function): <em><a href="/API/interfaces/imodeltype">IModelType</a>‹PROPS, OTHERS & TP, CustomC, CustomS›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/complex-types/model.ts#L211">src/types/complex-types/model.ts:211</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/complex-types/model.ts#L208">src/types/complex-types/model.ts:208</a></em></p> <p><strong>Type parameters:</strong></p> <p>▪ <strong>TP</strong>: <em>object</em></p> <p><strong>Parameters:</strong></p> diff --git a/API/interfaces/ipatchrecorder.html b/API/interfaces/ipatchrecorder.html index aab8b2eb5..eff039c0b 100644 --- a/API/interfaces/ipatchrecorder.html +++ b/API/interfaces/ipatchrecorder.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IPatchRecorder · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IPatchRecorder](/API/interfaces/ipatchrecorder)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IPatchRecorder · 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.2](/API/) › [IPatchRecorder](/API/interfaces/ipatchrecorder)"/><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>IPatchRecorder · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IPatchRecorder](/API/interfaces/ipatchrecorder)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IPatchRecorder · 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 - v6.0.0](/API/) › [IPatchRecorder](/API/interfaces/ipatchrecorder)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ipatchrecorder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IPatchRecorder</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ipatchrecorder">IPatchRecorder</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ipatchrecorder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IPatchRecorder</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ipatchrecorder">IPatchRecorder</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><strong>IPatchRecorder</strong></li> @@ -85,23 +85,23 @@ <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="inversepatches"></a><a href="#inversepatches" 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>inversePatches</h3> <p>• <strong>inversePatches</strong>: <em>ReadonlyArray‹<a href="/API/interfaces/ijsonpatch">IJsonPatch</a>›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L138">src/core/mst-operations.ts:138</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L137">src/core/mst-operations.ts:137</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="patches"></a><a href="#patches" 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>patches</h3> <p>• <strong>patches</strong>: <em>ReadonlyArray‹<a href="/API/interfaces/ijsonpatch">IJsonPatch</a>›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L137">src/core/mst-operations.ts:137</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L136">src/core/mst-operations.ts:136</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="recording"></a><a href="#recording" 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>recording</h3> <p>• <strong>recording</strong>: <em>boolean</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L140">src/core/mst-operations.ts:140</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L139">src/core/mst-operations.ts:139</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="reversedinversepatches"></a><a href="#reversedinversepatches" 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>reversedInversePatches</h3> <p>• <strong>reversedInversePatches</strong>: <em>ReadonlyArray‹<a href="/API/interfaces/ijsonpatch">IJsonPatch</a>›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L139">src/core/mst-operations.ts:139</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L138">src/core/mst-operations.ts:138</a></em></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="replay"></a><a href="#replay" 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>replay</h3> <p>▸ <strong>replay</strong>(<code>target?</code>: IAnyStateTreeNode): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L143">src/core/mst-operations.ts:143</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L142">src/core/mst-operations.ts:142</a></em></p> <p><strong>Parameters:</strong></p> <table> <thead> @@ -115,17 +115,17 @@ <h3><a class="anchor" aria-hidden="true" id="replay"></a><a href="#replay" aria- <hr> <h3><a class="anchor" aria-hidden="true" id="resume"></a><a href="#resume" 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>resume</h3> <p>▸ <strong>resume</strong>(): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L142">src/core/mst-operations.ts:142</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L141">src/core/mst-operations.ts:141</a></em></p> <p><strong>Returns:</strong> <em>void</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="stop"></a><a href="#stop" 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>stop</h3> <p>▸ <strong>stop</strong>(): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L141">src/core/mst-operations.ts:141</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L140">src/core/mst-operations.ts:140</a></em></p> <p><strong>Returns:</strong> <em>void</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="undo"></a><a href="#undo" 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>undo</h3> <p>▸ <strong>undo</strong>(<code>target?</code>: IAnyStateTreeNode): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L144">src/core/mst-operations.ts:144</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L143">src/core/mst-operations.ts:143</a></em></p> <p><strong>Parameters:</strong></p> <table> <thead> diff --git a/API/interfaces/ipatchrecorder/index.html b/API/interfaces/ipatchrecorder/index.html index aab8b2eb5..eff039c0b 100644 --- a/API/interfaces/ipatchrecorder/index.html +++ b/API/interfaces/ipatchrecorder/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IPatchRecorder · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IPatchRecorder](/API/interfaces/ipatchrecorder)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IPatchRecorder · 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.2](/API/) › [IPatchRecorder](/API/interfaces/ipatchrecorder)"/><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>IPatchRecorder · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IPatchRecorder](/API/interfaces/ipatchrecorder)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IPatchRecorder · 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 - v6.0.0](/API/) › [IPatchRecorder](/API/interfaces/ipatchrecorder)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ipatchrecorder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IPatchRecorder</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ipatchrecorder">IPatchRecorder</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ipatchrecorder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IPatchRecorder</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ipatchrecorder">IPatchRecorder</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><strong>IPatchRecorder</strong></li> @@ -85,23 +85,23 @@ <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="inversepatches"></a><a href="#inversepatches" 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>inversePatches</h3> <p>• <strong>inversePatches</strong>: <em>ReadonlyArray‹<a href="/API/interfaces/ijsonpatch">IJsonPatch</a>›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L138">src/core/mst-operations.ts:138</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L137">src/core/mst-operations.ts:137</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="patches"></a><a href="#patches" 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>patches</h3> <p>• <strong>patches</strong>: <em>ReadonlyArray‹<a href="/API/interfaces/ijsonpatch">IJsonPatch</a>›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L137">src/core/mst-operations.ts:137</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L136">src/core/mst-operations.ts:136</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="recording"></a><a href="#recording" 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>recording</h3> <p>• <strong>recording</strong>: <em>boolean</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L140">src/core/mst-operations.ts:140</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L139">src/core/mst-operations.ts:139</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="reversedinversepatches"></a><a href="#reversedinversepatches" 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>reversedInversePatches</h3> <p>• <strong>reversedInversePatches</strong>: <em>ReadonlyArray‹<a href="/API/interfaces/ijsonpatch">IJsonPatch</a>›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L139">src/core/mst-operations.ts:139</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L138">src/core/mst-operations.ts:138</a></em></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="replay"></a><a href="#replay" 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>replay</h3> <p>▸ <strong>replay</strong>(<code>target?</code>: IAnyStateTreeNode): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L143">src/core/mst-operations.ts:143</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L142">src/core/mst-operations.ts:142</a></em></p> <p><strong>Parameters:</strong></p> <table> <thead> @@ -115,17 +115,17 @@ <h3><a class="anchor" aria-hidden="true" id="replay"></a><a href="#replay" aria- <hr> <h3><a class="anchor" aria-hidden="true" id="resume"></a><a href="#resume" 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>resume</h3> <p>▸ <strong>resume</strong>(): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L142">src/core/mst-operations.ts:142</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L141">src/core/mst-operations.ts:141</a></em></p> <p><strong>Returns:</strong> <em>void</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="stop"></a><a href="#stop" 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>stop</h3> <p>▸ <strong>stop</strong>(): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L141">src/core/mst-operations.ts:141</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L140">src/core/mst-operations.ts:140</a></em></p> <p><strong>Returns:</strong> <em>void</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="undo"></a><a href="#undo" 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>undo</h3> <p>▸ <strong>undo</strong>(<code>target?</code>: IAnyStateTreeNode): <em>void</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/mst-operations.ts#L144">src/core/mst-operations.ts:144</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/mst-operations.ts#L143">src/core/mst-operations.ts:143</a></em></p> <p><strong>Parameters:</strong></p> <table> <thead> diff --git a/API/interfaces/ireversiblejsonpatch.html b/API/interfaces/ireversiblejsonpatch.html index 0b3e7825f..880fdbacb 100644 --- a/API/interfaces/ireversiblejsonpatch.html +++ b/API/interfaces/ireversiblejsonpatch.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IReversibleJsonPatch · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IReversibleJsonPatch](/API/interfaces/ireversiblejsonpatch)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IReversibleJsonPatch · 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.2](/API/) › [IReversibleJsonPatch](/API/interfaces/ireversiblejsonpatch)"/><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>IReversibleJsonPatch · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IReversibleJsonPatch](/API/interfaces/ireversiblejsonpatch)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IReversibleJsonPatch · 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 - v6.0.0](/API/) › [IReversibleJsonPatch](/API/interfaces/ireversiblejsonpatch)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ireversiblejsonpatch.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IReversibleJsonPatch</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ireversiblejsonpatch">IReversibleJsonPatch</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ireversiblejsonpatch.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IReversibleJsonPatch</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ireversiblejsonpatch">IReversibleJsonPatch</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><p><a href="/API/interfaces/ijsonpatch">IJsonPatch</a></p> @@ -79,22 +79,22 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="oldvalue"></a><a href="#oldvalue" 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>oldValue</h3> <p>• <strong>oldValue</strong>: <em>any</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L14">src/core/json-patch.ts:14</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L14">src/core/json-patch.ts:14</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="op"></a><a href="#op" 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>op</h3> <p>• <strong>op</strong>: <em>"replace" | "add" | "remove"</em></p> <p><em>Inherited from <a href="/API/interfaces/ijsonpatch">IJsonPatch</a>.<a href="/API/interfaces/ijsonpatch#op">op</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L8">src/core/json-patch.ts:8</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L8">src/core/json-patch.ts:8</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="path"></a><a href="#path" 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>path</h3> <p>• <strong>path</strong>: <em>string</em></p> <p><em>Inherited from <a href="/API/interfaces/ijsonpatch">IJsonPatch</a>.<a href="/API/interfaces/ijsonpatch#path">path</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L9">src/core/json-patch.ts:9</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L9">src/core/json-patch.ts:9</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-value"></a><a href="#optional-value" 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><code>Optional</code> value</h3> <p>• <strong>value</strong>? : <em>any</em></p> <p><em>Inherited from <a href="/API/interfaces/ijsonpatch">IJsonPatch</a>.<a href="/API/interfaces/ijsonpatch#optional-value">value</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L10">src/core/json-patch.ts:10</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L10">src/core/json-patch.ts:10</a></em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/ipatchrecorder"><span class="arrow-prev">← </span><span class="function-name-prevnext">IPatchRecorder</span></a><a class="docs-next button" href="/API/interfaces/iserializedactioncall"><span class="function-name-prevnext">ISerializedActionCall</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#oldvalue">oldValue</a></li><li><a href="#op">op</a></li><li><a href="#path">path</a></li><li><a href="#optional-value"><code>Optional</code> value</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) { diff --git a/API/interfaces/ireversiblejsonpatch/index.html b/API/interfaces/ireversiblejsonpatch/index.html index 0b3e7825f..880fdbacb 100644 --- a/API/interfaces/ireversiblejsonpatch/index.html +++ b/API/interfaces/ireversiblejsonpatch/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IReversibleJsonPatch · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IReversibleJsonPatch](/API/interfaces/ireversiblejsonpatch)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IReversibleJsonPatch · 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.2](/API/) › [IReversibleJsonPatch](/API/interfaces/ireversiblejsonpatch)"/><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>IReversibleJsonPatch · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IReversibleJsonPatch](/API/interfaces/ireversiblejsonpatch)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IReversibleJsonPatch · 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 - v6.0.0](/API/) › [IReversibleJsonPatch](/API/interfaces/ireversiblejsonpatch)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ireversiblejsonpatch.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IReversibleJsonPatch</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ireversiblejsonpatch">IReversibleJsonPatch</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ireversiblejsonpatch.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IReversibleJsonPatch</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ireversiblejsonpatch">IReversibleJsonPatch</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><p><a href="/API/interfaces/ijsonpatch">IJsonPatch</a></p> @@ -79,22 +79,22 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="oldvalue"></a><a href="#oldvalue" 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>oldValue</h3> <p>• <strong>oldValue</strong>: <em>any</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L14">src/core/json-patch.ts:14</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L14">src/core/json-patch.ts:14</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="op"></a><a href="#op" 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>op</h3> <p>• <strong>op</strong>: <em>"replace" | "add" | "remove"</em></p> <p><em>Inherited from <a href="/API/interfaces/ijsonpatch">IJsonPatch</a>.<a href="/API/interfaces/ijsonpatch#op">op</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L8">src/core/json-patch.ts:8</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L8">src/core/json-patch.ts:8</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="path"></a><a href="#path" 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>path</h3> <p>• <strong>path</strong>: <em>string</em></p> <p><em>Inherited from <a href="/API/interfaces/ijsonpatch">IJsonPatch</a>.<a href="/API/interfaces/ijsonpatch#path">path</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L9">src/core/json-patch.ts:9</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L9">src/core/json-patch.ts:9</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-value"></a><a href="#optional-value" 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><code>Optional</code> value</h3> <p>• <strong>value</strong>? : <em>any</em></p> <p><em>Inherited from <a href="/API/interfaces/ijsonpatch">IJsonPatch</a>.<a href="/API/interfaces/ijsonpatch#optional-value">value</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/json-patch.ts#L10">src/core/json-patch.ts:10</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/json-patch.ts#L10">src/core/json-patch.ts:10</a></em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/ipatchrecorder"><span class="arrow-prev">← </span><span class="function-name-prevnext">IPatchRecorder</span></a><a class="docs-next button" href="/API/interfaces/iserializedactioncall"><span class="function-name-prevnext">ISerializedActionCall</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#oldvalue">oldValue</a></li><li><a href="#op">op</a></li><li><a href="#path">path</a></li><li><a href="#optional-value"><code>Optional</code> value</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) { diff --git a/API/interfaces/iserializedactioncall.html b/API/interfaces/iserializedactioncall.html index 6d07a28ba..bcf5b6db3 100644 --- a/API/interfaces/iserializedactioncall.html +++ b/API/interfaces/iserializedactioncall.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ISerializedActionCall · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [ISerializedActionCall](/API/interfaces/iserializedactioncall)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ISerializedActionCall · 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.2](/API/) › [ISerializedActionCall](/API/interfaces/iserializedactioncall)"/><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>ISerializedActionCall · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [ISerializedActionCall](/API/interfaces/iserializedactioncall)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ISerializedActionCall · 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 - v6.0.0](/API/) › [ISerializedActionCall](/API/interfaces/iserializedactioncall)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/iserializedactioncall.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ISerializedActionCall</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/iserializedactioncall">ISerializedActionCall</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/iserializedactioncall.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ISerializedActionCall</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/iserializedactioncall">ISerializedActionCall</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><strong>ISerializedActionCall</strong></li> @@ -77,15 +77,15 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="optional-args"></a><a href="#optional-args" 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><code>Optional</code> args</h3> <p>• <strong>args</strong>? : <em>any[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L33">src/middlewares/on-action.ts:33</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L33">src/middlewares/on-action.ts:33</a></em></p> <hr> <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/700ab6f8/src/middlewares/on-action.ts#L31">src/middlewares/on-action.ts:31</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L31">src/middlewares/on-action.ts:31</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-path"></a><a href="#optional-path" 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><code>Optional</code> path</h3> <p>• <strong>path</strong>? : <em>undefined | string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L32">src/middlewares/on-action.ts:32</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L32">src/middlewares/on-action.ts:32</a></em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/ireversiblejsonpatch"><span class="arrow-prev">← </span><span class="function-name-prevnext">IReversibleJsonPatch</span></a><a class="docs-next button" href="/API/interfaces/isimpletype"><span class="function-name-prevnext">ISimpleType</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#optional-args"><code>Optional</code> args</a></li><li><a href="#name">name</a></li><li><a href="#optional-path"><code>Optional</code> path</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) { diff --git a/API/interfaces/iserializedactioncall/index.html b/API/interfaces/iserializedactioncall/index.html index 6d07a28ba..bcf5b6db3 100644 --- a/API/interfaces/iserializedactioncall/index.html +++ b/API/interfaces/iserializedactioncall/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ISerializedActionCall · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [ISerializedActionCall](/API/interfaces/iserializedactioncall)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ISerializedActionCall · 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.2](/API/) › [ISerializedActionCall](/API/interfaces/iserializedactioncall)"/><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>ISerializedActionCall · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [ISerializedActionCall](/API/interfaces/iserializedactioncall)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ISerializedActionCall · 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 - v6.0.0](/API/) › [ISerializedActionCall](/API/interfaces/iserializedactioncall)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/iserializedactioncall.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ISerializedActionCall</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/iserializedactioncall">ISerializedActionCall</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/iserializedactioncall.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ISerializedActionCall</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/iserializedactioncall">ISerializedActionCall</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><strong>ISerializedActionCall</strong></li> @@ -77,15 +77,15 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="optional-args"></a><a href="#optional-args" 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><code>Optional</code> args</h3> <p>• <strong>args</strong>? : <em>any[]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L33">src/middlewares/on-action.ts:33</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L33">src/middlewares/on-action.ts:33</a></em></p> <hr> <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/700ab6f8/src/middlewares/on-action.ts#L31">src/middlewares/on-action.ts:31</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L31">src/middlewares/on-action.ts:31</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-path"></a><a href="#optional-path" 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><code>Optional</code> path</h3> <p>• <strong>path</strong>? : <em>undefined | string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/middlewares/on-action.ts#L32">src/middlewares/on-action.ts:32</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/middlewares/on-action.ts#L32">src/middlewares/on-action.ts:32</a></em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/ireversiblejsonpatch"><span class="arrow-prev">← </span><span class="function-name-prevnext">IReversibleJsonPatch</span></a><a class="docs-next button" href="/API/interfaces/isimpletype"><span class="function-name-prevnext">ISimpleType</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#optional-args"><code>Optional</code> args</a></li><li><a href="#name">name</a></li><li><a href="#optional-path"><code>Optional</code> path</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) { diff --git a/API/interfaces/isimpletype.html b/API/interfaces/isimpletype.html index d6950b3d6..7b53b63a9 100644 --- a/API/interfaces/isimpletype.html +++ b/API/interfaces/isimpletype.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ISimpleType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [ISimpleType](/API/interfaces/isimpletype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ISimpleType · 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.2](/API/) › [ISimpleType](/API/interfaces/isimpletype)"/><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>ISimpleType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [ISimpleType](/API/interfaces/isimpletype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ISimpleType · 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 - v6.0.0](/API/) › [ISimpleType](/API/interfaces/isimpletype)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/isimpletype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ISimpleType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/isimpletype">ISimpleType</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/isimpletype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ISimpleType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/isimpletype">ISimpleType</a></p> <p>A simple type, this is, a type where the instance and the snapshot representation are the same.</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>T</strong></p> @@ -88,19 +88,19 @@ <h2><a class="anchor" aria-hidden="true" id="properties-1"></a><a href="#propert <h3><a class="anchor" aria-hidden="true" id="optional-identifierattribute"></a><a href="#optional-identifierattribute" 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><code>Optional</code> identifierAttribute</h3> <p>• <strong>identifierAttribute</strong>? : <em>undefined | string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#optional-identifierattribute">identifierAttribute</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> <p>Name of the identifier attribute or null if none.</p> <hr> <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>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#name">name</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> <p>Friendly type 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="create"></a><a href="#create" 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>create</h3> <p>▸ <strong>create</strong>(<code>snapshot?</code>: <a href="undefined">C</a>, <code>env?</code>: any): <em>this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#create">create</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> <p>Creates an instance for the type given an snapshot input.</p> <p><strong>Parameters:</strong></p> <table> @@ -118,14 +118,14 @@ <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" aria- <h3><a class="anchor" aria-hidden="true" id="describe"></a><a href="#describe" 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>describe</h3> <p>▸ <strong>describe</strong>(): <em>string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#describe">describe</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> <p>Gets the textual representation of the type as a string.</p> <p><strong>Returns:</strong> <em>string</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" 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>is</h3> <p>▸ <strong>is</strong>(<code>thing</code>: any): <em>thing is T | this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#is">is</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> <p>Checks if a given snapshot / instance is of the given type.</p> <p><strong>Parameters:</strong></p> <table> @@ -142,7 +142,7 @@ <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" aria-hidden=" <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" 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>validate</h3> <p>▸ <strong>validate</strong>(<code>thing</code>: T, <code>context</code>: <a href="/API/#ivalidationcontext">IValidationContext</a>): <em><a href="/API/#ivalidationresult">IValidationResult</a></em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#validate">validate</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> <p>Run's the type's typechecker on the given value with the given validation context.</p> <p><strong>Parameters:</strong></p> <table> diff --git a/API/interfaces/isimpletype/index.html b/API/interfaces/isimpletype/index.html index d6950b3d6..7b53b63a9 100644 --- a/API/interfaces/isimpletype/index.html +++ b/API/interfaces/isimpletype/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ISimpleType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [ISimpleType](/API/interfaces/isimpletype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ISimpleType · 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.2](/API/) › [ISimpleType](/API/interfaces/isimpletype)"/><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>ISimpleType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [ISimpleType](/API/interfaces/isimpletype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ISimpleType · 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 - v6.0.0](/API/) › [ISimpleType](/API/interfaces/isimpletype)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/isimpletype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ISimpleType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/isimpletype">ISimpleType</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/isimpletype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ISimpleType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/isimpletype">ISimpleType</a></p> <p>A simple type, this is, a type where the instance and the snapshot representation are the same.</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>T</strong></p> @@ -88,19 +88,19 @@ <h2><a class="anchor" aria-hidden="true" id="properties-1"></a><a href="#propert <h3><a class="anchor" aria-hidden="true" id="optional-identifierattribute"></a><a href="#optional-identifierattribute" 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><code>Optional</code> identifierAttribute</h3> <p>• <strong>identifierAttribute</strong>? : <em>undefined | string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#optional-identifierattribute">identifierAttribute</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> <p>Name of the identifier attribute or null if none.</p> <hr> <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>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#name">name</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> <p>Friendly type 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="create"></a><a href="#create" 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>create</h3> <p>▸ <strong>create</strong>(<code>snapshot?</code>: <a href="undefined">C</a>, <code>env?</code>: any): <em>this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#create">create</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> <p>Creates an instance for the type given an snapshot input.</p> <p><strong>Parameters:</strong></p> <table> @@ -118,14 +118,14 @@ <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" aria- <h3><a class="anchor" aria-hidden="true" id="describe"></a><a href="#describe" 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>describe</h3> <p>▸ <strong>describe</strong>(): <em>string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#describe">describe</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> <p>Gets the textual representation of the type as a string.</p> <p><strong>Returns:</strong> <em>string</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" 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>is</h3> <p>▸ <strong>is</strong>(<code>thing</code>: any): <em>thing is T | this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#is">is</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> <p>Checks if a given snapshot / instance is of the given type.</p> <p><strong>Parameters:</strong></p> <table> @@ -142,7 +142,7 @@ <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" aria-hidden=" <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" 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>validate</h3> <p>▸ <strong>validate</strong>(<code>thing</code>: T, <code>context</code>: <a href="/API/#ivalidationcontext">IValidationContext</a>): <em><a href="/API/#ivalidationresult">IValidationResult</a></em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#validate">validate</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> <p>Run's the type's typechecker on the given value with the given validation context.</p> <p><strong>Parameters:</strong></p> <table> diff --git a/API/interfaces/isnapshotprocessor.html b/API/interfaces/isnapshotprocessor.html index ea70c3161..f25d884d4 100644 --- a/API/interfaces/isnapshotprocessor.html +++ b/API/interfaces/isnapshotprocessor.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ISnapshotProcessor · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [ISnapshotProcessor](/API/interfaces/isnapshotprocessor)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ISnapshotProcessor · 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.2](/API/) › [ISnapshotProcessor](/API/interfaces/isnapshotprocessor)"/><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>ISnapshotProcessor · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [ISnapshotProcessor](/API/interfaces/isnapshotprocessor)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ISnapshotProcessor · 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 - v6.0.0](/API/) › [ISnapshotProcessor](/API/interfaces/isnapshotprocessor)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/isnapshotprocessor.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ISnapshotProcessor</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/isnapshotprocessor">ISnapshotProcessor</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/isnapshotprocessor.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ISnapshotProcessor</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/isnapshotprocessor">ISnapshotProcessor</a></p> <p>A type that has its snapshots processed.</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>IT</strong>: <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> @@ -90,19 +90,19 @@ <h2><a class="anchor" aria-hidden="true" id="properties-1"></a><a href="#propert <h3><a class="anchor" aria-hidden="true" id="optional-identifierattribute"></a><a href="#optional-identifierattribute" 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><code>Optional</code> identifierAttribute</h3> <p>• <strong>identifierAttribute</strong>? : <em>undefined | string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#optional-identifierattribute">identifierAttribute</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> <p>Name of the identifier attribute or null if none.</p> <hr> <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>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#name">name</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> <p>Friendly type 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="create"></a><a href="#create" 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>create</h3> <p>▸ <strong>create</strong>(<code>snapshot?</code>: <a href="undefined">C</a>, <code>env?</code>: any): <em>this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#create">create</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> <p>Creates an instance for the type given an snapshot input.</p> <p><strong>Parameters:</strong></p> <table> @@ -120,14 +120,14 @@ <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" aria- <h3><a class="anchor" aria-hidden="true" id="describe"></a><a href="#describe" 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>describe</h3> <p>▸ <strong>describe</strong>(): <em>string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#describe">describe</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> <p>Gets the textual representation of the type as a string.</p> <p><strong>Returns:</strong> <em>string</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" 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>is</h3> <p>▸ <strong>is</strong>(<code>thing</code>: any): <em>thing is _CustomOrOther<CustomC, IT["CreationType"]> | this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#is">is</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> <p>Checks if a given snapshot / instance is of the given type.</p> <p><strong>Parameters:</strong></p> <table> @@ -144,7 +144,7 @@ <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" aria-hidden=" <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" 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>validate</h3> <p>▸ <strong>validate</strong>(<code>thing</code>: _CustomOrOther‹CustomC, IT["CreationType"]›, <code>context</code>: <a href="/API/#ivalidationcontext">IValidationContext</a>): <em><a href="/API/#ivalidationresult">IValidationResult</a></em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#validate">validate</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> <p>Run's the type's typechecker on the given value with the given validation context.</p> <p><strong>Parameters:</strong></p> <table> diff --git a/API/interfaces/isnapshotprocessor/index.html b/API/interfaces/isnapshotprocessor/index.html index ea70c3161..f25d884d4 100644 --- a/API/interfaces/isnapshotprocessor/index.html +++ b/API/interfaces/isnapshotprocessor/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ISnapshotProcessor · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [ISnapshotProcessor](/API/interfaces/isnapshotprocessor)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ISnapshotProcessor · 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.2](/API/) › [ISnapshotProcessor](/API/interfaces/isnapshotprocessor)"/><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>ISnapshotProcessor · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [ISnapshotProcessor](/API/interfaces/isnapshotprocessor)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ISnapshotProcessor · 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 - v6.0.0](/API/) › [ISnapshotProcessor](/API/interfaces/isnapshotprocessor)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/isnapshotprocessor.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ISnapshotProcessor</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/isnapshotprocessor">ISnapshotProcessor</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/isnapshotprocessor.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ISnapshotProcessor</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/isnapshotprocessor">ISnapshotProcessor</a></p> <p>A type that has its snapshots processed.</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>IT</strong>: <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> @@ -90,19 +90,19 @@ <h2><a class="anchor" aria-hidden="true" id="properties-1"></a><a href="#propert <h3><a class="anchor" aria-hidden="true" id="optional-identifierattribute"></a><a href="#optional-identifierattribute" 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><code>Optional</code> identifierAttribute</h3> <p>• <strong>identifierAttribute</strong>? : <em>undefined | string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#optional-identifierattribute">identifierAttribute</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> <p>Name of the identifier attribute or null if none.</p> <hr> <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>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#name">name</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> <p>Friendly type 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="create"></a><a href="#create" 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>create</h3> <p>▸ <strong>create</strong>(<code>snapshot?</code>: <a href="undefined">C</a>, <code>env?</code>: any): <em>this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#create">create</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> <p>Creates an instance for the type given an snapshot input.</p> <p><strong>Parameters:</strong></p> <table> @@ -120,14 +120,14 @@ <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" aria- <h3><a class="anchor" aria-hidden="true" id="describe"></a><a href="#describe" 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>describe</h3> <p>▸ <strong>describe</strong>(): <em>string</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#describe">describe</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> <p>Gets the textual representation of the type as a string.</p> <p><strong>Returns:</strong> <em>string</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" 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>is</h3> <p>▸ <strong>is</strong>(<code>thing</code>: any): <em>thing is _CustomOrOther<CustomC, IT["CreationType"]> | this["Type"]</em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#is">is</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> <p>Checks if a given snapshot / instance is of the given type.</p> <p><strong>Parameters:</strong></p> <table> @@ -144,7 +144,7 @@ <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" aria-hidden=" <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" 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>validate</h3> <p>▸ <strong>validate</strong>(<code>thing</code>: _CustomOrOther‹CustomC, IT["CreationType"]›, <code>context</code>: <a href="/API/#ivalidationcontext">IValidationContext</a>): <em><a href="/API/#ivalidationresult">IValidationResult</a></em></p> <p><em>Inherited from <a href="/API/interfaces/itype">IType</a>.<a href="/API/interfaces/itype#validate">validate</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> <p>Run's the type's typechecker on the given value with the given validation context.</p> <p><strong>Parameters:</strong></p> <table> diff --git a/API/interfaces/isnapshotprocessors.html b/API/interfaces/isnapshotprocessors.html index 19a6e9a50..57fd8cff8 100644 --- a/API/interfaces/isnapshotprocessors.html +++ b/API/interfaces/isnapshotprocessors.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ISnapshotProcessors · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [ISnapshotProcessors](/API/interfaces/isnapshotprocessors)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ISnapshotProcessors · 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.2](/API/) › [ISnapshotProcessors](/API/interfaces/isnapshotprocessors)"/><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>ISnapshotProcessors · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [ISnapshotProcessors](/API/interfaces/isnapshotprocessors)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ISnapshotProcessors · 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 - v6.0.0](/API/) › [ISnapshotProcessors](/API/interfaces/isnapshotprocessors)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/isnapshotprocessors.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ISnapshotProcessors</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/isnapshotprocessors">ISnapshotProcessors</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/isnapshotprocessors.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ISnapshotProcessors</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/isnapshotprocessors">ISnapshotProcessors</a></p> <p>Snapshot processors.</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>IT</strong>: <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> @@ -81,7 +81,7 @@ <h3><a class="anchor" aria-hidden="true" id="methods"></a><a href="#methods" ari <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="optional-postprocessor"></a><a href="#optional-postprocessor" 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><code>Optional</code> postProcessor</h3> <p>▸ <strong>postProcessor</strong>(<code>snapshot</code>: IT["SnapshotType"], <code>node</code>: <a href="/API/#instance">Instance</a>‹IT›): <em>CustomS</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/snapshotProcessor.ts#L211">src/types/utility-types/snapshotProcessor.ts:211</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/snapshotProcessor.ts#L211">src/types/utility-types/snapshotProcessor.ts:211</a></em></p> <p>Function that transforms an output snapshot.</p> <p><strong>Parameters:</strong></p> <table> @@ -97,7 +97,7 @@ <h3><a class="anchor" aria-hidden="true" id="optional-postprocessor"></a><a href <hr> <h3><a class="anchor" aria-hidden="true" id="optional-preprocessor"></a><a href="#optional-preprocessor" 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><code>Optional</code> preProcessor</h3> <p>▸ <strong>preProcessor</strong>(<code>snapshot</code>: CustomC): <em>IT["CreationType"]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/snapshotProcessor.ts#L206">src/types/utility-types/snapshotProcessor.ts:206</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/snapshotProcessor.ts#L206">src/types/utility-types/snapshotProcessor.ts:206</a></em></p> <p>Function that transforms an input snapshot.</p> <p><strong>Parameters:</strong></p> <table> diff --git a/API/interfaces/isnapshotprocessors/index.html b/API/interfaces/isnapshotprocessors/index.html index 19a6e9a50..57fd8cff8 100644 --- a/API/interfaces/isnapshotprocessors/index.html +++ b/API/interfaces/isnapshotprocessors/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ISnapshotProcessors · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [ISnapshotProcessors](/API/interfaces/isnapshotprocessors)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ISnapshotProcessors · 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.2](/API/) › [ISnapshotProcessors](/API/interfaces/isnapshotprocessors)"/><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>ISnapshotProcessors · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [ISnapshotProcessors](/API/interfaces/isnapshotprocessors)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ISnapshotProcessors · 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 - v6.0.0](/API/) › [ISnapshotProcessors](/API/interfaces/isnapshotprocessors)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/isnapshotprocessors.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ISnapshotProcessors</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/isnapshotprocessors">ISnapshotProcessors</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/isnapshotprocessors.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ISnapshotProcessors</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/isnapshotprocessors">ISnapshotProcessors</a></p> <p>Snapshot processors.</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>IT</strong>: <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> @@ -81,7 +81,7 @@ <h3><a class="anchor" aria-hidden="true" id="methods"></a><a href="#methods" ari <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="optional-postprocessor"></a><a href="#optional-postprocessor" 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><code>Optional</code> postProcessor</h3> <p>▸ <strong>postProcessor</strong>(<code>snapshot</code>: IT["SnapshotType"], <code>node</code>: <a href="/API/#instance">Instance</a>‹IT›): <em>CustomS</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/snapshotProcessor.ts#L211">src/types/utility-types/snapshotProcessor.ts:211</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/snapshotProcessor.ts#L211">src/types/utility-types/snapshotProcessor.ts:211</a></em></p> <p>Function that transforms an output snapshot.</p> <p><strong>Parameters:</strong></p> <table> @@ -97,7 +97,7 @@ <h3><a class="anchor" aria-hidden="true" id="optional-postprocessor"></a><a href <hr> <h3><a class="anchor" aria-hidden="true" id="optional-preprocessor"></a><a href="#optional-preprocessor" 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><code>Optional</code> preProcessor</h3> <p>▸ <strong>preProcessor</strong>(<code>snapshot</code>: CustomC): <em>IT["CreationType"]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/snapshotProcessor.ts#L206">src/types/utility-types/snapshotProcessor.ts:206</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/snapshotProcessor.ts#L206">src/types/utility-types/snapshotProcessor.ts:206</a></em></p> <p>Function that transforms an input snapshot.</p> <p><strong>Parameters:</strong></p> <table> diff --git a/API/interfaces/itype.html b/API/interfaces/itype.html index b23e7ce0d..cc5bd75ed 100644 --- a/API/interfaces/itype.html +++ b/API/interfaces/itype.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IType](/API/interfaces/itype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IType · 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.2](/API/) › [IType](/API/interfaces/itype)"/><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>IType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IType](/API/interfaces/itype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IType · 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 - v6.0.0](/API/) › [IType](/API/interfaces/itype)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/itype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/itype">IType</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/itype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/itype">IType</a></p> <p>A type, either complex or simple.</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>C</strong></p> @@ -93,17 +93,17 @@ <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="optional-identifierattribute"></a><a href="#optional-identifierattribute" 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><code>Optional</code> identifierAttribute</h3> <p>• <strong>identifierAttribute</strong>? : <em>undefined | string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> <p>Name of the identifier attribute or null if none.</p> <hr> <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/700ab6f8/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> <p>Friendly type 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="create"></a><a href="#create" 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>create</h3> <p>▸ <strong>create</strong>(<code>snapshot?</code>: <a href="undefined">C</a>, <code>env?</code>: any): <em>this["Type"]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> <p>Creates an instance for the type given an snapshot input.</p> <p><strong>Parameters:</strong></p> <table> @@ -120,13 +120,13 @@ <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" aria- <hr> <h3><a class="anchor" aria-hidden="true" id="describe"></a><a href="#describe" 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>describe</h3> <p>▸ <strong>describe</strong>(): <em>string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> <p>Gets the textual representation of the type as a string.</p> <p><strong>Returns:</strong> <em>string</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" 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>is</h3> <p>▸ <strong>is</strong>(<code>thing</code>: any): <em>thing is C | this["Type"]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> <p>Checks if a given snapshot / instance is of the given type.</p> <p><strong>Parameters:</strong></p> <table> @@ -142,7 +142,7 @@ <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" aria-hidden=" <hr> <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" 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>validate</h3> <p>▸ <strong>validate</strong>(<code>thing</code>: C, <code>context</code>: <a href="/API/#ivalidationcontext">IValidationContext</a>): <em><a href="/API/#ivalidationresult">IValidationResult</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> <p>Run's the type's typechecker on the given value with the given validation context.</p> <p><strong>Parameters:</strong></p> <table> diff --git a/API/interfaces/itype/index.html b/API/interfaces/itype/index.html index b23e7ce0d..cc5bd75ed 100644 --- a/API/interfaces/itype/index.html +++ b/API/interfaces/itype/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IType](/API/interfaces/itype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IType · 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.2](/API/) › [IType](/API/interfaces/itype)"/><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>IType · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IType](/API/interfaces/itype)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IType · 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 - v6.0.0](/API/) › [IType](/API/interfaces/itype)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/itype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/itype">IType</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/itype.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IType</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/itype">IType</a></p> <p>A type, either complex or simple.</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>C</strong></p> @@ -93,17 +93,17 @@ <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="optional-identifierattribute"></a><a href="#optional-identifierattribute" 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><code>Optional</code> identifierAttribute</h3> <p>• <strong>identifierAttribute</strong>? : <em>undefined | string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L89">src/core/type/type.ts:89</a></em></p> <p>Name of the identifier attribute or null if none.</p> <hr> <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/700ab6f8/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L84">src/core/type/type.ts:84</a></em></p> <p>Friendly type 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="create"></a><a href="#create" 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>create</h3> <p>▸ <strong>create</strong>(<code>snapshot?</code>: <a href="undefined">C</a>, <code>env?</code>: any): <em>this["Type"]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L96">src/core/type/type.ts:96</a></em></p> <p>Creates an instance for the type given an snapshot input.</p> <p><strong>Parameters:</strong></p> <table> @@ -120,13 +120,13 @@ <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" aria- <hr> <h3><a class="anchor" aria-hidden="true" id="describe"></a><a href="#describe" 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>describe</h3> <p>▸ <strong>describe</strong>(): <em>string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L118">src/core/type/type.ts:118</a></em></p> <p>Gets the textual representation of the type as a string.</p> <p><strong>Returns:</strong> <em>string</em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" 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>is</h3> <p>▸ <strong>is</strong>(<code>thing</code>: any): <em>thing is C | this["Type"]</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L104">src/core/type/type.ts:104</a></em></p> <p>Checks if a given snapshot / instance is of the given type.</p> <p><strong>Parameters:</strong></p> <table> @@ -142,7 +142,7 @@ <h3><a class="anchor" aria-hidden="true" id="is"></a><a href="#is" aria-hidden=" <hr> <h3><a class="anchor" aria-hidden="true" id="validate"></a><a href="#validate" 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>validate</h3> <p>▸ <strong>validate</strong>(<code>thing</code>: C, <code>context</code>: <a href="/API/#ivalidationcontext">IValidationContext</a>): <em><a href="/API/#ivalidationresult">IValidationResult</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type.ts#L113">src/core/type/type.ts:113</a></em></p> <p>Run's the type's typechecker on the given value with the given validation context.</p> <p><strong>Parameters:</strong></p> <table> diff --git a/API/interfaces/ivalidationcontextentry.html b/API/interfaces/ivalidationcontextentry.html index 5a1e6fea4..4e2962bcc 100644 --- a/API/interfaces/ivalidationcontextentry.html +++ b/API/interfaces/ivalidationcontextentry.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IValidationContextEntry · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IValidationContextEntry](/API/interfaces/ivalidationcontextentry)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IValidationContextEntry · 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.2](/API/) › [IValidationContextEntry](/API/interfaces/ivalidationcontextentry)"/><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>IValidationContextEntry · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IValidationContextEntry](/API/interfaces/ivalidationcontextentry)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IValidationContextEntry · 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 - v6.0.0](/API/) › [IValidationContextEntry](/API/interfaces/ivalidationcontextentry)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ivalidationcontextentry.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IValidationContextEntry</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ivalidationcontextentry">IValidationContextEntry</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ivalidationcontextentry.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IValidationContextEntry</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ivalidationcontextentry">IValidationContextEntry</a></p> <p>Validation context entry, this is, where the validation should run against which type</p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> @@ -77,12 +77,12 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="path"></a><a href="#path" 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>path</h3> <p>• <strong>path</strong>: <em>string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type-checker.ts#L17">src/core/type/type-checker.ts:17</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type-checker.ts#L17">src/core/type/type-checker.ts:17</a></em></p> <p>Subpath where the validation should be run, or an empty string to validate it all</p> <hr> <h3><a class="anchor" aria-hidden="true" id="type"></a><a href="#type" 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</h3> <p>• <strong>type</strong>: <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type-checker.ts#L19">src/core/type/type-checker.ts:19</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type-checker.ts#L19">src/core/type/type-checker.ts:19</a></em></p> <p>Type to validate the subpath against</p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/itype"><span class="arrow-prev">← </span><span>IType</span></a><a class="docs-next button" href="/API/interfaces/ivalidationerror"><span class="function-name-prevnext">IValidationError</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#path">path</a></li><li><a href="#type">type</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) { diff --git a/API/interfaces/ivalidationcontextentry/index.html b/API/interfaces/ivalidationcontextentry/index.html index 5a1e6fea4..4e2962bcc 100644 --- a/API/interfaces/ivalidationcontextentry/index.html +++ b/API/interfaces/ivalidationcontextentry/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IValidationContextEntry · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IValidationContextEntry](/API/interfaces/ivalidationcontextentry)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IValidationContextEntry · 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.2](/API/) › [IValidationContextEntry](/API/interfaces/ivalidationcontextentry)"/><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>IValidationContextEntry · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IValidationContextEntry](/API/interfaces/ivalidationcontextentry)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IValidationContextEntry · 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 - v6.0.0](/API/) › [IValidationContextEntry](/API/interfaces/ivalidationcontextentry)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ivalidationcontextentry.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IValidationContextEntry</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ivalidationcontextentry">IValidationContextEntry</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ivalidationcontextentry.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IValidationContextEntry</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ivalidationcontextentry">IValidationContextEntry</a></p> <p>Validation context entry, this is, where the validation should run against which type</p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> @@ -77,12 +77,12 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="path"></a><a href="#path" 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>path</h3> <p>• <strong>path</strong>: <em>string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type-checker.ts#L17">src/core/type/type-checker.ts:17</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type-checker.ts#L17">src/core/type/type-checker.ts:17</a></em></p> <p>Subpath where the validation should be run, or an empty string to validate it all</p> <hr> <h3><a class="anchor" aria-hidden="true" id="type"></a><a href="#type" 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</h3> <p>• <strong>type</strong>: <em><a href="/API/interfaces/ianytype">IAnyType</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type-checker.ts#L19">src/core/type/type-checker.ts:19</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type-checker.ts#L19">src/core/type/type-checker.ts:19</a></em></p> <p>Type to validate the subpath against</p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/itype"><span class="arrow-prev">← </span><span>IType</span></a><a class="docs-next button" href="/API/interfaces/ivalidationerror"><span class="function-name-prevnext">IValidationError</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#path">path</a></li><li><a href="#type">type</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) { diff --git a/API/interfaces/ivalidationerror.html b/API/interfaces/ivalidationerror.html index eabd78f01..6285c50fa 100644 --- a/API/interfaces/ivalidationerror.html +++ b/API/interfaces/ivalidationerror.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IValidationError · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IValidationError](/API/interfaces/ivalidationerror)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IValidationError · 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.2](/API/) › [IValidationError](/API/interfaces/ivalidationerror)"/><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>IValidationError · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IValidationError](/API/interfaces/ivalidationerror)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IValidationError · 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 - v6.0.0](/API/) › [IValidationError](/API/interfaces/ivalidationerror)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ivalidationerror.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IValidationError</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ivalidationerror">IValidationError</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ivalidationerror.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IValidationError</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ivalidationerror">IValidationError</a></p> <p>Type validation error</p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> @@ -78,17 +78,17 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="context"></a><a href="#context" 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>context</h3> <p>• <strong>context</strong>: <em><a href="/API/#ivalidationcontext">IValidationContext</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type-checker.ts#L28">src/core/type/type-checker.ts:28</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type-checker.ts#L28">src/core/type/type-checker.ts:28</a></em></p> <p>Validation context</p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-message"></a><a href="#optional-message" 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><code>Optional</code> message</h3> <p>• <strong>message</strong>? : <em>undefined | string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type-checker.ts#L32">src/core/type/type-checker.ts:32</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type-checker.ts#L32">src/core/type/type-checker.ts:32</a></em></p> <p>Error message</p> <hr> <h3><a class="anchor" aria-hidden="true" id="value"></a><a href="#value" 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>value</h3> <p>• <strong>value</strong>: <em>any</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type-checker.ts#L30">src/core/type/type-checker.ts:30</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type-checker.ts#L30">src/core/type/type-checker.ts:30</a></em></p> <p>Value that was being validated, either a snapshot or an instance</p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/ivalidationcontextentry"><span class="arrow-prev">← </span><span class="function-name-prevnext">IValidationContextEntry</span></a><a class="docs-next button" href="/API/interfaces/referenceoptionsgetset"><span class="function-name-prevnext">ReferenceOptionsGetSet</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#context">context</a></li><li><a href="#optional-message"><code>Optional</code> message</a></li><li><a href="#value">value</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) { diff --git a/API/interfaces/ivalidationerror/index.html b/API/interfaces/ivalidationerror/index.html index eabd78f01..6285c50fa 100644 --- a/API/interfaces/ivalidationerror/index.html +++ b/API/interfaces/ivalidationerror/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IValidationError · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [IValidationError](/API/interfaces/ivalidationerror)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IValidationError · 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.2](/API/) › [IValidationError](/API/interfaces/ivalidationerror)"/><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>IValidationError · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [IValidationError](/API/interfaces/ivalidationerror)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="IValidationError · 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 - v6.0.0](/API/) › [IValidationError](/API/interfaces/ivalidationerror)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/ivalidationerror.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IValidationError</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/ivalidationerror">IValidationError</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/ivalidationerror.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">IValidationError</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/ivalidationerror">IValidationError</a></p> <p>Type validation error</p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> @@ -78,17 +78,17 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="context"></a><a href="#context" 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>context</h3> <p>• <strong>context</strong>: <em><a href="/API/#ivalidationcontext">IValidationContext</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type-checker.ts#L28">src/core/type/type-checker.ts:28</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type-checker.ts#L28">src/core/type/type-checker.ts:28</a></em></p> <p>Validation context</p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-message"></a><a href="#optional-message" 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><code>Optional</code> message</h3> <p>• <strong>message</strong>? : <em>undefined | string</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type-checker.ts#L32">src/core/type/type-checker.ts:32</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type-checker.ts#L32">src/core/type/type-checker.ts:32</a></em></p> <p>Error message</p> <hr> <h3><a class="anchor" aria-hidden="true" id="value"></a><a href="#value" 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>value</h3> <p>• <strong>value</strong>: <em>any</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/core/type/type-checker.ts#L30">src/core/type/type-checker.ts:30</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/core/type/type-checker.ts#L30">src/core/type/type-checker.ts:30</a></em></p> <p>Value that was being validated, either a snapshot or an instance</p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/ivalidationcontextentry"><span class="arrow-prev">← </span><span class="function-name-prevnext">IValidationContextEntry</span></a><a class="docs-next button" href="/API/interfaces/referenceoptionsgetset"><span class="function-name-prevnext">ReferenceOptionsGetSet</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#context">context</a></li><li><a href="#optional-message"><code>Optional</code> message</a></li><li><a href="#value">value</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) { diff --git a/API/interfaces/referenceoptionsgetset.html b/API/interfaces/referenceoptionsgetset.html index d63ce5b8f..f26e496f4 100644 --- a/API/interfaces/referenceoptionsgetset.html +++ b/API/interfaces/referenceoptionsgetset.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ReferenceOptionsGetSet · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [ReferenceOptionsGetSet](/API/interfaces/referenceoptionsgetset)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ReferenceOptionsGetSet · 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.2](/API/) › [ReferenceOptionsGetSet](/API/interfaces/referenceoptionsgetset)"/><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>ReferenceOptionsGetSet · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [ReferenceOptionsGetSet](/API/interfaces/referenceoptionsgetset)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ReferenceOptionsGetSet · 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 - v6.0.0](/API/) › [ReferenceOptionsGetSet](/API/interfaces/referenceoptionsgetset)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/referenceoptionsgetset.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ReferenceOptionsGetSet</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/referenceoptionsgetset">ReferenceOptionsGetSet</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/referenceoptionsgetset.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ReferenceOptionsGetSet</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/referenceoptionsgetset">ReferenceOptionsGetSet</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>IT</strong>: <em><a href="/API/interfaces/ianycomplextype">IAnyComplexType</a></em></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> @@ -78,7 +78,7 @@ <h3><a class="anchor" aria-hidden="true" id="methods"></a><a href="#methods" ari <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="get"></a><a href="#get" 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>get</h3> <p>▸ <strong>get</strong>(<code>identifier</code>: <a href="/API/#referenceidentifier">ReferenceIdentifier</a>, <code>parent</code>: IAnyStateTreeNode | null): <em>ReferenceT‹IT›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/reference.ts#L442">src/types/utility-types/reference.ts:442</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/reference.ts#L442">src/types/utility-types/reference.ts:442</a></em></p> <p><strong>Parameters:</strong></p> <table> <thead> @@ -93,7 +93,7 @@ <h3><a class="anchor" aria-hidden="true" id="get"></a><a href="#get" aria-hidden <hr> <h3><a class="anchor" aria-hidden="true" id="set"></a><a href="#set" 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>set</h3> <p>▸ <strong>set</strong>(<code>value</code>: ReferenceT‹IT›, <code>parent</code>: IAnyStateTreeNode | null): <em><a href="/API/#referenceidentifier">ReferenceIdentifier</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/reference.ts#L443">src/types/utility-types/reference.ts:443</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/reference.ts#L443">src/types/utility-types/reference.ts:443</a></em></p> <p><strong>Parameters:</strong></p> <table> <thead> diff --git a/API/interfaces/referenceoptionsgetset/index.html b/API/interfaces/referenceoptionsgetset/index.html index d63ce5b8f..f26e496f4 100644 --- a/API/interfaces/referenceoptionsgetset/index.html +++ b/API/interfaces/referenceoptionsgetset/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ReferenceOptionsGetSet · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [ReferenceOptionsGetSet](/API/interfaces/referenceoptionsgetset)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ReferenceOptionsGetSet · 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.2](/API/) › [ReferenceOptionsGetSet](/API/interfaces/referenceoptionsgetset)"/><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>ReferenceOptionsGetSet · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [ReferenceOptionsGetSet](/API/interfaces/referenceoptionsgetset)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ReferenceOptionsGetSet · 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 - v6.0.0](/API/) › [ReferenceOptionsGetSet](/API/interfaces/referenceoptionsgetset)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/referenceoptionsgetset.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ReferenceOptionsGetSet</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/referenceoptionsgetset">ReferenceOptionsGetSet</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/referenceoptionsgetset.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ReferenceOptionsGetSet</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/referenceoptionsgetset">ReferenceOptionsGetSet</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>IT</strong>: <em><a href="/API/interfaces/ianycomplextype">IAnyComplexType</a></em></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> @@ -78,7 +78,7 @@ <h3><a class="anchor" aria-hidden="true" id="methods"></a><a href="#methods" ari <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="get"></a><a href="#get" 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>get</h3> <p>▸ <strong>get</strong>(<code>identifier</code>: <a href="/API/#referenceidentifier">ReferenceIdentifier</a>, <code>parent</code>: IAnyStateTreeNode | null): <em>ReferenceT‹IT›</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/reference.ts#L442">src/types/utility-types/reference.ts:442</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/reference.ts#L442">src/types/utility-types/reference.ts:442</a></em></p> <p><strong>Parameters:</strong></p> <table> <thead> @@ -93,7 +93,7 @@ <h3><a class="anchor" aria-hidden="true" id="get"></a><a href="#get" aria-hidden <hr> <h3><a class="anchor" aria-hidden="true" id="set"></a><a href="#set" 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>set</h3> <p>▸ <strong>set</strong>(<code>value</code>: ReferenceT‹IT›, <code>parent</code>: IAnyStateTreeNode | null): <em><a href="/API/#referenceidentifier">ReferenceIdentifier</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/reference.ts#L443">src/types/utility-types/reference.ts:443</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/reference.ts#L443">src/types/utility-types/reference.ts:443</a></em></p> <p><strong>Parameters:</strong></p> <table> <thead> diff --git a/API/interfaces/referenceoptionsoninvalidated.html b/API/interfaces/referenceoptionsoninvalidated.html index 04b05a118..ee2138fa5 100644 --- a/API/interfaces/referenceoptionsoninvalidated.html +++ b/API/interfaces/referenceoptionsoninvalidated.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ReferenceOptionsOnInvalidated · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [ReferenceOptionsOnInvalidated](/API/interfaces/referenceoptionsoninvalidated)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ReferenceOptionsOnInvalidated · 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.2](/API/) › [ReferenceOptionsOnInvalidated](/API/interfaces/referenceoptionsoninvalidated)"/><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>ReferenceOptionsOnInvalidated · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [ReferenceOptionsOnInvalidated](/API/interfaces/referenceoptionsoninvalidated)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ReferenceOptionsOnInvalidated · 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 - v6.0.0](/API/) › [ReferenceOptionsOnInvalidated](/API/interfaces/referenceoptionsoninvalidated)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/referenceoptionsoninvalidated.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ReferenceOptionsOnInvalidated</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/referenceoptionsoninvalidated">ReferenceOptionsOnInvalidated</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/referenceoptionsoninvalidated.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ReferenceOptionsOnInvalidated</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/referenceoptionsoninvalidated">ReferenceOptionsOnInvalidated</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>IT</strong>: <em><a href="/API/interfaces/ianycomplextype">IAnyComplexType</a></em></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> @@ -77,7 +77,7 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="oninvalidated"></a><a href="#oninvalidated" 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>onInvalidated</h3> <p>• <strong>onInvalidated</strong>: <em><a href="/API/#onreferenceinvalidated">OnReferenceInvalidated</a>‹ReferenceT‹IT››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/reference.ts#L448">src/types/utility-types/reference.ts:448</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/reference.ts#L448">src/types/utility-types/reference.ts:448</a></em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/referenceoptionsgetset"><span class="arrow-prev">← </span><span class="function-name-prevnext">ReferenceOptionsGetSet</span></a><a class="docs-next button" href="/API/interfaces/unionoptions"><span class="function-name-prevnext">UnionOptions</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></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#oninvalidated">onInvalidated</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) { diff --git a/API/interfaces/referenceoptionsoninvalidated/index.html b/API/interfaces/referenceoptionsoninvalidated/index.html index 04b05a118..ee2138fa5 100644 --- a/API/interfaces/referenceoptionsoninvalidated/index.html +++ b/API/interfaces/referenceoptionsoninvalidated/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ReferenceOptionsOnInvalidated · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [ReferenceOptionsOnInvalidated](/API/interfaces/referenceoptionsoninvalidated)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ReferenceOptionsOnInvalidated · 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.2](/API/) › [ReferenceOptionsOnInvalidated](/API/interfaces/referenceoptionsoninvalidated)"/><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>ReferenceOptionsOnInvalidated · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [ReferenceOptionsOnInvalidated](/API/interfaces/referenceoptionsoninvalidated)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="ReferenceOptionsOnInvalidated · 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 - v6.0.0](/API/) › [ReferenceOptionsOnInvalidated](/API/interfaces/referenceoptionsoninvalidated)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/referenceoptionsoninvalidated.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ReferenceOptionsOnInvalidated</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/referenceoptionsoninvalidated">ReferenceOptionsOnInvalidated</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/referenceoptionsoninvalidated.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">ReferenceOptionsOnInvalidated</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/referenceoptionsoninvalidated">ReferenceOptionsOnInvalidated</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>IT</strong>: <em><a href="/API/interfaces/ianycomplextype">IAnyComplexType</a></em></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> @@ -77,7 +77,7 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="oninvalidated"></a><a href="#oninvalidated" 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>onInvalidated</h3> <p>• <strong>onInvalidated</strong>: <em><a href="/API/#onreferenceinvalidated">OnReferenceInvalidated</a>‹ReferenceT‹IT››</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/reference.ts#L448">src/types/utility-types/reference.ts:448</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/reference.ts#L448">src/types/utility-types/reference.ts:448</a></em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/referenceoptionsgetset"><span class="arrow-prev">← </span><span class="function-name-prevnext">ReferenceOptionsGetSet</span></a><a class="docs-next button" href="/API/interfaces/unionoptions"><span class="function-name-prevnext">UnionOptions</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></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#oninvalidated">onInvalidated</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) { diff --git a/API/interfaces/unionoptions.html b/API/interfaces/unionoptions.html index eb7946590..2635ca144 100644 --- a/API/interfaces/unionoptions.html +++ b/API/interfaces/unionoptions.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>UnionOptions · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [UnionOptions](/API/interfaces/unionoptions)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="UnionOptions · 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.2](/API/) › [UnionOptions](/API/interfaces/unionoptions)"/><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>UnionOptions · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [UnionOptions](/API/interfaces/unionoptions)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="UnionOptions · 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 - v6.0.0](/API/) › [UnionOptions](/API/interfaces/unionoptions)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/unionoptions.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">UnionOptions</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/unionoptions">UnionOptions</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/unionoptions.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">UnionOptions</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/unionoptions">UnionOptions</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><strong>UnionOptions</strong></li> @@ -76,11 +76,11 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="optional-dispatcher"></a><a href="#optional-dispatcher" 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><code>Optional</code> dispatcher</h3> <p>• <strong>dispatcher</strong>? : <em><a href="/API/#itypedispatcher">ITypeDispatcher</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L31">src/types/utility-types/union.ts:31</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/union.ts#L26">src/types/utility-types/union.ts:26</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-eager"></a><a href="#optional-eager" 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><code>Optional</code> eager</h3> <p>• <strong>eager</strong>? : <em>undefined | false | true</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L30">src/types/utility-types/union.ts:30</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/union.ts#L25">src/types/utility-types/union.ts:25</a></em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/referenceoptionsoninvalidated"><span class="arrow-prev">← </span><span class="function-name-prevnext">ReferenceOptionsOnInvalidated</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#optional-dispatcher"><code>Optional</code> dispatcher</a></li><li><a href="#optional-eager"><code>Optional</code> eager</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) { diff --git a/API/interfaces/unionoptions/index.html b/API/interfaces/unionoptions/index.html index eb7946590..2635ca144 100644 --- a/API/interfaces/unionoptions/index.html +++ b/API/interfaces/unionoptions/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>UnionOptions · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v5.4.2](/API/) › [UnionOptions](/API/interfaces/unionoptions)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="UnionOptions · 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.2](/API/) › [UnionOptions](/API/interfaces/unionoptions)"/><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>UnionOptions · MobX-state-tree</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[mobx-state-tree - v6.0.0](/API/) › [UnionOptions](/API/interfaces/unionoptions)"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="UnionOptions · 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 - v6.0.0](/API/) › [UnionOptions](/API/interfaces/unionoptions)"/><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) @@ -62,7 +62,7 @@ }; } }); - </script></nav></div><div class="container mainContainer docsContainer"><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/unionoptions.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">UnionOptions</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v5.4.2</a> › <a href="/API/interfaces/unionoptions">UnionOptions</a></p> + </script></nav></div><div class="container mainContainer docsContainer"><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/unionoptions.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">UnionOptions</h1></header><article><div><span><p><a href="/API/">mobx-state-tree - v6.0.0</a> › <a href="/API/interfaces/unionoptions">UnionOptions</a></p> <h2><a class="anchor" aria-hidden="true" id="hierarchy"></a><a href="#hierarchy" 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>Hierarchy</h2> <ul> <li><strong>UnionOptions</strong></li> @@ -76,11 +76,11 @@ <h3><a class="anchor" aria-hidden="true" id="properties"></a><a href="#propertie <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="optional-dispatcher"></a><a href="#optional-dispatcher" 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><code>Optional</code> dispatcher</h3> <p>• <strong>dispatcher</strong>? : <em><a href="/API/#itypedispatcher">ITypeDispatcher</a></em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L31">src/types/utility-types/union.ts:31</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/union.ts#L26">src/types/utility-types/union.ts:26</a></em></p> <hr> <h3><a class="anchor" aria-hidden="true" id="optional-eager"></a><a href="#optional-eager" 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><code>Optional</code> eager</h3> <p>• <strong>eager</strong>? : <em>undefined | false | true</em></p> -<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/700ab6f8/src/types/utility-types/union.ts#L30">src/types/utility-types/union.ts:30</a></em></p> +<p><em>Defined in <a href="https://github.com/mobxjs/mobx-state-tree/blob/72f4f644/src/types/utility-types/union.ts#L25">src/types/utility-types/union.ts:25</a></em></p> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/API/interfaces/referenceoptionsoninvalidated"><span class="arrow-prev">← </span><span class="function-name-prevnext">ReferenceOptionsOnInvalidated</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hierarchy">Hierarchy</a></li><li><a href="#index">Index</a><ul class="toc-headings"><li><a href="#properties">Properties</a></li></ul></li><li><a href="#properties-1">Properties</a><ul class="toc-headings"><li><a href="#optional-dispatcher"><code>Optional</code> dispatcher</a></li><li><a href="#optional-eager"><code>Optional</code> eager</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) { diff --git a/intro/welcome.html b/intro/welcome.html index 244d709b8..ba252b38f 100644 --- a/intro/welcome.html +++ b/intro/welcome.html @@ -65,57 +65,51 @@ </script></nav></div><div class="container mainContainer docsContainer"><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/intro/welcome.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Welcome to MobX-State-Tree!</h1></header><article><div><span><div id="codefund"></div> <p><strong><em>Full-featured reactive state management without the boilerplate.</em></strong></p> <h2><a class="anchor" aria-hidden="true" id="what-is-mobx-state-tree"></a><a href="#what-is-mobx-state-tree" 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>What is MobX-State-Tree?</h2> -<p>Technically speaking, MobX-State-Tree (also known as MST) is a state container system built on <a href="https://github.com/mobxjs/mobx">MobX</a>, a functional reactive state library.</p> -<p>This may not mean much to you, and that’s okay. I’ll explain it like this: <strong>MobX is a state management "engine", and MobX-State-Tree gives it structure and common tools you need for your app.</strong> MST is valuable in a large team but also useful in smaller applications when you expect your code to scale rapidly. And if we compare it to Redux, MST offers better performance and much less boilerplate code than Redux!</p> -<p>MobX is <a href="https://2019.stateofjs.com/data-layer/mobx/">one of the most popular Redux alternatives</a> and is used (along with MobX-State-Tree) by companies all over the world, including Netflix, Grow, IBM, DAZN, Baidu, and more.</p> -<p>It supports a full set of features for a modern state management system -- all in a package with <em>zero dependencies</em> other than MobX itself.</p> -<p><em>Note: you don't need to know how to use MobX in order to use MST.</em></p> -<h3><a class="anchor" aria-hidden="true" id="ten-reasons-you-should-use-mobx-state-tree"></a><a href="#ten-reasons-you-should-use-mobx-state-tree" 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>Ten reasons you should use MobX-State-Tree:</h3> +<p>MobX-State-Tree (MST) is a <a href="https://en.wikipedia.org/wiki/Batteries_Included#:~:text=%22Batteries%20included%22%20(slang)%252C%20in%20a%20product%20usability%20(mostly%20in%20software)%20it%20states%20that%20the%20product%20comes%20together%20with%20all%20possible%20parts%20required%20for%20full%20usability">batteries included</a> state management library. It only requires <strong>one peer dependency</strong>, and will provide you with:</p> <ol> -<li><strong>MST works great</strong> in React, React Native, Vue, Angular, Svelte, and even barebones JavaScript apps</li> -<li>Instead of being scattered throughout your app, MST provides <strong>centralized stores</strong> for your data</li> -<li>Your data is <strong>mutable</strong>, but can only be mutated in "actions", so it's <em>easy to use</em> but also <em>protected</em></li> -<li>Via <strong>runtime type checking</strong>, you can't accidentally assign the wrong data type to a property</li> -<li>TypeScript can infer <strong>static types</strong> from your runtime types automatically</li> -<li>Every update to your data is traced and you can quickly <strong>generate snapshots</strong> of your state at any time</li> -<li>MST has built-in support for references so you can <strong>normalize your data</strong> across your whole app</li> -<li><strong>Side effects</strong> can be managed via async flows, which are basically long-running actions</li> -<li>Using snapshots, you can do <strong>time-travel debugging</strong> or logging of state changes over time</li> -<li>MST has a <strong>robust community</strong> and a large, active core team</li> +<li><strong>Centralized stores</strong> for your data</li> +<li><strong>Mutable, but protected data</strong>, which means it is easy to work with your data, but safe to modify.</li> +<li><strong>Serializable and traceable updates</strong>. The mutable, protected nature of MobX-State-Tree data means you can <strong>generate snapshots</strong> and do <strong>time-travel debugging</strong>.</li> +<li><strong>Side effect management</strong>, so you don't need to write <code>useEffect</code> hooks or their equivalent to manage the consequences of data mutations. You can do it all from MST itself.</li> +<li><strong>Runtime type checking</strong>, so you can't accidentally assign the wrong data type to a property</li> +<li><strong>Static type checking</strong> with TypeScript inference from your runtime types - automatically!</li> +<li><strong>Data normalization</strong> - MST has support for references, so you can normalize data across your application code.</li> +<li><strong>Warm, welcoming community</strong>. We pride ourselves on a healthy and kind open source community.</li> </ol> -<h2><a class="anchor" aria-hidden="true" id="basic-example"></a><a href="#basic-example" 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>Basic example</h2> +<h2><a class="anchor" aria-hidden="true" id="basic-example"></a><a href="#basic-example" 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>Basic Example</h2> +<p>Here's what MST code looks like:</p> <p><em>You can play with it in <a href="https://codesandbox.io/s/boring-pond-cmooq?file=/src/index.js">this CodeSandbox playground</a>.</em></p> -<pre><code class="hljs css language-javascript"><span class="hljs-keyword">import</span> { types, onSnapshot } <span class="hljs-keyword">from</span> <span class="hljs-string">"mobx-state-tree"</span> +<pre><code class="hljs css language-javascript"><span class="hljs-keyword">import</span> { t, onSnapshot } <span class="hljs-keyword">from</span> <span class="hljs-string">"mobx-state-tree"</span> <span class="hljs-comment">// A tweet has a body (which is text) and whether it's read or not</span> -<span class="hljs-keyword">const</span> Tweet = types - .model(<span class="hljs-string">"Tweet"</span>, { - <span class="hljs-attr">body</span>: types.string, - <span class="hljs-attr">read</span>: <span class="hljs-literal">false</span> <span class="hljs-comment">// automatically inferred as type "boolean" with default "false"</span> - }) - .actions(<span class="hljs-function">(<span class="hljs-params">tweet</span>) =></span> ({ - toggle() { - tweet.read = !tweet.read - } - })) +<span class="hljs-keyword">const</span> Tweet = t + .model(<span class="hljs-string">"Tweet"</span>, { + <span class="hljs-attr">body</span>: t.string, + <span class="hljs-attr">read</span>: <span class="hljs-literal">false</span> <span class="hljs-comment">// automatically inferred as type "boolean" with default "false"</span> + }) + .actions(<span class="hljs-function">(<span class="hljs-params">tweet</span>) =></span> ({ + toggle() { + tweet.read = !tweet.read + } + })) <span class="hljs-comment">// Define the Twitter "store" as having an array of tweets</span> -<span class="hljs-keyword">const</span> TwitterStore = types.model(<span class="hljs-string">"TwitterStore"</span>, { - <span class="hljs-attr">tweets</span>: types.array(Tweet) +<span class="hljs-keyword">const</span> TwitterStore = t.model(<span class="hljs-string">"TwitterStore"</span>, { + <span class="hljs-attr">tweets</span>: t.array(Tweet) }) <span class="hljs-comment">// create your new Twitter store instance with some initial data</span> <span class="hljs-keyword">const</span> twitterStore = TwitterStore.create({ - <span class="hljs-attr">tweets</span>: [ - { - <span class="hljs-attr">body</span>: <span class="hljs-string">"Anyone tried MST?"</span> - } - ] + <span class="hljs-attr">tweets</span>: [ + { + <span class="hljs-attr">body</span>: <span class="hljs-string">"Anyone tried MST?"</span> + } + ] }) <span class="hljs-comment">// Listen to new snapshots, which are created anytime something changes</span> onSnapshot(twitterStore, (snapshot) => { - <span class="hljs-built_in">console</span>.log(snapshot) + <span class="hljs-built_in">console</span>.log(snapshot) }) <span class="hljs-comment">// Let's mark the first tweet as "read" by invoking the "toggle" action</span> @@ -123,6 +117,14 @@ <h2><a class="anchor" aria-hidden="true" id="basic-example"></a><a href="#basic- <span class="hljs-comment">// In the console, you should see the result: `{ tweets: [{ body: "Anyone tried MST?", read: true }]}`</span> </code></pre> +<h2><a class="anchor" aria-hidden="true" id="video-demonstration"></a><a href="#video-demonstration" 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>Video Demonstration</h2> +<p>Jamon Holmgren has an excellent introduction video with a more realistic, robust example of MobX-State-Tree and React. Check it out!</p> +<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/n_VjjJxyd8Q?si=RxMDaUi7ExERZQsx" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> +<h2><a class="anchor" aria-hidden="true" id="mobx-ecosystem"></a><a href="#mobx-ecosystem" 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>MobX Ecosystem</h2> +<p><a href="https://github.com/mobxjs/mobx">MobX</a> is <a href="https://2019.stateofjs.com/data-layer/mobx/">one of the most popular Redux alternatives</a> and is used (along with MobX-State-Tree) by companies all over the world, including Netflix, Grow, IBM, DAZN, Baidu, and more.</p> +<p>If you're wondering how MobX-State-Tree is distinct from MobX, you can think of it like this: <strong>MobX is a state management "engine", and MobX-State-Tree is a luxury car</strong>. MST gives you the structure, tools, and other features to get you where you're going. MST is valuable in a large team but also useful in smaller applications when you expect your code to scale rapidly. And if we compare it to Redux, MST offers better performance with much less boilerplate code than Redux!</p> +<p>Since MST uses MobX under the hood, MobX-State-Tree works with the MobX bindings for React, React Native, Vue, Angular, Svelte, and even barebones JavaScript apps.</p> +<p><em>You don't need to know how to use MobX in order to use MST.</em> Just like you don't need to know how your car's engine works to be an excellent driver. It can help, but it's not necessary.</p> <h2><a class="anchor" aria-hidden="true" id="next-steps"></a><a href="#next-steps" 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>Next Steps</h2> <ul> <li>Learn how to <a href="/intro/installation">install MobX-State-Tree</a> or jump straight to our <a href="/intro/getting-started">Getting Started</a> guide!</li> @@ -130,7 +132,7 @@ <h2><a class="anchor" aria-hidden="true" id="next-steps"></a><a href="#next-step <li>If you're interested in the philosophy behind MobX-State-Tree and a lot more explanation of features and benefits, check out the <a href="/intro/philosophy">Philosophy</a> page.</li> <li>Or check out a talk or two on our <a href="/tips/resources">Resources</a> page</li> </ul> -</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/intro/installation"><span>Installation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#what-is-mobx-state-tree">What is MobX-State-Tree?</a><ul class="toc-headings"><li><a href="#ten-reasons-you-should-use-mobx-state-tree">Ten reasons you should use MobX-State-Tree:</a></li></ul></li><li><a href="#basic-example">Basic example</a></li><li><a href="#next-steps">Next Steps</a></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> +</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/intro/installation"><span>Installation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#what-is-mobx-state-tree">What is MobX-State-Tree?</a></li><li><a href="#basic-example">Basic Example</a></li><li><a href="#video-demonstration">Video Demonstration</a></li><li><a href="#mobx-ecosystem">MobX Ecosystem</a></li><li><a href="#next-steps">Next Steps</a></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; diff --git a/intro/welcome/index.html b/intro/welcome/index.html index 244d709b8..ba252b38f 100644 --- a/intro/welcome/index.html +++ b/intro/welcome/index.html @@ -65,57 +65,51 @@ </script></nav></div><div class="container mainContainer docsContainer"><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/intro/welcome.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Welcome to MobX-State-Tree!</h1></header><article><div><span><div id="codefund"></div> <p><strong><em>Full-featured reactive state management without the boilerplate.</em></strong></p> <h2><a class="anchor" aria-hidden="true" id="what-is-mobx-state-tree"></a><a href="#what-is-mobx-state-tree" 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>What is MobX-State-Tree?</h2> -<p>Technically speaking, MobX-State-Tree (also known as MST) is a state container system built on <a href="https://github.com/mobxjs/mobx">MobX</a>, a functional reactive state library.</p> -<p>This may not mean much to you, and that’s okay. I’ll explain it like this: <strong>MobX is a state management "engine", and MobX-State-Tree gives it structure and common tools you need for your app.</strong> MST is valuable in a large team but also useful in smaller applications when you expect your code to scale rapidly. And if we compare it to Redux, MST offers better performance and much less boilerplate code than Redux!</p> -<p>MobX is <a href="https://2019.stateofjs.com/data-layer/mobx/">one of the most popular Redux alternatives</a> and is used (along with MobX-State-Tree) by companies all over the world, including Netflix, Grow, IBM, DAZN, Baidu, and more.</p> -<p>It supports a full set of features for a modern state management system -- all in a package with <em>zero dependencies</em> other than MobX itself.</p> -<p><em>Note: you don't need to know how to use MobX in order to use MST.</em></p> -<h3><a class="anchor" aria-hidden="true" id="ten-reasons-you-should-use-mobx-state-tree"></a><a href="#ten-reasons-you-should-use-mobx-state-tree" 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>Ten reasons you should use MobX-State-Tree:</h3> +<p>MobX-State-Tree (MST) is a <a href="https://en.wikipedia.org/wiki/Batteries_Included#:~:text=%22Batteries%20included%22%20(slang)%252C%20in%20a%20product%20usability%20(mostly%20in%20software)%20it%20states%20that%20the%20product%20comes%20together%20with%20all%20possible%20parts%20required%20for%20full%20usability">batteries included</a> state management library. It only requires <strong>one peer dependency</strong>, and will provide you with:</p> <ol> -<li><strong>MST works great</strong> in React, React Native, Vue, Angular, Svelte, and even barebones JavaScript apps</li> -<li>Instead of being scattered throughout your app, MST provides <strong>centralized stores</strong> for your data</li> -<li>Your data is <strong>mutable</strong>, but can only be mutated in "actions", so it's <em>easy to use</em> but also <em>protected</em></li> -<li>Via <strong>runtime type checking</strong>, you can't accidentally assign the wrong data type to a property</li> -<li>TypeScript can infer <strong>static types</strong> from your runtime types automatically</li> -<li>Every update to your data is traced and you can quickly <strong>generate snapshots</strong> of your state at any time</li> -<li>MST has built-in support for references so you can <strong>normalize your data</strong> across your whole app</li> -<li><strong>Side effects</strong> can be managed via async flows, which are basically long-running actions</li> -<li>Using snapshots, you can do <strong>time-travel debugging</strong> or logging of state changes over time</li> -<li>MST has a <strong>robust community</strong> and a large, active core team</li> +<li><strong>Centralized stores</strong> for your data</li> +<li><strong>Mutable, but protected data</strong>, which means it is easy to work with your data, but safe to modify.</li> +<li><strong>Serializable and traceable updates</strong>. The mutable, protected nature of MobX-State-Tree data means you can <strong>generate snapshots</strong> and do <strong>time-travel debugging</strong>.</li> +<li><strong>Side effect management</strong>, so you don't need to write <code>useEffect</code> hooks or their equivalent to manage the consequences of data mutations. You can do it all from MST itself.</li> +<li><strong>Runtime type checking</strong>, so you can't accidentally assign the wrong data type to a property</li> +<li><strong>Static type checking</strong> with TypeScript inference from your runtime types - automatically!</li> +<li><strong>Data normalization</strong> - MST has support for references, so you can normalize data across your application code.</li> +<li><strong>Warm, welcoming community</strong>. We pride ourselves on a healthy and kind open source community.</li> </ol> -<h2><a class="anchor" aria-hidden="true" id="basic-example"></a><a href="#basic-example" 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>Basic example</h2> +<h2><a class="anchor" aria-hidden="true" id="basic-example"></a><a href="#basic-example" 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>Basic Example</h2> +<p>Here's what MST code looks like:</p> <p><em>You can play with it in <a href="https://codesandbox.io/s/boring-pond-cmooq?file=/src/index.js">this CodeSandbox playground</a>.</em></p> -<pre><code class="hljs css language-javascript"><span class="hljs-keyword">import</span> { types, onSnapshot } <span class="hljs-keyword">from</span> <span class="hljs-string">"mobx-state-tree"</span> +<pre><code class="hljs css language-javascript"><span class="hljs-keyword">import</span> { t, onSnapshot } <span class="hljs-keyword">from</span> <span class="hljs-string">"mobx-state-tree"</span> <span class="hljs-comment">// A tweet has a body (which is text) and whether it's read or not</span> -<span class="hljs-keyword">const</span> Tweet = types - .model(<span class="hljs-string">"Tweet"</span>, { - <span class="hljs-attr">body</span>: types.string, - <span class="hljs-attr">read</span>: <span class="hljs-literal">false</span> <span class="hljs-comment">// automatically inferred as type "boolean" with default "false"</span> - }) - .actions(<span class="hljs-function">(<span class="hljs-params">tweet</span>) =></span> ({ - toggle() { - tweet.read = !tweet.read - } - })) +<span class="hljs-keyword">const</span> Tweet = t + .model(<span class="hljs-string">"Tweet"</span>, { + <span class="hljs-attr">body</span>: t.string, + <span class="hljs-attr">read</span>: <span class="hljs-literal">false</span> <span class="hljs-comment">// automatically inferred as type "boolean" with default "false"</span> + }) + .actions(<span class="hljs-function">(<span class="hljs-params">tweet</span>) =></span> ({ + toggle() { + tweet.read = !tweet.read + } + })) <span class="hljs-comment">// Define the Twitter "store" as having an array of tweets</span> -<span class="hljs-keyword">const</span> TwitterStore = types.model(<span class="hljs-string">"TwitterStore"</span>, { - <span class="hljs-attr">tweets</span>: types.array(Tweet) +<span class="hljs-keyword">const</span> TwitterStore = t.model(<span class="hljs-string">"TwitterStore"</span>, { + <span class="hljs-attr">tweets</span>: t.array(Tweet) }) <span class="hljs-comment">// create your new Twitter store instance with some initial data</span> <span class="hljs-keyword">const</span> twitterStore = TwitterStore.create({ - <span class="hljs-attr">tweets</span>: [ - { - <span class="hljs-attr">body</span>: <span class="hljs-string">"Anyone tried MST?"</span> - } - ] + <span class="hljs-attr">tweets</span>: [ + { + <span class="hljs-attr">body</span>: <span class="hljs-string">"Anyone tried MST?"</span> + } + ] }) <span class="hljs-comment">// Listen to new snapshots, which are created anytime something changes</span> onSnapshot(twitterStore, (snapshot) => { - <span class="hljs-built_in">console</span>.log(snapshot) + <span class="hljs-built_in">console</span>.log(snapshot) }) <span class="hljs-comment">// Let's mark the first tweet as "read" by invoking the "toggle" action</span> @@ -123,6 +117,14 @@ <h2><a class="anchor" aria-hidden="true" id="basic-example"></a><a href="#basic- <span class="hljs-comment">// In the console, you should see the result: `{ tweets: [{ body: "Anyone tried MST?", read: true }]}`</span> </code></pre> +<h2><a class="anchor" aria-hidden="true" id="video-demonstration"></a><a href="#video-demonstration" 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>Video Demonstration</h2> +<p>Jamon Holmgren has an excellent introduction video with a more realistic, robust example of MobX-State-Tree and React. Check it out!</p> +<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/n_VjjJxyd8Q?si=RxMDaUi7ExERZQsx" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> +<h2><a class="anchor" aria-hidden="true" id="mobx-ecosystem"></a><a href="#mobx-ecosystem" 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>MobX Ecosystem</h2> +<p><a href="https://github.com/mobxjs/mobx">MobX</a> is <a href="https://2019.stateofjs.com/data-layer/mobx/">one of the most popular Redux alternatives</a> and is used (along with MobX-State-Tree) by companies all over the world, including Netflix, Grow, IBM, DAZN, Baidu, and more.</p> +<p>If you're wondering how MobX-State-Tree is distinct from MobX, you can think of it like this: <strong>MobX is a state management "engine", and MobX-State-Tree is a luxury car</strong>. MST gives you the structure, tools, and other features to get you where you're going. MST is valuable in a large team but also useful in smaller applications when you expect your code to scale rapidly. And if we compare it to Redux, MST offers better performance with much less boilerplate code than Redux!</p> +<p>Since MST uses MobX under the hood, MobX-State-Tree works with the MobX bindings for React, React Native, Vue, Angular, Svelte, and even barebones JavaScript apps.</p> +<p><em>You don't need to know how to use MobX in order to use MST.</em> Just like you don't need to know how your car's engine works to be an excellent driver. It can help, but it's not necessary.</p> <h2><a class="anchor" aria-hidden="true" id="next-steps"></a><a href="#next-steps" 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>Next Steps</h2> <ul> <li>Learn how to <a href="/intro/installation">install MobX-State-Tree</a> or jump straight to our <a href="/intro/getting-started">Getting Started</a> guide!</li> @@ -130,7 +132,7 @@ <h2><a class="anchor" aria-hidden="true" id="next-steps"></a><a href="#next-step <li>If you're interested in the philosophy behind MobX-State-Tree and a lot more explanation of features and benefits, check out the <a href="/intro/philosophy">Philosophy</a> page.</li> <li>Or check out a talk or two on our <a href="/tips/resources">Resources</a> page</li> </ul> -</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/intro/installation"><span>Installation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#what-is-mobx-state-tree">What is MobX-State-Tree?</a><ul class="toc-headings"><li><a href="#ten-reasons-you-should-use-mobx-state-tree">Ten reasons you should use MobX-State-Tree:</a></li></ul></li><li><a href="#basic-example">Basic example</a></li><li><a href="#next-steps">Next Steps</a></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> +</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/intro/installation"><span>Installation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#what-is-mobx-state-tree">What is MobX-State-Tree?</a></li><li><a href="#basic-example">Basic Example</a></li><li><a href="#video-demonstration">Video Demonstration</a></li><li><a href="#mobx-ecosystem">MobX Ecosystem</a></li><li><a href="#next-steps">Next Steps</a></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; diff --git a/tips/typescript.html b/tips/typescript.html index ccff7dc0e..21e888a87 100644 --- a/tips/typescript.html +++ b/tips/typescript.html @@ -63,7 +63,7 @@ } }); </script></nav></div><div class="container mainContainer docsContainer"><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/tips/typescript.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">TypeScript and MST</h1></header><article><div><span><div id="codefund"></div> -<p>TypeScript support is best-effort as not all patterns can be expressed in TypeScript. Except for assigning snapshots to properties we get pretty close! As MST uses the latest fancy TypeScript features it is required to use TypeScript 3.0 or later with <code>noImplicitThis</code> and <code>strictNullChecks</code> enabled.</p> +<p>TypeScript support is best-effort as not all patterns can be expressed in TypeScript. Except for assigning snapshots to properties we get pretty close! As MST uses the latest fancy TypeScript features it is required to use TypeScript 5.3.3 or later with <code>noImplicitThis</code> and <code>strictNullChecks</code> enabled.</p> <p>The more strict options that are enabled, the better the type system will behave.</p> <h4><a class="anchor" aria-hidden="true" id="recommend-compiler-flags"></a><a href="#recommend-compiler-flags" 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>Recommend compiler flags</h4> <p>The recommended compiler flags (against which all our tests are written) are:</p> diff --git a/tips/typescript/index.html b/tips/typescript/index.html index ccff7dc0e..21e888a87 100644 --- a/tips/typescript/index.html +++ b/tips/typescript/index.html @@ -63,7 +63,7 @@ } }); </script></nav></div><div class="container mainContainer docsContainer"><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/tips/typescript.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">TypeScript and MST</h1></header><article><div><span><div id="codefund"></div> -<p>TypeScript support is best-effort as not all patterns can be expressed in TypeScript. Except for assigning snapshots to properties we get pretty close! As MST uses the latest fancy TypeScript features it is required to use TypeScript 3.0 or later with <code>noImplicitThis</code> and <code>strictNullChecks</code> enabled.</p> +<p>TypeScript support is best-effort as not all patterns can be expressed in TypeScript. Except for assigning snapshots to properties we get pretty close! As MST uses the latest fancy TypeScript features it is required to use TypeScript 5.3.3 or later with <code>noImplicitThis</code> and <code>strictNullChecks</code> enabled.</p> <p>The more strict options that are enabled, the better the type system will behave.</p> <h4><a class="anchor" aria-hidden="true" id="recommend-compiler-flags"></a><a href="#recommend-compiler-flags" 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>Recommend compiler flags</h4> <p>The recommended compiler flags (against which all our tests are written) are:</p>