From 9c199a5db74561be07fabf315e7f843f6ff7bcb7 Mon Sep 17 00:00:00 2001 From: Tyler Scott Williams Date: Sun, 7 Jul 2024 13:16:34 -0600 Subject: [PATCH] Chore/6.0.1 version bump (#2191) * chore: bump to version 6.0.1 * chore: bun install * docs: run docs publish for 6.0.1 --- bun.lockb | Bin 307818 -> 307818 bytes docs/API/index.md | 493 ++++++++---------- docs/API/interfaces/customtypeoptions.md | 12 +- docs/API/interfaces/functionwithflag.md | 6 +- docs/API/interfaces/iactioncontext.md | 14 +- docs/API/interfaces/iactionrecorder.md | 12 +- .../iactiontrackingmiddleware2call.md | 6 +- .../iactiontrackingmiddleware2hooks.md | 8 +- .../iactiontrackingmiddlewarehooks.md | 14 +- docs/API/interfaces/ianycomplextype.md | 14 +- docs/API/interfaces/ianymodeltype.md | 32 +- docs/API/interfaces/ianytype.md | 14 +- docs/API/interfaces/ihooks.md | 10 +- docs/API/interfaces/ijsonpatch.md | 8 +- docs/API/interfaces/imiddlewareevent.md | 24 +- docs/API/interfaces/imodelreflectiondata.md | 14 +- .../imodelreflectionpropertiesdata.md | 6 +- docs/API/interfaces/imodeltype.md | 32 +- docs/API/interfaces/ipatchrecorder.md | 18 +- docs/API/interfaces/ireversiblejsonpatch.md | 10 +- docs/API/interfaces/iserializedactioncall.md | 8 +- docs/API/interfaces/isimpletype.md | 14 +- docs/API/interfaces/isnapshotprocessor.md | 14 +- docs/API/interfaces/isnapshotprocessors.md | 6 +- docs/API/interfaces/itype.md | 14 +- .../API/interfaces/ivalidationcontextentry.md | 6 +- docs/API/interfaces/ivalidationerror.md | 8 +- docs/API/interfaces/referenceoptionsgetset.md | 6 +- .../referenceoptionsoninvalidated.md | 4 +- docs/API/interfaces/unionoptions.md | 6 +- package.json | 2 +- website/i18n/en.json | 2 +- 32 files changed, 398 insertions(+), 439 deletions(-) diff --git a/bun.lockb b/bun.lockb index 92104bae0f71ea1c5cd7e5a88e8712ef6ed1ff4c..9662c599e97272a4251c22c5aac5c8b3ad3235de 100755 GIT binary patch delta 5583 zcmXBY_aE){9LMp;y}gbdZIPN$D>~DiixRUjO6+shh@IAo*`NqDQlp|&bBl`E*ioaY z-V!@%MXgXH))icYYozAkdcS`7ex8r_>reRZ*?r)i-3OlI9PDpDfA0aupMKPd^>I6` zJ(uq?PdWR_%Pzg@!jn$EU~hBuX~mhr#lenf#6Px6>MOAXT=&;o>mAA z7n^6=UeYx}RbKJ=phGOkn^gP|RQi_W_DIOyE6Gv49!;2Pu}Y zK=5G23O2BQh+++^hiZk;fblTJ2wE`LiZOIx?NCgh2m9fQDGcD8qL{%5?jsa)n816a zVgWPwk5VjQf#A`K6>MM~D%P-ij8+H@7>`wqpat`BiZOIxJzg<^9_%M5rZ9l>M8yn7 zaG#`@!vtQWSilVasfr~m5S*r1!3Ne(R;*$56s-^%FrKOyK?~;76l3VXdb(l)J=n2g z3IjOLP|RQi_nC@0OyE6Bv49!;XDgPlK=2&J3O2BQu3`30`F~#1oNDurE|hVF0I6%wPofy^1+Z z;Jr_=fEoPvE0(Z8@BzgNHn9GnVhyVgX@$^$@nOXXS}<$H7&@>%qL@Gr_C<;*4B&iJ zF@q7@k16Ibf%kF60%q_(p;*EK!NrOdY+&6e*08!nD})A&Pbx;xf_bT83>{dz6cgyd zzDzNN0h~`MW-x;LX~i5S@LI(JX7E3wSi%CqXB8{h!1{BFHLO0b6+#2X7Zf9C!Th3P z3>{csQcR!+yHiYI0O!k!8I0gwu9(9F-d7Y0n8E+5VhIZbUsJ4L1M9CV*0B19RtOCk zy4p#$p*#RPh=zonSM0M54+GZ?}Bj$#fIc;8hlU5E?N4s2D*D=ART}=)l^mm_QHqpA}OW!1;?}1|ztC zRm@=m?{A6)%-}DIB`gqJrC7lR)_+&5Vf7EK5E?N4sTe^E=D!qU=)n57Vgfzb|4~d~ z0B56^!3geu6?2%xdEVB2ey7T|OtpZlV=J1IA4iBWS_AnPLnbST|Qppak!2Rdaw^wOkn`$FvSc;a1U3^VFK?6 z#R6vVk5nvSfxuC$U<2!;6l+)=trbE8#xaT!v|t{q7()lvaf%7_U>~oT!T`<*iW!XH mx{5hW;BDW!EbIq2N|kKK0GMccRTd;48-(e`b-&iEe-q7b|Q delta 5583 zcmXBY_aClg9mes_QK?QwW{FL*MNZtDCT(m+EXw-?HOc%mYLMEm#LCrqF?X zkYWZsI0q}{Fo1iAVgVy~u3`xj_=hU4U<1KniWSTd9ESiub8-4)lcKy(kq8Vp}6 zh6c=gDkji^buYyfIv6vLj&fM6ccE{I$kk_4(ul@X3&Fkf?^H>xKB|m zURE zf&C)I40>>0teC?9?kS1|jNqNBSi%JUX^Jb@K=2a93T6m%#WgGty;QLV<7HYgG+>^t zm_Q5G%N0}Tz$Y4Fhlri#WgGty+*MH z^km_Q5G>l9Pyz%CUt=)rltVh#hiXDb#kf_IK$2^08lP+Y+Vf^!usm?3Ygi!qf?^HE7qwz&!2FV80xeiy zR!pG-`zwkW^x$-gISk-_Rk45(yh{{In85#<;tDnpT&h^X4B^)m*RVkJ4aFLaZ)(NR zfY~c1(1LZDVhSDD-%`w=2j_Cd90qW|tysVa-ggvBn85$8;tDnpd{4208Nxwv4GToy zSFFMKfmRF+m_JlZpattkiYatp|5!1D9-N;j<}iT!Q^f*C@J7WFCh&izxPlD?KUb_^ zhVU1PYgi!qrD6@n6Ah+_g}>lCb84sdhH*{&Xw-w|94lgMN}|DxK(it3q-pq)?nS-jbYNdsF@qkQ>nY|ifO~z#0!Hw*DV8vSe*?u8Y#`WEv4R=G8!E10fyh*>!MKrD z3=NojDJIZ@bz{X8I;NDcRfDycX6ib-Ew-i^ffnZ<73T6mzrnrU$ zqMIw$VBA70h6c=ADkji^bt}abI?0L3=)pNkF^2)%qZJDn o!SfVLn84q@b;r4vAHMIodmXX+ndficdhOfo!t=N9e$gra1A2fAqW}N^ diff --git a/docs/API/index.md b/docs/API/index.md index bbd0c9f2c..f7ee7b25d 100644 --- a/docs/API/index.md +++ b/docs/API/index.md @@ -1,10 +1,10 @@ --- id: "index" -title: "mobx-state-tree - v6.0.0" +title: "mobx-state-tree - v6.0.1" sidebar_label: "Globals" --- -[mobx-state-tree - v6.0.0](index.md) +[mobx-state-tree - v6.0.1](index.md) ## Index @@ -46,6 +46,7 @@ sidebar_label: "Globals" * [IMiddlewareEventType](index.md#imiddlewareeventtype) * [IMiddlewareHandler](index.md#imiddlewarehandler) * [ITypeDispatcher](index.md#itypedispatcher) +* [IUnionType](index.md#iuniontype) * [IValidationContext](index.md#ivalidationcontext) * [IValidationResult](index.md#ivalidationresult) * [Instance](index.md#instance) @@ -178,7 +179,7 @@ sidebar_label: "Globals" Ƭ **IDisposer**: *function* -*Defined in [src/utils.ts:41](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/utils.ts#L41)* +*Defined in [src/utils.ts:41](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/utils.ts#L41)* A generic disposer. @@ -192,7 +193,7 @@ ___ Ƭ **IHooksGetter**: *function* -*Defined in [src/core/node/Hook.ts:19](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/node/Hook.ts#L19)* +*Defined in [src/core/node/Hook.ts:19](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/node/Hook.ts#L19)* #### Type declaration: @@ -210,7 +211,7 @@ ___ Ƭ **IMiddlewareEventType**: *"action" | "flow_spawn" | "flow_resume" | "flow_resume_error" | "flow_return" | "flow_throw"* -*Defined in [src/core/action.ts:16](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/action.ts#L16)* +*Defined in [src/core/action.ts:16](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/action.ts#L16)* ___ @@ -218,7 +219,7 @@ ___ Ƭ **IMiddlewareHandler**: *function* -*Defined in [src/core/action.ts:54](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/action.ts#L54)* +*Defined in [src/core/action.ts:54](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/action.ts#L54)* #### Type declaration: @@ -255,7 +256,7 @@ ___ Ƭ **ITypeDispatcher**: *function* -*Defined in [src/types/utility-types/union.ts:22](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/union.ts#L22)* +*Defined in [src/types/utility-types/union.ts:22](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/union.ts#L22)* #### Type declaration: @@ -269,11 +270,19 @@ Name | Type | ___ +### IUnionType + +Ƭ **IUnionType**: *ITypeUnion‹Types[number]["CreationType"], Types[number]["SnapshotType"], Types[number]["TypeWithoutSTN"]›* + +*Defined in [src/types/utility-types/union.ts:154](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/union.ts#L154)* + +___ + ### IValidationContext Ƭ **IValidationContext**: *[IValidationContextEntry](interfaces/ivalidationcontextentry.md)[]* -*Defined in [src/core/type/type-checker.ts:23](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type-checker.ts#L23)* +*Defined in [src/core/type/type-checker.ts:23](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type-checker.ts#L23)* Array of validation context entries @@ -283,7 +292,7 @@ ___ Ƭ **IValidationResult**: *[IValidationError](interfaces/ivalidationerror.md)[]* -*Defined in [src/core/type/type-checker.ts:36](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type-checker.ts#L36)* +*Defined in [src/core/type/type-checker.ts:36](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type-checker.ts#L36)* Type validation result, which is an array of type validation errors @@ -293,7 +302,7 @@ ___ Ƭ **Instance**: *T extends object ? T["Type"] : T* -*Defined in [src/core/type/type.ts:230](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L230)* +*Defined in [src/core/type/type.ts:230](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L230)* The instance representation of a given type. @@ -303,7 +312,7 @@ ___ Ƭ **LivelinessMode**: *"warn" | "error" | "ignore"* -*Defined in [src/core/node/livelinessChecking.ts:7](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/node/livelinessChecking.ts#L7)* +*Defined in [src/core/node/livelinessChecking.ts:7](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/node/livelinessChecking.ts#L7)* Defines what MST should do when running into reads / writes to objects that have died. - `"warn"`: Print a warning (default). @@ -316,7 +325,7 @@ ___ Ƭ **OnReferenceInvalidated**: *function* -*Defined in [src/types/utility-types/reference.ts:43](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/reference.ts#L43)* +*Defined in [src/types/utility-types/reference.ts:45](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/reference.ts#L45)* #### Type declaration: @@ -334,7 +343,7 @@ ___ Ƭ **OnReferenceInvalidatedEvent**: *object* -*Defined in [src/types/utility-types/reference.ts:34](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/reference.ts#L34)* +*Defined in [src/types/utility-types/reference.ts:36](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/reference.ts#L36)* #### Type declaration: @@ -344,7 +353,7 @@ ___ Ƭ **ReferenceIdentifier**: *string | number* -*Defined in [src/types/utility-types/identifier.ts:144](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/identifier.ts#L144)* +*Defined in [src/types/utility-types/identifier.ts:144](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/identifier.ts#L144)* Valid types for identifiers. @@ -354,7 +363,7 @@ ___ Ƭ **ReferenceOptions**: *[ReferenceOptionsGetSet](interfaces/referenceoptionsgetset.md)‹IT› | [ReferenceOptionsOnInvalidated](interfaces/referenceoptionsoninvalidated.md)‹IT› | [ReferenceOptionsGetSet](interfaces/referenceoptionsgetset.md)‹IT› & [ReferenceOptionsOnInvalidated](interfaces/referenceoptionsoninvalidated.md)‹IT›* -*Defined in [src/types/utility-types/reference.ts:451](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/reference.ts#L451)* +*Defined in [src/types/utility-types/reference.ts:453](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/reference.ts#L453)* ___ @@ -362,7 +371,7 @@ ___ Ƭ **SnapshotIn**: *T extends object ? T["CreationType"] : T extends IStateTreeNode ? IT["CreationType"] : T* -*Defined in [src/core/type/type.ts:235](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L235)* +*Defined in [src/core/type/type.ts:235](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L235)* The input (creation) snapshot representation of a given type. @@ -372,7 +381,7 @@ ___ Ƭ **SnapshotOrInstance**: *[SnapshotIn](index.md#snapshotin)‹T› | [Instance](index.md#instance)‹T›* -*Defined in [src/core/type/type.ts:276](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L276)* +*Defined in [src/core/type/type.ts:276](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L276)* 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. @@ -405,7 +414,7 @@ ___ Ƭ **SnapshotOut**: *T extends object ? T["SnapshotType"] : T extends IStateTreeNode ? IT["SnapshotType"] : T* -*Defined in [src/core/type/type.ts:244](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L244)* +*Defined in [src/core/type/type.ts:244](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L244)* The output snapshot representation of a given type. @@ -415,7 +424,7 @@ The output snapshot representation of a given type. • **DatePrimitive**: *[IType](interfaces/itype.md)‹number | Date, number, Date›* = _DatePrimitive -*Defined in [src/types/primitives.ts:215](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/primitives.ts#L215)* +*Defined in [src/types/primitives.ts:215](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/primitives.ts#L215)* `types.Date` - Creates a type that can only contain a javascript Date value. @@ -438,7 +447,7 @@ ___ (v) => typeof v === "boolean" ) -*Defined in [src/types/primitives.ts:169](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/primitives.ts#L169)* +*Defined in [src/types/primitives.ts:169](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/primitives.ts#L169)* `types.boolean` - Creates a type that can only contain a boolean value. This type is used for boolean values by default @@ -461,7 +470,7 @@ ___ (v) => isFinite(v) ) -*Defined in [src/types/primitives.ts:150](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/primitives.ts#L150)* +*Defined in [src/types/primitives.ts:150](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/primitives.ts#L150)* `types.finite` - Creates a type that can only contain an finite value. @@ -483,7 +492,7 @@ ___ (v) => isFloat(v) ) -*Defined in [src/types/primitives.ts:132](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/primitives.ts#L132)* +*Defined in [src/types/primitives.ts:132](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/primitives.ts#L132)* `types.float` - Creates a type that can only contain an float value. @@ -501,7 +510,7 @@ ___ • **identifier**: *[ISimpleType](interfaces/isimpletype.md)‹string›* = new IdentifierType() -*Defined in [src/types/utility-types/identifier.ts:112](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/identifier.ts#L112)* +*Defined in [src/types/utility-types/identifier.ts:112](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/identifier.ts#L112)* `types.identifier` - 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. @@ -525,7 +534,7 @@ ___ • **identifierNumber**: *[ISimpleType](interfaces/isimpletype.md)‹number›* = new IdentifierNumberType() -*Defined in [src/types/utility-types/identifier.ts:127](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/identifier.ts#L127)* +*Defined in [src/types/utility-types/identifier.ts:127](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/identifier.ts#L127)* `types.identifierNumber` - Similar to `types.identifier`. This one will serialize from / to a number when applying snapshots @@ -549,7 +558,7 @@ ___ (v) => isInteger(v) ) -*Defined in [src/types/primitives.ts:114](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/primitives.ts#L114)* +*Defined in [src/types/primitives.ts:114](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/primitives.ts#L114)* `types.integer` - Creates a type that can only contain an integer value. @@ -571,7 +580,7 @@ ___ (v) => v === null ) -*Defined in [src/types/primitives.ts:178](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/primitives.ts#L178)* +*Defined in [src/types/primitives.ts:178](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/primitives.ts#L178)* `types.null` - The type of the value `null` @@ -585,7 +594,7 @@ ___ (v) => typeof v === "number" ) -*Defined in [src/types/primitives.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/primitives.ts#L96)* +*Defined in [src/types/primitives.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/primitives.ts#L96)* `types.number` - Creates a type that can only contain a numeric value. This type is used for numeric values by default @@ -608,7 +617,7 @@ ___ (v) => typeof v === "string" ) -*Defined in [src/types/primitives.ts:77](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/primitives.ts#L77)* +*Defined in [src/types/primitives.ts:77](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/primitives.ts#L77)* `types.string` - Creates a type that can only contain a string value. This type is used for string values by default @@ -631,7 +640,7 @@ ___ (v) => v === undefined ) -*Defined in [src/types/primitives.ts:187](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/primitives.ts#L187)* +*Defined in [src/types/primitives.ts:187](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/primitives.ts#L187)* `types.undefined` - The type of the value `undefined` @@ -641,7 +650,7 @@ ___ ▸ **addDisposer**(`target`: IAnyStateTreeNode, `disposer`: [IDisposer](index.md#idisposer)): *[IDisposer](index.md#idisposer)* -*Defined in [src/core/mst-operations.ts:751](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L751)* +*Defined in [src/core/mst-operations.ts:751](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L751)* 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 @@ -683,7 +692,7 @@ ___ ▸ **addMiddleware**(`target`: IAnyStateTreeNode, `handler`: [IMiddlewareHandler](index.md#imiddlewarehandler), `includeHooks`: boolean): *[IDisposer](index.md#idisposer)* -*Defined in [src/core/action.ts:161](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/action.ts#L161)* +*Defined in [src/core/action.ts:161](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/action.ts#L161)* 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. @@ -708,7 +717,7 @@ ___ ▸ **applyAction**(`target`: IAnyStateTreeNode, `actions`: [ISerializedActionCall](interfaces/iserializedactioncall.md) | [ISerializedActionCall](interfaces/iserializedactioncall.md)[]): *void* -*Defined in [src/middlewares/on-action.ts:88](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/on-action.ts#L88)* +*Defined in [src/middlewares/on-action.ts:88](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/on-action.ts#L88)* Applies an action or a series of actions in a single MobX transaction. Does not return any value @@ -729,7 +738,7 @@ ___ ▸ **applyPatch**(`target`: IAnyStateTreeNode, `patch`: [IJsonPatch](interfaces/ijsonpatch.md) | ReadonlyArray‹[IJsonPatch](interfaces/ijsonpatch.md)›): *void* -*Defined in [src/core/mst-operations.ts:124](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L124)* +*Defined in [src/core/mst-operations.ts:124](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L124)* Applies a JSON-patch to the given model instance or bails out if the patch couldn't be applied See [patches](https://github.com/mobxjs/mobx-state-tree#patches) for more details. @@ -751,7 +760,7 @@ ___ ▸ **applySnapshot**<**C**>(`target`: IStateTreeNode‹[IType](interfaces/itype.md)‹C, any, any››, `snapshot`: C): *void* -*Defined in [src/core/mst-operations.ts:321](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L321)* +*Defined in [src/core/mst-operations.ts:321](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L321)* Applies a snapshot to a given model instances. Patch and snapshot listeners will be invoked as usual. @@ -774,7 +783,7 @@ ___ ▸ **array**<**IT**>(`subtype`: IT): *IArrayType‹IT›* -*Defined in [src/types/complex-types/array.ts:344](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/array.ts#L344)* +*Defined in [src/types/complex-types/array.ts:344](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/array.ts#L344)* `types.array` - Creates an index based collection type who's children are all of a uniform declared type. @@ -814,7 +823,7 @@ ___ ▸ **cast**<**O**>(`snapshotOrInstance`: O): *O* -*Defined in [src/core/mst-operations.ts:908](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L908)* +*Defined in [src/core/mst-operations.ts:908](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L908)* 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, @@ -857,7 +866,7 @@ The same object cast as an instance ▸ **cast**<**O**>(`snapshotOrInstance`: TypeOfValue["CreationType"] | TypeOfValue["SnapshotType"] | TypeOfValue["Type"]): *O* -*Defined in [src/core/mst-operations.ts:911](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L911)* +*Defined in [src/core/mst-operations.ts:911](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L911)* 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, @@ -904,7 +913,7 @@ ___ ▸ **castFlowReturn**<**T**>(`val`: T): *T* -*Defined in [src/core/flow.ts:34](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/flow.ts#L34)* +*Defined in [src/core/flow.ts:34](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/flow.ts#L34)* **`deprecated`** Not needed since TS3.6. Used for TypeScript to make flows that return a promise return the actual promise result. @@ -927,7 +936,7 @@ ___ ▸ **castToReferenceSnapshot**<**I**>(`instance`: I): *Extract extends never ? I : ReferenceIdentifier* -*Defined in [src/core/mst-operations.ts:1011](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L1011)* +*Defined in [src/core/mst-operations.ts:1011](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L1011)* 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, @@ -973,7 +982,7 @@ ___ ▸ **castToSnapshot**<**I**>(`snapshotOrInstance`: I): *Extract extends never ? I : TypeOfValue["CreationType"]* -*Defined in [src/core/mst-operations.ts:977](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L977)* +*Defined in [src/core/mst-operations.ts:977](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L977)* 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, @@ -1018,7 +1027,7 @@ ___ ▸ **clone**<**T**>(`source`: T, `keepEnvironment`: boolean | any): *T* -*Defined in [src/core/mst-operations.ts:666](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L666)* +*Defined in [src/core/mst-operations.ts:666](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L666)* Returns a deep copy of the given state tree node as new tree. Shorthand for `snapshot(x) = getType(x).create(getSnapshot(x))` @@ -1044,7 +1053,7 @@ ___ ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**>(`name`: string, `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›): *[IModelType](interfaces/imodeltype.md)‹PA & PB, OA & OB, _CustomJoin‹FCA, FCB›, _CustomJoin‹FSA, FSB››* -*Defined in [src/types/complex-types/model.ts:769](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L769)* +*Defined in [src/types/complex-types/model.ts:777](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L777)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1082,7 +1091,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›): *[IModelType](interfaces/imodeltype.md)‹PA & PB, OA & OB, _CustomJoin‹FCA, FCB›, _CustomJoin‹FSA, FSB››* -*Defined in [src/types/complex-types/model.ts:771](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L771)* +*Defined in [src/types/complex-types/model.ts:779](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L779)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1119,7 +1128,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**>(`name`: string, `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC, OA & OB & OC, _CustomJoin‹FCA, _CustomJoin‹FCB, FCC››, _CustomJoin‹FSA, _CustomJoin‹FSB, FSC›››* -*Defined in [src/types/complex-types/model.ts:773](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L773)* +*Defined in [src/types/complex-types/model.ts:781](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L781)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1166,7 +1175,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC, OA & OB & OC, _CustomJoin‹FCA, _CustomJoin‹FCB, FCC››, _CustomJoin‹FSA, _CustomJoin‹FSB, FSC›››* -*Defined in [src/types/complex-types/model.ts:775](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L775)* +*Defined in [src/types/complex-types/model.ts:783](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L783)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1212,7 +1221,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**>(`name`: string, `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC & PD, OA & OB & OC & OD, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, FCD›››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, FSD››››* -*Defined in [src/types/complex-types/model.ts:777](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L777)* +*Defined in [src/types/complex-types/model.ts:785](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L785)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1268,7 +1277,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC & PD, OA & OB & OC & OD, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, FCD›››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, FSD››››* -*Defined in [src/types/complex-types/model.ts:779](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L779)* +*Defined in [src/types/complex-types/model.ts:787](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L787)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1323,7 +1332,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**>(`name`: string, `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›): *[IModelType](interfaces/imodeltype.md)‹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›››››* -*Defined in [src/types/complex-types/model.ts:781](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L781)* +*Defined in [src/types/complex-types/model.ts:789](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L789)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1388,7 +1397,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›): *[IModelType](interfaces/imodeltype.md)‹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›››››* -*Defined in [src/types/complex-types/model.ts:783](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L783)* +*Defined in [src/types/complex-types/model.ts:791](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L791)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1452,7 +1461,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**>(`name`: string, `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›): *[IModelType](interfaces/imodeltype.md)‹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››››››* -*Defined in [src/types/complex-types/model.ts:787](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L787)* +*Defined in [src/types/complex-types/model.ts:795](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L795)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1526,7 +1535,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›): *[IModelType](interfaces/imodeltype.md)‹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››››››* -*Defined in [src/types/complex-types/model.ts:790](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L790)* +*Defined in [src/types/complex-types/model.ts:798](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L798)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1599,7 +1608,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**>(`name`: string, `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›): *[IModelType](interfaces/imodeltype.md)‹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›››››››* -*Defined in [src/types/complex-types/model.ts:793](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L793)* +*Defined in [src/types/complex-types/model.ts:801](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L801)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1682,7 +1691,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›): *[IModelType](interfaces/imodeltype.md)‹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›››››››* -*Defined in [src/types/complex-types/model.ts:796](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L796)* +*Defined in [src/types/complex-types/model.ts:804](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L804)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1764,7 +1773,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**, **PH**, **OH**, **FCH**, **FSH**>(`name`: string, `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›, `H`: [IModelType](interfaces/imodeltype.md)‹PH, OH, FCH, FSH›): *[IModelType](interfaces/imodeltype.md)‹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››››››››* -*Defined in [src/types/complex-types/model.ts:799](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L799)* +*Defined in [src/types/complex-types/model.ts:807](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L807)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1856,7 +1865,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**, **PH**, **OH**, **FCH**, **FSH**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›, `H`: [IModelType](interfaces/imodeltype.md)‹PH, OH, FCH, FSH›): *[IModelType](interfaces/imodeltype.md)‹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››››››››* -*Defined in [src/types/complex-types/model.ts:802](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L802)* +*Defined in [src/types/complex-types/model.ts:810](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L810)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1947,7 +1956,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**, **PH**, **OH**, **FCH**, **FSH**, **PI**, **OI**, **FCI**, **FSI**>(`name`: string, `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›, `H`: [IModelType](interfaces/imodeltype.md)‹PH, OH, FCH, FSH›, `I`: [IModelType](interfaces/imodeltype.md)‹PI, OI, FCI, FSI›): *[IModelType](interfaces/imodeltype.md)‹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›››››››››* -*Defined in [src/types/complex-types/model.ts:805](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L805)* +*Defined in [src/types/complex-types/model.ts:813](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L813)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -2048,7 +2057,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**, **PH**, **OH**, **FCH**, **FSH**, **PI**, **OI**, **FCI**, **FSI**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›, `H`: [IModelType](interfaces/imodeltype.md)‹PH, OH, FCH, FSH›, `I`: [IModelType](interfaces/imodeltype.md)‹PI, OI, FCI, FSI›): *[IModelType](interfaces/imodeltype.md)‹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›››››››››* -*Defined in [src/types/complex-types/model.ts:808](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L808)* +*Defined in [src/types/complex-types/model.ts:816](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L816)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -2152,7 +2161,7 @@ ___ ▸ **createActionTrackingMiddleware**<**T**>(`hooks`: [IActionTrackingMiddlewareHooks](interfaces/iactiontrackingmiddlewarehooks.md)‹T›): *[IMiddlewareHandler](index.md#imiddlewarehandler)* -*Defined in [src/middlewares/create-action-tracking-middleware.ts:28](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/create-action-tracking-middleware.ts#L28)* +*Defined in [src/middlewares/create-action-tracking-middleware.ts:28](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/create-action-tracking-middleware.ts#L28)* Note: Consider migrating to `createActionTrackingMiddleware2`, it is easier to use. @@ -2182,7 +2191,7 @@ ___ ▸ **createActionTrackingMiddleware2**<**TEnv**>(`middlewareHooks`: [IActionTrackingMiddleware2Hooks](interfaces/iactiontrackingmiddleware2hooks.md)‹TEnv›): *[IMiddlewareHandler](index.md#imiddlewarehandler)* -*Defined in [src/middlewares/createActionTrackingMiddleware2.ts:72](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/createActionTrackingMiddleware2.ts#L72)* +*Defined in [src/middlewares/createActionTrackingMiddleware2.ts:72](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/createActionTrackingMiddleware2.ts#L72)* Convenience utility to create action based middleware that supports async processes more easily. The flow is like this: @@ -2221,7 +2230,7 @@ ___ ▸ **custom**<**S**, **T**>(`options`: [CustomTypeOptions](interfaces/customtypeoptions.md)‹S, T›): *[IType](interfaces/itype.md)‹S | T, S, T›* -*Defined in [src/types/utility-types/custom.ts:74](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/custom.ts#L74)* +*Defined in [src/types/utility-types/custom.ts:74](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/custom.ts#L74)* `types.custom` - 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. @@ -2285,7 +2294,7 @@ ___ ▸ **decorate**<**T**>(`handler`: [IMiddlewareHandler](index.md#imiddlewarehandler), `fn`: T, `includeHooks`: boolean): *T* -*Defined in [src/core/action.ts:200](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/action.ts#L200)* +*Defined in [src/core/action.ts:200](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/action.ts#L200)* Binds middleware to a specific action. @@ -2326,7 +2335,7 @@ ___ ▸ **destroy**(`target`: IAnyStateTreeNode): *void* -*Defined in [src/core/mst-operations.ts:698](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L698)* +*Defined in [src/core/mst-operations.ts:698](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L698)* Removes a model element from the state tree, and mark it as end-of-life; the element should not be used anymore @@ -2344,7 +2353,7 @@ ___ ▸ **detach**<**T**>(`target`: T): *T* -*Defined in [src/core/mst-operations.ts:687](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L687)* +*Defined in [src/core/mst-operations.ts:687](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L687)* Removes a model element from the state tree, and let it live on as a new state tree @@ -2366,7 +2375,7 @@ ___ ▸ **enumeration**<**T**>(`options`: keyof T[]): *[ISimpleType](interfaces/isimpletype.md)‹UnionStringArray‹T[]››* -*Defined in [src/types/utility-types/enumeration.ts:11](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/enumeration.ts#L11)* +*Defined in [src/types/utility-types/enumeration.ts:11](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/enumeration.ts#L11)* `types.enumeration` - Can be used to create an string based enumeration. (note: this methods is just sugar for a union of string literals) @@ -2392,7 +2401,7 @@ Name | Type | Description | ▸ **enumeration**<**T**>(`name`: string, `options`: keyof T[]): *[ISimpleType](interfaces/isimpletype.md)‹UnionStringArray‹T[]››* -*Defined in [src/types/utility-types/enumeration.ts:14](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/enumeration.ts#L14)* +*Defined in [src/types/utility-types/enumeration.ts:14](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/enumeration.ts#L14)* `types.enumeration` - Can be used to create an string based enumeration. (note: this methods is just sugar for a union of string literals) @@ -2423,7 +2432,7 @@ ___ ▸ **escapeJsonPath**(`path`: string): *string* -*Defined in [src/core/json-patch.ts:78](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/json-patch.ts#L78)* +*Defined in [src/core/json-patch.ts:78](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/json-patch.ts#L78)* Escape slashes and backslashes. @@ -2443,7 +2452,7 @@ ___ ▸ **flow**<**R**, **Args**>(`generator`: function): *function* -*Defined in [src/core/flow.ts:21](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/flow.ts#L21)* +*Defined in [src/core/flow.ts:21](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/flow.ts#L21)* See [asynchronous actions](concepts/async-actions.md). @@ -2483,7 +2492,7 @@ ___ ▸ **frozen**<**C**>(`subType`: [IType](interfaces/itype.md)‹C, any, any›): *[IType](interfaces/itype.md)‹C, C, C›* -*Defined in [src/types/utility-types/frozen.ts:54](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/frozen.ts#L54)* +*Defined in [src/types/utility-types/frozen.ts:55](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/frozen.ts#L55)* `types.frozen` - 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. @@ -2535,7 +2544,7 @@ Name | Type | ▸ **frozen**<**T**>(`defaultValue`: T): *[IType](interfaces/itype.md)‹T | undefined | null, T, T›* -*Defined in [src/types/utility-types/frozen.ts:55](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/frozen.ts#L55)* +*Defined in [src/types/utility-types/frozen.ts:56](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/frozen.ts#L56)* `types.frozen` - 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. @@ -2587,7 +2596,7 @@ Name | Type | ▸ **frozen**<**T**>(): *[IType](interfaces/itype.md)‹T, T, T›* -*Defined in [src/types/utility-types/frozen.ts:56](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/frozen.ts#L56)* +*Defined in [src/types/utility-types/frozen.ts:57](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/frozen.ts#L57)* `types.frozen` - 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. @@ -2637,7 +2646,7 @@ ___ ▸ **getChildType**(`object`: IAnyStateTreeNode, `propertyName?`: undefined | string): *[IAnyType](interfaces/ianytype.md)* -*Defined in [src/core/mst-operations.ts:68](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L68)* +*Defined in [src/core/mst-operations.ts:68](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L68)* Returns the _declared_ 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. @@ -2665,7 +2674,7 @@ ___ ▸ **getEnv**<**T**>(`target`: IAnyStateTreeNode): *T* -*Defined in [src/core/mst-operations.ts:773](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L773)* +*Defined in [src/core/mst-operations.ts:773](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L773)* Returns the environment of the current state tree, or throws. For more info on environments, see [Dependency injection](https://github.com/mobxjs/mobx-state-tree#dependency-injection) @@ -2693,7 +2702,7 @@ ___ ▸ **getIdentifier**(`target`: IAnyStateTreeNode): *string | null* -*Defined in [src/core/mst-operations.ts:549](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L549)* +*Defined in [src/core/mst-operations.ts:549](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L549)* Returns the identifier of the target node. This is the *string normalized* identifier, which might not match the type of the identifier attribute @@ -2712,7 +2721,7 @@ ___ ▸ **getLivelinessChecking**(): *[LivelinessMode](index.md#livelinessmode)* -*Defined in [src/core/node/livelinessChecking.ts:27](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/node/livelinessChecking.ts#L27)* +*Defined in [src/core/node/livelinessChecking.ts:27](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/node/livelinessChecking.ts#L27)* Returns the current liveliness checking mode. @@ -2726,7 +2735,7 @@ ___ ▸ **getMembers**(`target`: IAnyStateTreeNode): *[IModelReflectionData](interfaces/imodelreflectiondata.md)* -*Defined in [src/core/mst-operations.ts:874](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L874)* +*Defined in [src/core/mst-operations.ts:874](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L874)* Returns a reflection of the model node, including name, properties, views, volatile state, and actions. `flowActions` is also provided as a separate array of names for any action that @@ -2751,7 +2760,7 @@ ___ ▸ **getNodeId**(`target`: IAnyStateTreeNode): *number* -*Defined in [src/core/mst-operations.ts:1026](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L1026)* +*Defined in [src/core/mst-operations.ts:1026](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L1026)* Returns the unique node id (not to be confused with the instance identifier) for a given instance. @@ -2773,7 +2782,7 @@ ___ ▸ **getParent**<**IT**>(`target`: IAnyStateTreeNode, `depth`: number): *TypeOrStateTreeNodeToStateTreeNode‹IT›* -*Defined in [src/core/mst-operations.ts:382](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L382)* +*Defined in [src/core/mst-operations.ts:382](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L382)* Returns the immediate parent of this object, or throws. @@ -2802,7 +2811,7 @@ ___ ▸ **getParentOfType**<**IT**>(`target`: IAnyStateTreeNode, `type`: IT): *IT["Type"]* -*Defined in [src/core/mst-operations.ts:426](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L426)* +*Defined in [src/core/mst-operations.ts:426](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L426)* Returns the target's parent of a given type, or throws. @@ -2825,7 +2834,7 @@ ___ ▸ **getPath**(`target`: IAnyStateTreeNode): *string* -*Defined in [src/core/mst-operations.ts:466](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L466)* +*Defined in [src/core/mst-operations.ts:466](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L466)* Returns the path of the given object in the model tree @@ -2843,7 +2852,7 @@ ___ ▸ **getPathParts**(`target`: IAnyStateTreeNode): *string[]* -*Defined in [src/core/mst-operations.ts:479](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L479)* +*Defined in [src/core/mst-operations.ts:479](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L479)* Returns the path of the given object as unescaped string array. @@ -2861,7 +2870,7 @@ ___ ▸ **getPropertyMembers**(`typeOrNode`: [IAnyModelType](interfaces/ianymodeltype.md) | IAnyStateTreeNode): *[IModelReflectionPropertiesData](interfaces/imodelreflectionpropertiesdata.md)* -*Defined in [src/core/mst-operations.ts:835](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L835)* +*Defined in [src/core/mst-operations.ts:835](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L835)* Returns a reflection of the model type properties and name for either a model type or model node. @@ -2879,7 +2888,7 @@ ___ ▸ **getRelativePath**(`base`: IAnyStateTreeNode, `target`: IAnyStateTreeNode): *string* -*Defined in [src/core/mst-operations.ts:648](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L648)* +*Defined in [src/core/mst-operations.ts:648](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L648)* 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 @@ -2899,7 +2908,7 @@ ___ ▸ **getRoot**<**IT**>(`target`: IAnyStateTreeNode): *TypeOrStateTreeNodeToStateTreeNode‹IT›* -*Defined in [src/core/mst-operations.ts:451](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L451)* +*Defined in [src/core/mst-operations.ts:451](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L451)* Given an object in a model tree, returns the root object of that tree. @@ -2924,7 +2933,7 @@ ___ ▸ **getRunningActionContext**(): *[IActionContext](interfaces/iactioncontext.md) | undefined* -*Defined in [src/core/actionContext.ts:26](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/actionContext.ts#L26)* +*Defined in [src/core/actionContext.ts:26](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/actionContext.ts#L26)* Returns the currently executing MST action context, or undefined if none. @@ -2936,7 +2945,7 @@ ___ ▸ **getSnapshot**<**S**>(`target`: IStateTreeNode‹[IType](interfaces/itype.md)‹any, S, any››, `applyPostProcess`: boolean): *S* -*Defined in [src/core/mst-operations.ts:336](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L336)* +*Defined in [src/core/mst-operations.ts:336](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L336)* 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. @@ -2960,7 +2969,7 @@ ___ ▸ **getType**(`object`: IAnyStateTreeNode): *[IAnyComplexType](interfaces/ianycomplextype.md)* -*Defined in [src/core/mst-operations.ts:46](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L46)* +*Defined in [src/core/mst-operations.ts:46](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L46)* Returns the _actual_ type of the given tree node. (Or throws) @@ -2978,7 +2987,7 @@ ___ ▸ **hasEnv**(`target`: IAnyStateTreeNode): *boolean* -*Defined in [src/core/mst-operations.ts:790](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L790)* +*Defined in [src/core/mst-operations.ts:790](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L790)* Returns whether the current state tree has environment or not. @@ -2998,7 +3007,7 @@ ___ ▸ **hasParent**(`target`: IAnyStateTreeNode, `depth`: number): *boolean* -*Defined in [src/core/mst-operations.ts:356](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L356)* +*Defined in [src/core/mst-operations.ts:356](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L356)* Given a model instance, returns `true` if the object has a parent, that is, is part of another object, map or array. @@ -3017,7 +3026,7 @@ ___ ▸ **hasParentOfType**(`target`: IAnyStateTreeNode, `type`: [IAnyComplexType](interfaces/ianycomplextype.md)): *boolean* -*Defined in [src/core/mst-operations.ts:406](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L406)* +*Defined in [src/core/mst-operations.ts:406](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L406)* Given a model instance, returns `true` if the object has a parent of given type, that is, is part of another object, map or array @@ -3036,7 +3045,7 @@ ___ ▸ **isActionContextChildOf**(`actionContext`: [IActionContext](interfaces/iactioncontext.md), `parent`: number | [IActionContext](interfaces/iactioncontext.md) | [IMiddlewareEvent](interfaces/imiddlewareevent.md)): *boolean* -*Defined in [src/core/actionContext.ts:56](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/actionContext.ts#L56)* +*Defined in [src/core/actionContext.ts:56](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/actionContext.ts#L56)* Returns if the given action context is a parent of this action context. @@ -3055,7 +3064,7 @@ ___ ▸ **isActionContextThisOrChildOf**(`actionContext`: [IActionContext](interfaces/iactioncontext.md), `parentOrThis`: number | [IActionContext](interfaces/iactioncontext.md) | [IMiddlewareEvent](interfaces/imiddlewareevent.md)): *boolean* -*Defined in [src/core/actionContext.ts:66](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/actionContext.ts#L66)* +*Defined in [src/core/actionContext.ts:66](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/actionContext.ts#L66)* Returns if the given action context is this or a parent of this action context. @@ -3074,7 +3083,7 @@ ___ ▸ **isAlive**(`target`: IAnyStateTreeNode): *boolean* -*Defined in [src/core/mst-operations.ts:716](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L716)* +*Defined in [src/core/mst-operations.ts:716](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L716)* 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 `destroy` @@ -3093,23 +3102,19 @@ ___ ### isArrayType -▸ **isArrayType**<**Items**>(`type`: [IAnyType](interfaces/ianytype.md)): *type is IArrayType* +▸ **isArrayType**(`type`: unknown): *type is IArrayType* -*Defined in [src/types/complex-types/array.ts:508](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/array.ts#L508)* +*Defined in [src/types/complex-types/array.ts:508](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/array.ts#L508)* Returns if a given value represents an array type. -**Type parameters:** - -▪ **Items**: *[IAnyType](interfaces/ianytype.md)* - **Parameters:** Name | Type | ------ | ------ | -`type` | [IAnyType](interfaces/ianytype.md) | +`type` | unknown | -**Returns:** *type is IArrayType* +**Returns:** *type is IArrayType* `true` if the type is an array type. @@ -3117,113 +3122,91 @@ ___ ### isFrozenType -▸ **isFrozenType**<**IT**, **T**>(`type`: IT): *type is IT* +▸ **isFrozenType**(`type`: unknown): *type is ISimpleType* -*Defined in [src/types/utility-types/frozen.ts:109](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/frozen.ts#L109)* +*Defined in [src/types/utility-types/frozen.ts:110](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/frozen.ts#L110)* Returns if a given value represents a frozen type. -**Type parameters:** - -▪ **IT**: *[IType](interfaces/itype.md)‹T | any, T, T›* - -▪ **T** - **Parameters:** Name | Type | ------ | ------ | -`type` | IT | +`type` | unknown | -**Returns:** *type is IT* +**Returns:** *type is ISimpleType* ___ ### isIdentifierType -▸ **isIdentifierType**<**IT**>(`type`: IT): *type is IT* +▸ **isIdentifierType**(`type`: unknown): *type is ISimpleType | ISimpleType* -*Defined in [src/types/utility-types/identifier.ts:135](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/identifier.ts#L135)* +*Defined in [src/types/utility-types/identifier.ts:135](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/identifier.ts#L135)* Returns if a given value represents an identifier type. -**Type parameters:** - -▪ **IT**: *[ISimpleType](interfaces/isimpletype.md) | [ISimpleType](interfaces/isimpletype.md)* - **Parameters:** Name | Type | ------ | ------ | -`type` | IT | +`type` | unknown | -**Returns:** *type is IT* +**Returns:** *type is ISimpleType | ISimpleType* ___ ### isLateType -▸ **isLateType**<**IT**>(`type`: IT): *type is IT* +▸ **isLateType**(`type`: unknown): *type is IAnyType* -*Defined in [src/types/utility-types/late.ts:141](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/late.ts#L141)* +*Defined in [src/types/utility-types/late.ts:141](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/late.ts#L141)* Returns if a given value represents a late type. -**Type parameters:** - -▪ **IT**: *[IAnyType](interfaces/ianytype.md)* - **Parameters:** Name | Type | ------ | ------ | -`type` | IT | +`type` | unknown | -**Returns:** *type is IT* +**Returns:** *type is IAnyType* ___ ### isLiteralType -▸ **isLiteralType**<**IT**>(`type`: IT): *type is IT* +▸ **isLiteralType**(`type`: unknown): *type is ISimpleType* -*Defined in [src/types/utility-types/literal.ts:81](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/literal.ts#L81)* +*Defined in [src/types/utility-types/literal.ts:81](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/literal.ts#L81)* Returns if a given value represents a literal type. -**Type parameters:** - -▪ **IT**: *[ISimpleType](interfaces/isimpletype.md)‹any›* - **Parameters:** Name | Type | ------ | ------ | -`type` | IT | +`type` | unknown | -**Returns:** *type is IT* +**Returns:** *type is ISimpleType* ___ ### isMapType -▸ **isMapType**<**Items**>(`type`: [IAnyType](interfaces/ianytype.md)): *type is IMapType* +▸ **isMapType**(`type`: unknown): *type is IMapType* -*Defined in [src/types/complex-types/map.ts:512](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/map.ts#L512)* +*Defined in [src/types/complex-types/map.ts:512](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/map.ts#L512)* Returns if a given value represents a map type. -**Type parameters:** - -▪ **Items**: *[IAnyType](interfaces/ianytype.md)* - **Parameters:** Name | Type | ------ | ------ | -`type` | [IAnyType](interfaces/ianytype.md) | +`type` | unknown | -**Returns:** *type is IMapType* +**Returns:** *type is IMapType* `true` if it is a map type. @@ -3231,69 +3214,57 @@ ___ ### isModelType -▸ **isModelType**<**IT**>(`type`: [IAnyType](interfaces/ianytype.md)): *type is IT* +▸ **isModelType**(`type`: unknown): *type is IAnyModelType* -*Defined in [src/types/complex-types/model.ts:854](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L854)* +*Defined in [src/types/complex-types/model.ts:862](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L862)* Returns if a given value represents a model type. -**Type parameters:** - -▪ **IT**: *[IAnyModelType](interfaces/ianymodeltype.md)* - **Parameters:** Name | Type | ------ | ------ | -`type` | [IAnyType](interfaces/ianytype.md) | +`type` | unknown | -**Returns:** *type is IT* +**Returns:** *type is IAnyModelType* ___ ### isOptionalType -▸ **isOptionalType**<**IT**>(`type`: IT): *type is IT* +▸ **isOptionalType**(`type`: unknown): *type is IOptionalIType* -*Defined in [src/types/utility-types/optional.ts:229](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/optional.ts#L229)* +*Defined in [src/types/utility-types/optional.ts:229](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/optional.ts#L229)* Returns if a value represents an optional type. **`template`** IT -**Type parameters:** - -▪ **IT**: *[IAnyType](interfaces/ianytype.md)* - **Parameters:** Name | Type | ------ | ------ | -`type` | IT | +`type` | unknown | -**Returns:** *type is IT* +**Returns:** *type is IOptionalIType* ___ ### isPrimitiveType -▸ **isPrimitiveType**<**IT**>(`type`: IT): *type is IT* +▸ **isPrimitiveType**(`type`: unknown): *type is ISimpleType | ISimpleType | ISimpleType | IType* -*Defined in [src/types/primitives.ts:241](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/primitives.ts#L241)* +*Defined in [src/types/primitives.ts:241](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/primitives.ts#L241)* Returns if a given value represents a primitive type. -**Type parameters:** - -▪ **IT**: *[ISimpleType](interfaces/isimpletype.md)‹string› | [ISimpleType](interfaces/isimpletype.md)‹number› | [ISimpleType](interfaces/isimpletype.md)‹boolean› | [IType](interfaces/itype.md)* - **Parameters:** Name | Type | ------ | ------ | -`type` | IT | +`type` | unknown | -**Returns:** *type is IT* +**Returns:** *type is ISimpleType | ISimpleType | ISimpleType | IType* ___ @@ -3301,7 +3272,7 @@ ___ ▸ **isProtected**(`target`: IAnyStateTreeNode): *boolean* -*Defined in [src/core/mst-operations.ts:310](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L310)* +*Defined in [src/core/mst-operations.ts:310](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L310)* Returns true if the object is in protected mode, @see protect @@ -3317,45 +3288,37 @@ ___ ### isReferenceType -▸ **isReferenceType**<**IT**>(`type`: IT): *type is IT* +▸ **isReferenceType**(`type`: unknown): *type is IReferenceType* -*Defined in [src/types/utility-types/reference.ts:511](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/reference.ts#L511)* +*Defined in [src/types/utility-types/reference.ts:513](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/reference.ts#L513)* Returns if a given value represents a reference type. -**Type parameters:** - -▪ **IT**: *IReferenceType‹any›* - **Parameters:** Name | Type | ------ | ------ | -`type` | IT | +`type` | unknown | -**Returns:** *type is IT* +**Returns:** *type is IReferenceType* ___ ### isRefinementType -▸ **isRefinementType**<**IT**>(`type`: IT): *type is IT* +▸ **isRefinementType**(`type`: unknown): *type is IAnyType* -*Defined in [src/types/utility-types/refinement.ts:123](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/refinement.ts#L123)* +*Defined in [src/types/utility-types/refinement.ts:123](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/refinement.ts#L123)* Returns if a given value is a refinement type. -**Type parameters:** - -▪ **IT**: *[IAnyType](interfaces/ianytype.md)* - **Parameters:** Name | Type | ------ | ------ | -`type` | IT | +`type` | unknown | -**Returns:** *type is IT* +**Returns:** *type is IAnyType* ___ @@ -3363,7 +3326,7 @@ ___ ▸ **isRoot**(`target`: IAnyStateTreeNode): *boolean* -*Defined in [src/core/mst-operations.ts:492](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L492)* +*Defined in [src/core/mst-operations.ts:492](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L492)* Returns true if the given object is the root of a model tree. @@ -3381,7 +3344,7 @@ ___ ▸ **isStateTreeNode**<**IT**>(`value`: any): *value is STNValue, IT>* -*Defined in [src/core/node/node-utils.ts:68](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/node/node-utils.ts#L68)* +*Defined in [src/core/node/node-utils.ts:68](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/node/node-utils.ts#L68)* 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 @@ -3407,7 +3370,7 @@ ___ ▸ **isType**(`value`: any): *value is IAnyType* -*Defined in [src/core/type/type.ts:538](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L538)* +*Defined in [src/core/type/type.ts:538](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L538)* Returns if a given value represents a type. @@ -3425,23 +3388,19 @@ ___ ### isUnionType -▸ **isUnionType**<**IT**>(`type`: IT): *type is IT* +▸ **isUnionType**(`type`: unknown): *type is IUnionType* -*Defined in [src/types/utility-types/union.ts:203](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/union.ts#L203)* +*Defined in [src/types/utility-types/union.ts:203](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/union.ts#L203)* Returns if a given value represents a union type. -**Type parameters:** - -▪ **IT**: *[IAnyType](interfaces/ianytype.md)* - **Parameters:** Name | Type | ------ | ------ | -`type` | IT | +`type` | unknown | -**Returns:** *type is IT* +**Returns:** *type is IUnionType* ___ @@ -3449,7 +3408,7 @@ ___ ▸ **isValidReference**<**N**>(`getter`: function, `checkIfAlive`: boolean): *boolean* -*Defined in [src/core/mst-operations.ts:596](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L596)* +*Defined in [src/core/mst-operations.ts:596](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L596)* Tests if a reference is valid (pointing to an existing node and optionally if alive) and returns if the check passes or not. @@ -3477,7 +3436,7 @@ ___ ▸ **joinJsonPath**(`path`: string[]): *string* -*Defined in [src/core/json-patch.ts:99](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/json-patch.ts#L99)* +*Defined in [src/core/json-patch.ts:99](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/json-patch.ts#L99)* Generates a json-path compliant json path from path parts. @@ -3495,7 +3454,7 @@ ___ ▸ **late**<**T**>(`type`: function): *T* -*Defined in [src/types/utility-types/late.ts:103](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/late.ts#L103)* +*Defined in [src/types/utility-types/late.ts:103](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/late.ts#L103)* `types.late` - 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. @@ -3524,7 +3483,7 @@ A function that returns the type that will be defined. ▸ **late**<**T**>(`name`: string, `type`: function): *T* -*Defined in [src/types/utility-types/late.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/late.ts#L104)* +*Defined in [src/types/utility-types/late.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/late.ts#L104)* `types.late` - 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. @@ -3561,7 +3520,7 @@ ___ ▸ **lazy**<**T**, **U**>(`name`: string, `options`: LazyOptions‹T, U›): *T* -*Defined in [src/types/utility-types/lazy.ts:22](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/lazy.ts#L22)* +*Defined in [src/types/utility-types/lazy.ts:22](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/lazy.ts#L22)* **Type parameters:** @@ -3584,7 +3543,7 @@ ___ ▸ **literal**<**S**>(`value`: S): *[ISimpleType](interfaces/isimpletype.md)‹S›* -*Defined in [src/types/utility-types/literal.ts:68](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/literal.ts#L68)* +*Defined in [src/types/utility-types/literal.ts:68](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/literal.ts#L68)* `types.literal` - 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. @@ -3616,7 +3575,7 @@ ___ ▸ **map**<**IT**>(`subtype`: IT): *IMapType‹IT›* -*Defined in [src/types/complex-types/map.ts:502](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/map.ts#L502)* +*Defined in [src/types/complex-types/map.ts:502](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/map.ts#L502)* `types.map` - 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. @@ -3659,7 +3618,7 @@ ___ ▸ **maybe**<**IT**>(`type`: IT): *IMaybe‹IT›* -*Defined in [src/types/utility-types/maybe.ts:31](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/maybe.ts#L31)* +*Defined in [src/types/utility-types/maybe.ts:31](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/maybe.ts#L31)* `types.maybe` - Maybe will make a type nullable, and also optional. The value `undefined` will be used to represent nullability. @@ -3682,7 +3641,7 @@ ___ ▸ **maybeNull**<**IT**>(`type`: IT): *IMaybeNull‹IT›* -*Defined in [src/types/utility-types/maybe.ts:44](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/maybe.ts#L44)* +*Defined in [src/types/utility-types/maybe.ts:44](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/maybe.ts#L44)* `types.maybeNull` - Maybe will make a type nullable, and also optional. The value `null` will be used to represent no value. @@ -3705,7 +3664,7 @@ ___ ▸ **model**<**P**>(`name`: string, `properties?`: [P](undefined)): *[IModelType](interfaces/imodeltype.md)‹ModelPropertiesDeclarationToProperties‹P›, __type›* -*Defined in [src/types/complex-types/model.ts:738](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L738)* +*Defined in [src/types/complex-types/model.ts:746](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L746)* `types.model` - Creates a new model type by providing a name, properties, volatile state and actions. @@ -3726,7 +3685,7 @@ Name | Type | ▸ **model**<**P**>(`properties?`: [P](undefined)): *[IModelType](interfaces/imodeltype.md)‹ModelPropertiesDeclarationToProperties‹P›, __type›* -*Defined in [src/types/complex-types/model.ts:742](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L742)* +*Defined in [src/types/complex-types/model.ts:750](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L750)* `types.model` - Creates a new model type by providing a name, properties, volatile state and actions. @@ -3750,7 +3709,7 @@ ___ ▸ **onAction**(`target`: IAnyStateTreeNode, `listener`: function, `attachAfter`: boolean): *[IDisposer](index.md#idisposer)* -*Defined in [src/middlewares/on-action.ts:225](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/on-action.ts#L225)* +*Defined in [src/middlewares/on-action.ts:225](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/on-action.ts#L225)* 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 [actions](https://github.com/mobxjs/mobx-state-tree#actions) for more details. onAction events are emitted only for the outermost called action in the stack. @@ -3810,7 +3769,7 @@ ___ ▸ **onPatch**(`target`: IAnyStateTreeNode, `callback`: function): *[IDisposer](index.md#idisposer)* -*Defined in [src/core/mst-operations.ts:83](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L83)* +*Defined in [src/core/mst-operations.ts:83](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L83)* 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 [patches](https://github.com/mobxjs/mobx-state-tree#patches) for more details. onPatch events are emitted immediately and will not await the end of a transaction. @@ -3845,7 +3804,7 @@ ___ ▸ **onSnapshot**<**S**>(`target`: IStateTreeNode‹[IType](interfaces/itype.md)‹any, S, any››, `callback`: function): *[IDisposer](index.md#idisposer)* -*Defined in [src/core/mst-operations.ts:103](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L103)* +*Defined in [src/core/mst-operations.ts:103](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L103)* 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. @@ -3877,7 +3836,7 @@ ___ ▸ **optional**<**IT**>(`type`: IT, `defaultValueOrFunction`: OptionalDefaultValueOrFunction‹IT›): *IOptionalIType‹IT, []›* -*Defined in [src/types/utility-types/optional.ts:155](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/optional.ts#L155)* +*Defined in [src/types/utility-types/optional.ts:155](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/optional.ts#L155)* `types.optional` - Can be used to create a property with a default value. @@ -3929,7 +3888,7 @@ Name | Type | ▸ **optional**<**IT**, **OptionalVals**>(`type`: IT, `defaultValueOrFunction`: OptionalDefaultValueOrFunction‹IT›, `optionalValues`: OptionalVals): *IOptionalIType‹IT, OptionalVals›* -*Defined in [src/types/utility-types/optional.ts:159](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/optional.ts#L159)* +*Defined in [src/types/utility-types/optional.ts:159](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/optional.ts#L159)* `types.optional` - Can be used to create a property with a default value. @@ -3988,7 +3947,7 @@ ___ ▸ **protect**(`target`: IAnyStateTreeNode): *void* -*Defined in [src/core/mst-operations.ts:265](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L265)* +*Defined in [src/core/mst-operations.ts:265](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L265)* The inverse of `unprotect`. @@ -4006,7 +3965,7 @@ ___ ▸ **recordActions**(`subject`: IAnyStateTreeNode, `filter?`: undefined | function): *[IActionRecorder](interfaces/iactionrecorder.md)* -*Defined in [src/middlewares/on-action.ts:147](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/on-action.ts#L147)* +*Defined in [src/middlewares/on-action.ts:147](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/on-action.ts#L147)* Small abstraction around `onAction` and `applyAction`, attaches an action listener to a tree and records all the actions emitted. Returns an recorder object with the following signature: @@ -4044,7 +4003,7 @@ ___ ▸ **recordPatches**(`subject`: IAnyStateTreeNode, `filter?`: undefined | function): *[IPatchRecorder](interfaces/ipatchrecorder.md)* -*Defined in [src/core/mst-operations.ts:177](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L177)* +*Defined in [src/core/mst-operations.ts:177](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L177)* Small abstraction around `onPatch` and `applyPatch`, attaches a patch listener to a tree and records all the patches. Returns a recorder object with the following signature: @@ -4087,7 +4046,7 @@ ___ ▸ **reference**<**IT**>(`subType`: IT, `options?`: [ReferenceOptions](index.md#referenceoptions)‹IT›): *IReferenceType‹IT›* -*Defined in [src/types/utility-types/reference.ts:464](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/reference.ts#L464)* +*Defined in [src/types/utility-types/reference.ts:466](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/reference.ts#L466)* `types.reference` - Creates a reference to another type, which should have defined an identifier. See also the [reference and identifiers](https://github.com/mobxjs/mobx-state-tree#references-and-identifiers) section. @@ -4111,7 +4070,7 @@ ___ ▸ **refinement**<**IT**>(`name`: string, `type`: IT, `predicate`: function, `message?`: string | function): *IT* -*Defined in [src/types/utility-types/refinement.ts:83](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/refinement.ts#L83)* +*Defined in [src/types/utility-types/refinement.ts:83](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/refinement.ts#L83)* `types.refinement` - Creates a type that is more specific than the base type, e.g. `types.refinement(types.string, value => value.length > 5)` to create a type of strings that can only be longer then 5. @@ -4141,7 +4100,7 @@ Name | Type | ▸ **refinement**<**IT**>(`type`: IT, `predicate`: function, `message?`: string | function): *IT* -*Defined in [src/types/utility-types/refinement.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/refinement.ts#L89)* +*Defined in [src/types/utility-types/refinement.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/refinement.ts#L89)* `types.refinement` - Creates a type that is more specific than the base type, e.g. `types.refinement(types.string, value => value.length > 5)` to create a type of strings that can only be longer then 5. @@ -4173,7 +4132,7 @@ ___ ▸ **resolveIdentifier**<**IT**>(`type`: IT, `target`: IAnyStateTreeNode, `identifier`: [ReferenceIdentifier](index.md#referenceidentifier)): *IT["Type"] | undefined* -*Defined in [src/core/mst-operations.ts:525](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L525)* +*Defined in [src/core/mst-operations.ts:525](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L525)* 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. @@ -4198,7 +4157,7 @@ ___ ▸ **resolvePath**(`target`: IAnyStateTreeNode, `path`: string): *any* -*Defined in [src/core/mst-operations.ts:507](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L507)* +*Defined in [src/core/mst-operations.ts:507](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L507)* Resolves a path relatively to a given object. Returns undefined if no value can be found. @@ -4218,7 +4177,7 @@ ___ ▸ **safeReference**<**IT**>(`subType`: IT, `options`: __type | [ReferenceOptionsGetSet](interfaces/referenceoptionsgetset.md)‹IT› & object): *IReferenceType‹IT›* -*Defined in [src/types/utility-types/reference.ts:515](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/reference.ts#L515)* +*Defined in [src/types/utility-types/reference.ts:517](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/reference.ts#L517)* `types.safeReference` - 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 @@ -4248,7 +4207,7 @@ Name | Type | ▸ **safeReference**<**IT**>(`subType`: IT, `options?`: __type | [ReferenceOptionsGetSet](interfaces/referenceoptionsgetset.md)‹IT› & object): *IMaybe‹IReferenceType‹IT››* -*Defined in [src/types/utility-types/reference.ts:522](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/reference.ts#L522)* +*Defined in [src/types/utility-types/reference.ts:524](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/reference.ts#L524)* `types.safeReference` - 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 @@ -4282,7 +4241,7 @@ ___ ▸ **setLivelinessChecking**(`mode`: [LivelinessMode](index.md#livelinessmode)): *void* -*Defined in [src/core/node/livelinessChecking.ts:18](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/node/livelinessChecking.ts#L18)* +*Defined in [src/core/node/livelinessChecking.ts:18](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/node/livelinessChecking.ts#L18)* Defines what MST should do when running into reads / writes to objects that have died. By default it will print a warning. @@ -4302,7 +4261,7 @@ ___ ▸ **snapshotProcessor**<**IT**, **CustomC**, **CustomS**>(`type`: IT, `processors`: [ISnapshotProcessors](interfaces/isnapshotprocessors.md)‹IT, CustomC, CustomS›, `name?`: undefined | string): *[ISnapshotProcessor](interfaces/isnapshotprocessor.md)‹IT, CustomC, CustomS›* -*Defined in [src/types/utility-types/snapshotProcessor.ts:247](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/snapshotProcessor.ts#L247)* +*Defined in [src/types/utility-types/snapshotProcessor.ts:247](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/snapshotProcessor.ts#L247)* `types.snapshotProcessor` - Runs a pre/post snapshot processor before/after serializing a given type. @@ -4355,7 +4314,7 @@ ___ ▸ **splitJsonPath**(`path`: string): *string[]* -*Defined in [src/core/json-patch.ts:119](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/json-patch.ts#L119)* +*Defined in [src/core/json-patch.ts:119](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/json-patch.ts#L119)* Splits and decodes a json path into several parts. @@ -4373,7 +4332,7 @@ ___ ▸ **toGenerator**<**R**>(`p`: Promise‹R›): *Generator‹Promise‹R›, R, R›* -*Defined in [src/core/flow.ts:87](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/flow.ts#L87)* +*Defined in [src/core/flow.ts:87](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/flow.ts#L87)* **`experimental`** experimental api - might change on minor/patch releases @@ -4413,7 +4372,7 @@ ___ ▸ **toGeneratorFunction**<**R**, **Args**>(`p`: function): *(Anonymous function)* -*Defined in [src/core/flow.ts:60](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/flow.ts#L60)* +*Defined in [src/core/flow.ts:60](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/flow.ts#L60)* **`experimental`** experimental api - might change on minor/patch releases @@ -4462,7 +4421,7 @@ ___ ▸ **tryReference**<**N**>(`getter`: function, `checkIfAlive`: boolean): *N | undefined* -*Defined in [src/core/mst-operations.ts:564](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L564)* +*Defined in [src/core/mst-operations.ts:564](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L564)* 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. @@ -4491,7 +4450,7 @@ ___ ▸ **tryResolve**(`target`: IAnyStateTreeNode, `path`: string): *any* -*Defined in [src/core/mst-operations.ts:624](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L624)* +*Defined in [src/core/mst-operations.ts:624](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L624)* Try to resolve a given path relative to a given node. @@ -4510,7 +4469,7 @@ ___ ▸ **typecheck**<**IT**>(`type`: IT, `value`: ExtractCSTWithSTN‹IT›): *void* -*Defined in [src/core/type/type-checker.ts:164](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type-checker.ts#L164)* +*Defined in [src/core/type/type-checker.ts:164](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type-checker.ts#L164)* 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. @@ -4535,7 +4494,7 @@ ___ ▸ **unescapeJsonPath**(`path`: string): *string* -*Defined in [src/core/json-patch.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/json-patch.ts#L89)* +*Defined in [src/core/json-patch.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/json-patch.ts#L89)* Unescape slashes and backslashes. @@ -4551,9 +4510,9 @@ ___ ### union -▸ **union**<**Types**>(...`types`: Types): *IUnionType‹Types›* +▸ **union**<**Types**>(...`types`: Types): *[IUnionType](index.md#iuniontype)‹Types›* -*Defined in [src/types/utility-types/union.ts:160](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/union.ts#L160)* +*Defined in [src/types/utility-types/union.ts:160](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/union.ts#L160)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -4567,11 +4526,11 @@ Name | Type | ------ | ------ | `...types` | Types | -**Returns:** *IUnionType‹Types›* +**Returns:** *[IUnionType](index.md#iuniontype)‹Types›* -▸ **union**<**Types**>(`options`: [UnionOptions](interfaces/unionoptions.md), ...`types`: Types): *IUnionType‹Types›* +▸ **union**<**Types**>(`options`: [UnionOptions](interfaces/unionoptions.md), ...`types`: Types): *[IUnionType](index.md#iuniontype)‹Types›* -*Defined in [src/types/utility-types/union.ts:161](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/union.ts#L161)* +*Defined in [src/types/utility-types/union.ts:161](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/union.ts#L161)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -4586,7 +4545,7 @@ Name | Type | `options` | [UnionOptions](interfaces/unionoptions.md) | `...types` | Types | -**Returns:** *IUnionType‹Types›* +**Returns:** *[IUnionType](index.md#iuniontype)‹Types›* ___ @@ -4594,7 +4553,7 @@ ___ ▸ **unprotect**(`target`: IAnyStateTreeNode): *void* -*Defined in [src/core/mst-operations.ts:298](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L298)* +*Defined in [src/core/mst-operations.ts:298](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L298)* 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. @@ -4633,7 +4592,7 @@ ___ ▸ **walk**(`target`: IAnyStateTreeNode, `processor`: function): *void* -*Defined in [src/core/mst-operations.ts:808](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L808)* +*Defined in [src/core/mst-operations.ts:808](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L808)* Performs a depth first walk through a tree. @@ -4659,178 +4618,178 @@ Name | Type | ### ▪ **types**: *object* -*Defined in [src/types/index.ts:34](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L34)* +*Defined in [src/types/index.ts:34](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L34)* ### Date • **Date**: *[IType](interfaces/itype.md)‹number | Date, number, Date›* = DatePrimitive -*Defined in [src/types/index.ts:53](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L53)* +*Defined in [src/types/index.ts:53](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L53)* ### array • **array**: *[array](index.md#array)* -*Defined in [src/types/index.ts:55](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L55)* +*Defined in [src/types/index.ts:55](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L55)* ### boolean • **boolean**: *[ISimpleType](interfaces/isimpletype.md)‹boolean›* -*Defined in [src/types/index.ts:48](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L48)* +*Defined in [src/types/index.ts:48](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L48)* ### compose • **compose**: *[compose](index.md#compose)* -*Defined in [src/types/index.ts:37](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L37)* +*Defined in [src/types/index.ts:37](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L37)* ### custom • **custom**: *[custom](index.md#custom)* -*Defined in [src/types/index.ts:38](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L38)* +*Defined in [src/types/index.ts:38](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L38)* ### enumeration • **enumeration**: *[enumeration](index.md#enumeration)* -*Defined in [src/types/index.ts:35](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L35)* +*Defined in [src/types/index.ts:35](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L35)* ### finite • **finite**: *[ISimpleType](interfaces/isimpletype.md)‹number›* -*Defined in [src/types/index.ts:52](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L52)* +*Defined in [src/types/index.ts:52](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L52)* ### float • **float**: *[ISimpleType](interfaces/isimpletype.md)‹number›* -*Defined in [src/types/index.ts:51](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L51)* +*Defined in [src/types/index.ts:51](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L51)* ### frozen • **frozen**: *[frozen](index.md#frozen)* -*Defined in [src/types/index.ts:56](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L56)* +*Defined in [src/types/index.ts:56](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L56)* ### identifier • **identifier**: *[ISimpleType](interfaces/isimpletype.md)‹string›* -*Defined in [src/types/index.ts:57](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L57)* +*Defined in [src/types/index.ts:57](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L57)* ### identifierNumber • **identifierNumber**: *[ISimpleType](interfaces/isimpletype.md)‹number›* -*Defined in [src/types/index.ts:58](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L58)* +*Defined in [src/types/index.ts:58](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L58)* ### integer • **integer**: *[ISimpleType](interfaces/isimpletype.md)‹number›* -*Defined in [src/types/index.ts:50](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L50)* +*Defined in [src/types/index.ts:50](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L50)* ### late • **late**: *[late](index.md#late)* -*Defined in [src/types/index.ts:59](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L59)* +*Defined in [src/types/index.ts:59](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L59)* ### lazy • **lazy**: *[lazy](index.md#lazy)* -*Defined in [src/types/index.ts:60](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L60)* +*Defined in [src/types/index.ts:60](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L60)* ### literal • **literal**: *[literal](index.md#literal)* -*Defined in [src/types/index.ts:43](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L43)* +*Defined in [src/types/index.ts:43](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L43)* ### map • **map**: *[map](index.md#map)* -*Defined in [src/types/index.ts:54](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L54)* +*Defined in [src/types/index.ts:54](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L54)* ### maybe • **maybe**: *[maybe](index.md#maybe)* -*Defined in [src/types/index.ts:44](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L44)* +*Defined in [src/types/index.ts:44](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L44)* ### maybeNull • **maybeNull**: *[maybeNull](index.md#maybenull)* -*Defined in [src/types/index.ts:45](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L45)* +*Defined in [src/types/index.ts:45](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L45)* ### model • **model**: *[model](index.md#model)* -*Defined in [src/types/index.ts:36](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L36)* +*Defined in [src/types/index.ts:36](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L36)* ### null • **null**: *[ISimpleType](interfaces/isimpletype.md)‹null›* = nullType -*Defined in [src/types/index.ts:62](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L62)* +*Defined in [src/types/index.ts:62](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L62)* ### number • **number**: *[ISimpleType](interfaces/isimpletype.md)‹number›* -*Defined in [src/types/index.ts:49](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L49)* +*Defined in [src/types/index.ts:49](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L49)* ### optional • **optional**: *[optional](index.md#optional)* -*Defined in [src/types/index.ts:42](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L42)* +*Defined in [src/types/index.ts:42](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L42)* ### reference • **reference**: *[reference](index.md#reference)* -*Defined in [src/types/index.ts:39](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L39)* +*Defined in [src/types/index.ts:39](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L39)* ### refinement • **refinement**: *[refinement](index.md#refinement)* -*Defined in [src/types/index.ts:46](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L46)* +*Defined in [src/types/index.ts:46](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L46)* ### safeReference • **safeReference**: *[safeReference](index.md#safereference)* -*Defined in [src/types/index.ts:40](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L40)* +*Defined in [src/types/index.ts:40](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L40)* ### snapshotProcessor • **snapshotProcessor**: *[snapshotProcessor](index.md#snapshotprocessor)* -*Defined in [src/types/index.ts:63](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L63)* +*Defined in [src/types/index.ts:63](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L63)* ### string • **string**: *[ISimpleType](interfaces/isimpletype.md)‹string›* -*Defined in [src/types/index.ts:47](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L47)* +*Defined in [src/types/index.ts:47](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L47)* ### undefined • **undefined**: *[ISimpleType](interfaces/isimpletype.md)‹undefined›* = undefinedType -*Defined in [src/types/index.ts:61](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L61)* +*Defined in [src/types/index.ts:61](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L61)* ### union • **union**: *[union](index.md#union)* -*Defined in [src/types/index.ts:41](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/index.ts#L41)* +*Defined in [src/types/index.ts:41](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/index.ts#L41)* diff --git a/docs/API/interfaces/customtypeoptions.md b/docs/API/interfaces/customtypeoptions.md index ccd9c8061..7401db0be 100644 --- a/docs/API/interfaces/customtypeoptions.md +++ b/docs/API/interfaces/customtypeoptions.md @@ -4,7 +4,7 @@ title: "CustomTypeOptions" sidebar_label: "CustomTypeOptions" --- -[mobx-state-tree - v6.0.0](../index.md) › [CustomTypeOptions](customtypeoptions.md) +[mobx-state-tree - v6.0.1](../index.md) › [CustomTypeOptions](customtypeoptions.md) ## Type parameters @@ -35,7 +35,7 @@ sidebar_label: "CustomTypeOptions" • **name**: *string* -*Defined in [src/types/utility-types/custom.ts:15](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/custom.ts#L15)* +*Defined in [src/types/utility-types/custom.ts:15](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/custom.ts#L15)* Friendly name @@ -45,7 +45,7 @@ Friendly name ▸ **fromSnapshot**(`snapshot`: S, `env?`: any): *T* -*Defined in [src/types/utility-types/custom.ts:17](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/custom.ts#L17)* +*Defined in [src/types/utility-types/custom.ts:17](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/custom.ts#L17)* given a serialized value and environment, how to turn it into the target type @@ -64,7 +64,7 @@ ___ ▸ **getValidationMessage**(`snapshot`: S): *string* -*Defined in [src/types/utility-types/custom.ts:23](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/custom.ts#L23)* +*Defined in [src/types/utility-types/custom.ts:23](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/custom.ts#L23)* a non empty string is assumed to be a validation error @@ -82,7 +82,7 @@ ___ ▸ **isTargetType**(`value`: T | S): *boolean* -*Defined in [src/types/utility-types/custom.ts:21](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/custom.ts#L21)* +*Defined in [src/types/utility-types/custom.ts:21](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/custom.ts#L21)* if true, this is a converted value, if false, it's a snapshot @@ -100,7 +100,7 @@ ___ ▸ **toSnapshot**(`value`: T): *S* -*Defined in [src/types/utility-types/custom.ts:19](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/custom.ts#L19)* +*Defined in [src/types/utility-types/custom.ts:19](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/custom.ts#L19)* return the serialization of the current value diff --git a/docs/API/interfaces/functionwithflag.md b/docs/API/interfaces/functionwithflag.md index aaac7ce61..30c9c5666 100644 --- a/docs/API/interfaces/functionwithflag.md +++ b/docs/API/interfaces/functionwithflag.md @@ -4,7 +4,7 @@ title: "FunctionWithFlag" sidebar_label: "FunctionWithFlag" --- -[mobx-state-tree - v6.0.0](../index.md) › [FunctionWithFlag](functionwithflag.md) +[mobx-state-tree - v6.0.1](../index.md) › [FunctionWithFlag](functionwithflag.md) ## Hierarchy @@ -58,7 +58,7 @@ ___ • **_isFlowAction**? : *undefined | false | true* -*Defined in [src/core/action.ts:42](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/action.ts#L42)* +*Defined in [src/core/action.ts:42](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/action.ts#L42)* ___ @@ -66,7 +66,7 @@ ___ • **_isMSTAction**? : *undefined | false | true* -*Defined in [src/core/action.ts:41](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/action.ts#L41)* +*Defined in [src/core/action.ts:41](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/action.ts#L41)* ___ diff --git a/docs/API/interfaces/iactioncontext.md b/docs/API/interfaces/iactioncontext.md index 259d5e60f..221426fc8 100644 --- a/docs/API/interfaces/iactioncontext.md +++ b/docs/API/interfaces/iactioncontext.md @@ -4,7 +4,7 @@ title: "IActionContext" sidebar_label: "IActionContext" --- -[mobx-state-tree - v6.0.0](../index.md) › [IActionContext](iactioncontext.md) +[mobx-state-tree - v6.0.1](../index.md) › [IActionContext](iactioncontext.md) ## Hierarchy @@ -29,7 +29,7 @@ sidebar_label: "IActionContext" • **args**: *any[]* -*Defined in [src/core/actionContext.ts:20](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/actionContext.ts#L20)* +*Defined in [src/core/actionContext.ts:20](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/actionContext.ts#L20)* Event arguments in an array (action arguments for actions) @@ -39,7 +39,7 @@ ___ • **context**: *IAnyStateTreeNode* -*Defined in [src/core/actionContext.ts:15](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/actionContext.ts#L15)* +*Defined in [src/core/actionContext.ts:15](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/actionContext.ts#L15)* Event context (node where the action was invoked) @@ -49,7 +49,7 @@ ___ • **id**: *number* -*Defined in [src/core/actionContext.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/actionContext.ts#L9)* +*Defined in [src/core/actionContext.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/actionContext.ts#L9)* Event unique id @@ -59,7 +59,7 @@ ___ • **name**: *string* -*Defined in [src/core/actionContext.ts:6](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/actionContext.ts#L6)* +*Defined in [src/core/actionContext.ts:6](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/actionContext.ts#L6)* Event name (action name for actions) @@ -69,7 +69,7 @@ ___ • **parentActionEvent**: *[IMiddlewareEvent](imiddlewareevent.md) | undefined* -*Defined in [src/core/actionContext.ts:12](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/actionContext.ts#L12)* +*Defined in [src/core/actionContext.ts:12](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/actionContext.ts#L12)* Parent action event object @@ -79,6 +79,6 @@ ___ • **tree**: *IAnyStateTreeNode* -*Defined in [src/core/actionContext.ts:17](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/actionContext.ts#L17)* +*Defined in [src/core/actionContext.ts:17](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/actionContext.ts#L17)* Event tree (root node of the node where the action was invoked) diff --git a/docs/API/interfaces/iactionrecorder.md b/docs/API/interfaces/iactionrecorder.md index 567ff0327..4ad3c1f16 100644 --- a/docs/API/interfaces/iactionrecorder.md +++ b/docs/API/interfaces/iactionrecorder.md @@ -4,7 +4,7 @@ title: "IActionRecorder" sidebar_label: "IActionRecorder" --- -[mobx-state-tree - v6.0.0](../index.md) › [IActionRecorder](iactionrecorder.md) +[mobx-state-tree - v6.0.1](../index.md) › [IActionRecorder](iactionrecorder.md) ## Hierarchy @@ -29,7 +29,7 @@ sidebar_label: "IActionRecorder" • **actions**: *ReadonlyArray‹[ISerializedActionCall](iserializedactioncall.md)›* -*Defined in [src/middlewares/on-action.ts:37](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/on-action.ts#L37)* +*Defined in [src/middlewares/on-action.ts:37](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/on-action.ts#L37)* ___ @@ -37,7 +37,7 @@ ___ • **recording**: *boolean* -*Defined in [src/middlewares/on-action.ts:38](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/on-action.ts#L38)* +*Defined in [src/middlewares/on-action.ts:38](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/on-action.ts#L38)* ## Methods @@ -45,7 +45,7 @@ ___ ▸ **replay**(`target`: IAnyStateTreeNode): *void* -*Defined in [src/middlewares/on-action.ts:41](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/on-action.ts#L41)* +*Defined in [src/middlewares/on-action.ts:41](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/on-action.ts#L41)* **Parameters:** @@ -61,7 +61,7 @@ ___ ▸ **resume**(): *void* -*Defined in [src/middlewares/on-action.ts:40](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/on-action.ts#L40)* +*Defined in [src/middlewares/on-action.ts:40](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/on-action.ts#L40)* **Returns:** *void* @@ -71,6 +71,6 @@ ___ ▸ **stop**(): *void* -*Defined in [src/middlewares/on-action.ts:39](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/on-action.ts#L39)* +*Defined in [src/middlewares/on-action.ts:39](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/on-action.ts#L39)* **Returns:** *void* diff --git a/docs/API/interfaces/iactiontrackingmiddleware2call.md b/docs/API/interfaces/iactiontrackingmiddleware2call.md index e2281388f..d9bd97181 100644 --- a/docs/API/interfaces/iactiontrackingmiddleware2call.md +++ b/docs/API/interfaces/iactiontrackingmiddleware2call.md @@ -4,7 +4,7 @@ title: "IActionTrackingMiddleware2Call" sidebar_label: "IActionTrackingMiddleware2Call" --- -[mobx-state-tree - v6.0.0](../index.md) › [IActionTrackingMiddleware2Call](iactiontrackingmiddleware2call.md) +[mobx-state-tree - v6.0.1](../index.md) › [IActionTrackingMiddleware2Call](iactiontrackingmiddleware2call.md) ## Type parameters @@ -29,7 +29,7 @@ sidebar_label: "IActionTrackingMiddleware2Call" • **env**: *TEnv | undefined* -*Defined in [src/middlewares/createActionTrackingMiddleware2.ts:4](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/createActionTrackingMiddleware2.ts#L4)* +*Defined in [src/middlewares/createActionTrackingMiddleware2.ts:4](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/createActionTrackingMiddleware2.ts#L4)* ___ @@ -37,4 +37,4 @@ ___ • **parentCall**? : *[IActionTrackingMiddleware2Call](iactiontrackingmiddleware2call.md)‹TEnv›* -*Defined in [src/middlewares/createActionTrackingMiddleware2.ts:5](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/createActionTrackingMiddleware2.ts#L5)* +*Defined in [src/middlewares/createActionTrackingMiddleware2.ts:5](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/createActionTrackingMiddleware2.ts#L5)* diff --git a/docs/API/interfaces/iactiontrackingmiddleware2hooks.md b/docs/API/interfaces/iactiontrackingmiddleware2hooks.md index 4c5e87fca..200a81642 100644 --- a/docs/API/interfaces/iactiontrackingmiddleware2hooks.md +++ b/docs/API/interfaces/iactiontrackingmiddleware2hooks.md @@ -4,7 +4,7 @@ title: "IActionTrackingMiddleware2Hooks" sidebar_label: "IActionTrackingMiddleware2Hooks" --- -[mobx-state-tree - v6.0.0](../index.md) › [IActionTrackingMiddleware2Hooks](iactiontrackingmiddleware2hooks.md) +[mobx-state-tree - v6.0.1](../index.md) › [IActionTrackingMiddleware2Hooks](iactiontrackingmiddleware2hooks.md) ## Type parameters @@ -28,7 +28,7 @@ sidebar_label: "IActionTrackingMiddleware2Hooks" • **filter**? : *undefined | function* -*Defined in [src/middlewares/createActionTrackingMiddleware2.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/createActionTrackingMiddleware2.ts#L9)* +*Defined in [src/middlewares/createActionTrackingMiddleware2.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/createActionTrackingMiddleware2.ts#L9)* ___ @@ -36,7 +36,7 @@ ___ • **onFinish**: *function* -*Defined in [src/middlewares/createActionTrackingMiddleware2.ts:11](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/createActionTrackingMiddleware2.ts#L11)* +*Defined in [src/middlewares/createActionTrackingMiddleware2.ts:11](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/createActionTrackingMiddleware2.ts#L11)* #### Type declaration: @@ -55,7 +55,7 @@ ___ • **onStart**: *function* -*Defined in [src/middlewares/createActionTrackingMiddleware2.ts:10](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/createActionTrackingMiddleware2.ts#L10)* +*Defined in [src/middlewares/createActionTrackingMiddleware2.ts:10](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/createActionTrackingMiddleware2.ts#L10)* #### Type declaration: diff --git a/docs/API/interfaces/iactiontrackingmiddlewarehooks.md b/docs/API/interfaces/iactiontrackingmiddlewarehooks.md index e5dd775af..3ad80daa5 100644 --- a/docs/API/interfaces/iactiontrackingmiddlewarehooks.md +++ b/docs/API/interfaces/iactiontrackingmiddlewarehooks.md @@ -4,7 +4,7 @@ title: "IActionTrackingMiddlewareHooks" sidebar_label: "IActionTrackingMiddlewareHooks" --- -[mobx-state-tree - v6.0.0](../index.md) › [IActionTrackingMiddlewareHooks](iactiontrackingmiddlewarehooks.md) +[mobx-state-tree - v6.0.1](../index.md) › [IActionTrackingMiddlewareHooks](iactiontrackingmiddlewarehooks.md) ## Type parameters @@ -31,7 +31,7 @@ sidebar_label: "IActionTrackingMiddlewareHooks" • **filter**? : *undefined | function* -*Defined in [src/middlewares/create-action-tracking-middleware.ts:6](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/create-action-tracking-middleware.ts#L6)* +*Defined in [src/middlewares/create-action-tracking-middleware.ts:6](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/create-action-tracking-middleware.ts#L6)* ___ @@ -39,7 +39,7 @@ ___ • **onFail**: *function* -*Defined in [src/middlewares/create-action-tracking-middleware.ts:11](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/create-action-tracking-middleware.ts#L11)* +*Defined in [src/middlewares/create-action-tracking-middleware.ts:11](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/create-action-tracking-middleware.ts#L11)* #### Type declaration: @@ -59,7 +59,7 @@ ___ • **onResume**: *function* -*Defined in [src/middlewares/create-action-tracking-middleware.ts:8](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/create-action-tracking-middleware.ts#L8)* +*Defined in [src/middlewares/create-action-tracking-middleware.ts:8](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/create-action-tracking-middleware.ts#L8)* #### Type declaration: @@ -78,7 +78,7 @@ ___ • **onStart**: *function* -*Defined in [src/middlewares/create-action-tracking-middleware.ts:7](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/create-action-tracking-middleware.ts#L7)* +*Defined in [src/middlewares/create-action-tracking-middleware.ts:7](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/create-action-tracking-middleware.ts#L7)* #### Type declaration: @@ -96,7 +96,7 @@ ___ • **onSuccess**: *function* -*Defined in [src/middlewares/create-action-tracking-middleware.ts:10](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/create-action-tracking-middleware.ts#L10)* +*Defined in [src/middlewares/create-action-tracking-middleware.ts:10](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/create-action-tracking-middleware.ts#L10)* #### Type declaration: @@ -116,7 +116,7 @@ ___ • **onSuspend**: *function* -*Defined in [src/middlewares/create-action-tracking-middleware.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/create-action-tracking-middleware.ts#L9)* +*Defined in [src/middlewares/create-action-tracking-middleware.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/create-action-tracking-middleware.ts#L9)* #### Type declaration: diff --git a/docs/API/interfaces/ianycomplextype.md b/docs/API/interfaces/ianycomplextype.md index 30e5b25a2..0080afc86 100644 --- a/docs/API/interfaces/ianycomplextype.md +++ b/docs/API/interfaces/ianycomplextype.md @@ -4,7 +4,7 @@ title: "IAnyComplexType" sidebar_label: "IAnyComplexType" --- -[mobx-state-tree - v6.0.0](../index.md) › [IAnyComplexType](ianycomplextype.md) +[mobx-state-tree - v6.0.1](../index.md) › [IAnyComplexType](ianycomplextype.md) Any kind of complex type. @@ -36,7 +36,7 @@ Any kind of complex type. *Inherited from [IType](itype.md).[identifierAttribute](itype.md#optional-identifierattribute)* -*Defined in [src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L89)* +*Defined in [src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L89)* Name of the identifier attribute or null if none. @@ -48,7 +48,7 @@ ___ *Inherited from [IType](itype.md).[name](itype.md#name)* -*Defined in [src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L84)* +*Defined in [src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L84)* Friendly type name. @@ -60,7 +60,7 @@ Friendly type name. *Inherited from [IType](itype.md).[create](itype.md#create)* -*Defined in [src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L96)* +*Defined in [src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L96)* Creates an instance for the type given an snapshot input. @@ -83,7 +83,7 @@ ___ *Inherited from [IType](itype.md).[describe](itype.md#describe)* -*Defined in [src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L118)* +*Defined in [src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L118)* Gets the textual representation of the type as a string. @@ -97,7 +97,7 @@ ___ *Inherited from [IType](itype.md).[is](itype.md#is)* -*Defined in [src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L104)* +*Defined in [src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L104)* Checks if a given snapshot / instance is of the given type. @@ -119,7 +119,7 @@ ___ *Inherited from [IType](itype.md).[validate](itype.md#validate)* -*Defined in [src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L113)* +*Defined in [src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L113)* Run's the type's typechecker on the given value with the given validation context. diff --git a/docs/API/interfaces/ianymodeltype.md b/docs/API/interfaces/ianymodeltype.md index 0932dfa2c..209efd751 100644 --- a/docs/API/interfaces/ianymodeltype.md +++ b/docs/API/interfaces/ianymodeltype.md @@ -4,7 +4,7 @@ title: "IAnyModelType" sidebar_label: "IAnyModelType" --- -[mobx-state-tree - v6.0.0](../index.md) › [IAnyModelType](ianymodeltype.md) +[mobx-state-tree - v6.0.1](../index.md) › [IAnyModelType](ianymodeltype.md) Any model type. @@ -45,7 +45,7 @@ Any model type. *Inherited from [IType](itype.md).[identifierAttribute](itype.md#optional-identifierattribute)* -*Defined in [src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L89)* +*Defined in [src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L89)* Name of the identifier attribute or null if none. @@ -57,7 +57,7 @@ ___ *Inherited from [IType](itype.md).[name](itype.md#name)* -*Defined in [src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L84)* +*Defined in [src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L84)* Friendly type name. @@ -69,7 +69,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[properties](imodeltype.md#properties)* -*Defined in [src/types/complex-types/model.ts:190](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L190)* +*Defined in [src/types/complex-types/model.ts:194](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L194)* ## Methods @@ -79,7 +79,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[actions](imodeltype.md#actions)* -*Defined in [src/types/complex-types/model.ts:204](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L204)* +*Defined in [src/types/complex-types/model.ts:208](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L208)* **Type parameters:** @@ -107,7 +107,7 @@ ___ *Inherited from [IType](itype.md).[create](itype.md#create)* -*Defined in [src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L96)* +*Defined in [src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L96)* Creates an instance for the type given an snapshot input. @@ -130,7 +130,7 @@ ___ *Inherited from [IType](itype.md).[describe](itype.md#describe)* -*Defined in [src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L118)* +*Defined in [src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L118)* Gets the textual representation of the type as a string. @@ -144,7 +144,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[extend](imodeltype.md#extend)* -*Defined in [src/types/complex-types/model.ts:212](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L212)* +*Defined in [src/types/complex-types/model.ts:216](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L216)* **Type parameters:** @@ -176,7 +176,7 @@ ___ *Inherited from [IType](itype.md).[is](itype.md#is)* -*Defined in [src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L104)* +*Defined in [src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L104)* Checks if a given snapshot / instance is of the given type. @@ -198,7 +198,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[named](imodeltype.md#named)* -*Defined in [src/types/complex-types/model.ts:192](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L192)* +*Defined in [src/types/complex-types/model.ts:196](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L196)* **Parameters:** @@ -216,7 +216,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[postProcessSnapshot](imodeltype.md#postprocesssnapshot)* -*Defined in [src/types/complex-types/model.ts:220](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L220)* +*Defined in [src/types/complex-types/model.ts:224](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L224)* **Type parameters:** @@ -244,7 +244,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[preProcessSnapshot](imodeltype.md#preprocesssnapshot)* -*Defined in [src/types/complex-types/model.ts:216](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L216)* +*Defined in [src/types/complex-types/model.ts:220](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L220)* **Type parameters:** @@ -272,7 +272,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[props](imodeltype.md#props)* -*Defined in [src/types/complex-types/model.ts:196](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L196)* +*Defined in [src/types/complex-types/model.ts:200](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L200)* **Type parameters:** @@ -294,7 +294,7 @@ ___ *Inherited from [IType](itype.md).[validate](itype.md#validate)* -*Defined in [src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L113)* +*Defined in [src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L113)* Run's the type's typechecker on the given value with the given validation context. @@ -317,7 +317,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[views](imodeltype.md#views)* -*Defined in [src/types/complex-types/model.ts:200](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L200)* +*Defined in [src/types/complex-types/model.ts:204](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L204)* **Type parameters:** @@ -345,7 +345,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[volatile](imodeltype.md#volatile)* -*Defined in [src/types/complex-types/model.ts:208](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L208)* +*Defined in [src/types/complex-types/model.ts:212](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L212)* **Type parameters:** diff --git a/docs/API/interfaces/ianytype.md b/docs/API/interfaces/ianytype.md index fa13f8ddd..de4630f8e 100644 --- a/docs/API/interfaces/ianytype.md +++ b/docs/API/interfaces/ianytype.md @@ -4,7 +4,7 @@ title: "IAnyType" sidebar_label: "IAnyType" --- -[mobx-state-tree - v6.0.0](../index.md) › [IAnyType](ianytype.md) +[mobx-state-tree - v6.0.1](../index.md) › [IAnyType](ianytype.md) Any kind of type. @@ -36,7 +36,7 @@ Any kind of type. *Inherited from [IType](itype.md).[identifierAttribute](itype.md#optional-identifierattribute)* -*Defined in [src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L89)* +*Defined in [src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L89)* Name of the identifier attribute or null if none. @@ -48,7 +48,7 @@ ___ *Inherited from [IType](itype.md).[name](itype.md#name)* -*Defined in [src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L84)* +*Defined in [src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L84)* Friendly type name. @@ -60,7 +60,7 @@ Friendly type name. *Inherited from [IType](itype.md).[create](itype.md#create)* -*Defined in [src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L96)* +*Defined in [src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L96)* Creates an instance for the type given an snapshot input. @@ -83,7 +83,7 @@ ___ *Inherited from [IType](itype.md).[describe](itype.md#describe)* -*Defined in [src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L118)* +*Defined in [src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L118)* Gets the textual representation of the type as a string. @@ -97,7 +97,7 @@ ___ *Inherited from [IType](itype.md).[is](itype.md#is)* -*Defined in [src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L104)* +*Defined in [src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L104)* Checks if a given snapshot / instance is of the given type. @@ -119,7 +119,7 @@ ___ *Inherited from [IType](itype.md).[validate](itype.md#validate)* -*Defined in [src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L113)* +*Defined in [src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L113)* Run's the type's typechecker on the given value with the given validation context. diff --git a/docs/API/interfaces/ihooks.md b/docs/API/interfaces/ihooks.md index 1980b7cb5..805039838 100644 --- a/docs/API/interfaces/ihooks.md +++ b/docs/API/interfaces/ihooks.md @@ -4,7 +4,7 @@ title: "IHooks" sidebar_label: "IHooks" --- -[mobx-state-tree - v6.0.0](../index.md) › [IHooks](ihooks.md) +[mobx-state-tree - v6.0.1](../index.md) › [IHooks](ihooks.md) ## Hierarchy @@ -25,7 +25,7 @@ sidebar_label: "IHooks" • **[Hook.afterAttach]**? : *undefined | function* -*Defined in [src/core/node/Hook.ts:14](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/node/Hook.ts#L14)* +*Defined in [src/core/node/Hook.ts:14](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/node/Hook.ts#L14)* ___ @@ -33,7 +33,7 @@ ___ • **[Hook.afterCreate]**? : *undefined | function* -*Defined in [src/core/node/Hook.ts:13](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/node/Hook.ts#L13)* +*Defined in [src/core/node/Hook.ts:13](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/node/Hook.ts#L13)* ___ @@ -41,7 +41,7 @@ ___ • **[Hook.beforeDestroy]**? : *undefined | function* -*Defined in [src/core/node/Hook.ts:16](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/node/Hook.ts#L16)* +*Defined in [src/core/node/Hook.ts:16](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/node/Hook.ts#L16)* ___ @@ -49,4 +49,4 @@ ___ • **[Hook.beforeDetach]**? : *undefined | function* -*Defined in [src/core/node/Hook.ts:15](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/node/Hook.ts#L15)* +*Defined in [src/core/node/Hook.ts:15](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/node/Hook.ts#L15)* diff --git a/docs/API/interfaces/ijsonpatch.md b/docs/API/interfaces/ijsonpatch.md index 35a7b0a35..114309273 100644 --- a/docs/API/interfaces/ijsonpatch.md +++ b/docs/API/interfaces/ijsonpatch.md @@ -4,7 +4,7 @@ title: "IJsonPatch" sidebar_label: "IJsonPatch" --- -[mobx-state-tree - v6.0.0](../index.md) › [IJsonPatch](ijsonpatch.md) +[mobx-state-tree - v6.0.1](../index.md) › [IJsonPatch](ijsonpatch.md) https://tools.ietf.org/html/rfc6902 http://jsonpatch.com/ @@ -29,7 +29,7 @@ http://jsonpatch.com/ • **op**: *"replace" | "add" | "remove"* -*Defined in [src/core/json-patch.ts:8](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/json-patch.ts#L8)* +*Defined in [src/core/json-patch.ts:8](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/json-patch.ts#L8)* ___ @@ -37,7 +37,7 @@ ___ • **path**: *string* -*Defined in [src/core/json-patch.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/json-patch.ts#L9)* +*Defined in [src/core/json-patch.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/json-patch.ts#L9)* ___ @@ -45,4 +45,4 @@ ___ • **value**? : *any* -*Defined in [src/core/json-patch.ts:10](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/json-patch.ts#L10)* +*Defined in [src/core/json-patch.ts:10](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/json-patch.ts#L10)* diff --git a/docs/API/interfaces/imiddlewareevent.md b/docs/API/interfaces/imiddlewareevent.md index 7e9f4f74b..551b67399 100644 --- a/docs/API/interfaces/imiddlewareevent.md +++ b/docs/API/interfaces/imiddlewareevent.md @@ -4,7 +4,7 @@ title: "IMiddlewareEvent" sidebar_label: "IMiddlewareEvent" --- -[mobx-state-tree - v6.0.0](../index.md) › [IMiddlewareEvent](imiddlewareevent.md) +[mobx-state-tree - v6.0.1](../index.md) › [IMiddlewareEvent](imiddlewareevent.md) ## Hierarchy @@ -34,7 +34,7 @@ sidebar_label: "IMiddlewareEvent" • **allParentIds**: *number[]* -*Defined in [src/core/action.ts:37](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/action.ts#L37)* +*Defined in [src/core/action.ts:37](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/action.ts#L37)* Id of all events, from root until current (excluding current) @@ -46,7 +46,7 @@ ___ *Inherited from [IActionContext](iactioncontext.md).[args](iactioncontext.md#args)* -*Defined in [src/core/actionContext.ts:20](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/actionContext.ts#L20)* +*Defined in [src/core/actionContext.ts:20](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/actionContext.ts#L20)* Event arguments in an array (action arguments for actions) @@ -58,7 +58,7 @@ ___ *Inherited from [IActionContext](iactioncontext.md).[context](iactioncontext.md#context)* -*Defined in [src/core/actionContext.ts:15](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/actionContext.ts#L15)* +*Defined in [src/core/actionContext.ts:15](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/actionContext.ts#L15)* Event context (node where the action was invoked) @@ -70,7 +70,7 @@ ___ *Inherited from [IActionContext](iactioncontext.md).[id](iactioncontext.md#id)* -*Defined in [src/core/actionContext.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/actionContext.ts#L9)* +*Defined in [src/core/actionContext.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/actionContext.ts#L9)* Event unique id @@ -82,7 +82,7 @@ ___ *Inherited from [IActionContext](iactioncontext.md).[name](iactioncontext.md#name)* -*Defined in [src/core/actionContext.ts:6](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/actionContext.ts#L6)* +*Defined in [src/core/actionContext.ts:6](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/actionContext.ts#L6)* Event name (action name for actions) @@ -94,7 +94,7 @@ ___ *Inherited from [IActionContext](iactioncontext.md).[parentActionEvent](iactioncontext.md#parentactionevent)* -*Defined in [src/core/actionContext.ts:12](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/actionContext.ts#L12)* +*Defined in [src/core/actionContext.ts:12](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/actionContext.ts#L12)* Parent action event object @@ -104,7 +104,7 @@ ___ • **parentEvent**: *[IMiddlewareEvent](imiddlewareevent.md) | undefined* -*Defined in [src/core/action.ts:32](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/action.ts#L32)* +*Defined in [src/core/action.ts:32](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/action.ts#L32)* Parent event object @@ -114,7 +114,7 @@ ___ • **parentId**: *number* -*Defined in [src/core/action.ts:30](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/action.ts#L30)* +*Defined in [src/core/action.ts:30](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/action.ts#L30)* Parent event unique id @@ -124,7 +124,7 @@ ___ • **rootId**: *number* -*Defined in [src/core/action.ts:35](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/action.ts#L35)* +*Defined in [src/core/action.ts:35](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/action.ts#L35)* Root event unique id @@ -136,7 +136,7 @@ ___ *Inherited from [IActionContext](iactioncontext.md).[tree](iactioncontext.md#tree)* -*Defined in [src/core/actionContext.ts:17](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/actionContext.ts#L17)* +*Defined in [src/core/actionContext.ts:17](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/actionContext.ts#L17)* Event tree (root node of the node where the action was invoked) @@ -146,6 +146,6 @@ ___ • **type**: *[IMiddlewareEventType](../index.md#imiddlewareeventtype)* -*Defined in [src/core/action.ts:27](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/action.ts#L27)* +*Defined in [src/core/action.ts:27](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/action.ts#L27)* Event type diff --git a/docs/API/interfaces/imodelreflectiondata.md b/docs/API/interfaces/imodelreflectiondata.md index c66e2006b..9220f0f48 100644 --- a/docs/API/interfaces/imodelreflectiondata.md +++ b/docs/API/interfaces/imodelreflectiondata.md @@ -4,7 +4,7 @@ title: "IModelReflectionData" sidebar_label: "IModelReflectionData" --- -[mobx-state-tree - v6.0.0](../index.md) › [IModelReflectionData](imodelreflectiondata.md) +[mobx-state-tree - v6.0.1](../index.md) › [IModelReflectionData](imodelreflectiondata.md) ## Hierarchy @@ -29,7 +29,7 @@ sidebar_label: "IModelReflectionData" • **actions**: *string[]* -*Defined in [src/core/mst-operations.ts:855](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L855)* +*Defined in [src/core/mst-operations.ts:855](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L855)* ___ @@ -37,7 +37,7 @@ ___ • **flowActions**: *string[]* -*Defined in [src/core/mst-operations.ts:858](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L858)* +*Defined in [src/core/mst-operations.ts:858](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L858)* ___ @@ -47,7 +47,7 @@ ___ *Inherited from [IModelReflectionPropertiesData](imodelreflectionpropertiesdata.md).[name](imodelreflectionpropertiesdata.md#name)* -*Defined in [src/core/mst-operations.ts:825](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L825)* +*Defined in [src/core/mst-operations.ts:825](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L825)* ___ @@ -57,7 +57,7 @@ ___ *Inherited from [IModelReflectionPropertiesData](imodelreflectionpropertiesdata.md).[properties](imodelreflectionpropertiesdata.md#properties)* -*Defined in [src/core/mst-operations.ts:826](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L826)* +*Defined in [src/core/mst-operations.ts:826](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L826)* #### Type declaration: @@ -69,7 +69,7 @@ ___ • **views**: *string[]* -*Defined in [src/core/mst-operations.ts:856](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L856)* +*Defined in [src/core/mst-operations.ts:856](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L856)* ___ @@ -77,4 +77,4 @@ ___ • **volatile**: *string[]* -*Defined in [src/core/mst-operations.ts:857](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L857)* +*Defined in [src/core/mst-operations.ts:857](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L857)* diff --git a/docs/API/interfaces/imodelreflectionpropertiesdata.md b/docs/API/interfaces/imodelreflectionpropertiesdata.md index 31fe84f0b..40c683e29 100644 --- a/docs/API/interfaces/imodelreflectionpropertiesdata.md +++ b/docs/API/interfaces/imodelreflectionpropertiesdata.md @@ -4,7 +4,7 @@ title: "IModelReflectionPropertiesData" sidebar_label: "IModelReflectionPropertiesData" --- -[mobx-state-tree - v6.0.0](../index.md) › [IModelReflectionPropertiesData](imodelreflectionpropertiesdata.md) +[mobx-state-tree - v6.0.1](../index.md) › [IModelReflectionPropertiesData](imodelreflectionpropertiesdata.md) ## Hierarchy @@ -25,7 +25,7 @@ sidebar_label: "IModelReflectionPropertiesData" • **name**: *string* -*Defined in [src/core/mst-operations.ts:825](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L825)* +*Defined in [src/core/mst-operations.ts:825](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L825)* ___ @@ -33,7 +33,7 @@ ___ • **properties**: *object* -*Defined in [src/core/mst-operations.ts:826](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L826)* +*Defined in [src/core/mst-operations.ts:826](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L826)* #### Type declaration: diff --git a/docs/API/interfaces/imodeltype.md b/docs/API/interfaces/imodeltype.md index 264243627..4e866dee4 100644 --- a/docs/API/interfaces/imodeltype.md +++ b/docs/API/interfaces/imodeltype.md @@ -4,7 +4,7 @@ title: "IModelType" sidebar_label: "IModelType" --- -[mobx-state-tree - v6.0.0](../index.md) › [IModelType](imodeltype.md) +[mobx-state-tree - v6.0.1](../index.md) › [IModelType](imodeltype.md) ## Type parameters @@ -55,7 +55,7 @@ sidebar_label: "IModelType" *Inherited from [IType](itype.md).[identifierAttribute](itype.md#optional-identifierattribute)* -*Defined in [src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L89)* +*Defined in [src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L89)* Name of the identifier attribute or null if none. @@ -67,7 +67,7 @@ ___ *Inherited from [IType](itype.md).[name](itype.md#name)* -*Defined in [src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L84)* +*Defined in [src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L84)* Friendly type name. @@ -77,7 +77,7 @@ ___ • **properties**: *PROPS* -*Defined in [src/types/complex-types/model.ts:190](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L190)* +*Defined in [src/types/complex-types/model.ts:194](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L194)* ## Methods @@ -85,7 +85,7 @@ ___ ▸ **actions**<**A**>(`fn`: function): *[IModelType](imodeltype.md)‹PROPS, OTHERS & A, CustomC, CustomS›* -*Defined in [src/types/complex-types/model.ts:204](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L204)* +*Defined in [src/types/complex-types/model.ts:208](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L208)* **Type parameters:** @@ -113,7 +113,7 @@ ___ *Inherited from [IType](itype.md).[create](itype.md#create)* -*Defined in [src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L96)* +*Defined in [src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L96)* Creates an instance for the type given an snapshot input. @@ -136,7 +136,7 @@ ___ *Inherited from [IType](itype.md).[describe](itype.md#describe)* -*Defined in [src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L118)* +*Defined in [src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L118)* Gets the textual representation of the type as a string. @@ -148,7 +148,7 @@ ___ ▸ **extend**<**A**, **V**, **VS**>(`fn`: function): *[IModelType](imodeltype.md)‹PROPS, OTHERS & A & V & VS, CustomC, CustomS›* -*Defined in [src/types/complex-types/model.ts:212](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L212)* +*Defined in [src/types/complex-types/model.ts:216](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L216)* **Type parameters:** @@ -180,7 +180,7 @@ ___ *Inherited from [IType](itype.md).[is](itype.md#is)* -*Defined in [src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L104)* +*Defined in [src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L104)* Checks if a given snapshot / instance is of the given type. @@ -200,7 +200,7 @@ ___ ▸ **named**(`newName`: string): *[IModelType](imodeltype.md)‹PROPS, OTHERS, CustomC, CustomS›* -*Defined in [src/types/complex-types/model.ts:192](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L192)* +*Defined in [src/types/complex-types/model.ts:196](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L196)* **Parameters:** @@ -216,7 +216,7 @@ ___ ▸ **postProcessSnapshot**<**NewS**>(`fn`: function): *[IModelType](imodeltype.md)‹PROPS, OTHERS, CustomC, NewS›* -*Defined in [src/types/complex-types/model.ts:220](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L220)* +*Defined in [src/types/complex-types/model.ts:224](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L224)* **Type parameters:** @@ -242,7 +242,7 @@ ___ ▸ **preProcessSnapshot**<**NewC**>(`fn`: function): *[IModelType](imodeltype.md)‹PROPS, OTHERS, NewC, CustomS›* -*Defined in [src/types/complex-types/model.ts:216](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L216)* +*Defined in [src/types/complex-types/model.ts:220](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L220)* **Type parameters:** @@ -268,7 +268,7 @@ ___ ▸ **props**<**PROPS2**>(`props`: PROPS2): *[IModelType](imodeltype.md)‹PROPS & ModelPropertiesDeclarationToProperties‹PROPS2›, OTHERS, CustomC, CustomS›* -*Defined in [src/types/complex-types/model.ts:196](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L196)* +*Defined in [src/types/complex-types/model.ts:200](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L200)* **Type parameters:** @@ -290,7 +290,7 @@ ___ *Inherited from [IType](itype.md).[validate](itype.md#validate)* -*Defined in [src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L113)* +*Defined in [src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L113)* Run's the type's typechecker on the given value with the given validation context. @@ -311,7 +311,7 @@ ___ ▸ **views**<**V**>(`fn`: function): *[IModelType](imodeltype.md)‹PROPS, OTHERS & V, CustomC, CustomS›* -*Defined in [src/types/complex-types/model.ts:200](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L200)* +*Defined in [src/types/complex-types/model.ts:204](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L204)* **Type parameters:** @@ -337,7 +337,7 @@ ___ ▸ **volatile**<**TP**>(`fn`: function): *[IModelType](imodeltype.md)‹PROPS, OTHERS & TP, CustomC, CustomS›* -*Defined in [src/types/complex-types/model.ts:208](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/complex-types/model.ts#L208)* +*Defined in [src/types/complex-types/model.ts:212](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/complex-types/model.ts#L212)* **Type parameters:** diff --git a/docs/API/interfaces/ipatchrecorder.md b/docs/API/interfaces/ipatchrecorder.md index 330a7d36f..19035da7e 100644 --- a/docs/API/interfaces/ipatchrecorder.md +++ b/docs/API/interfaces/ipatchrecorder.md @@ -4,7 +4,7 @@ title: "IPatchRecorder" sidebar_label: "IPatchRecorder" --- -[mobx-state-tree - v6.0.0](../index.md) › [IPatchRecorder](ipatchrecorder.md) +[mobx-state-tree - v6.0.1](../index.md) › [IPatchRecorder](ipatchrecorder.md) ## Hierarchy @@ -32,7 +32,7 @@ sidebar_label: "IPatchRecorder" • **inversePatches**: *ReadonlyArray‹[IJsonPatch](ijsonpatch.md)›* -*Defined in [src/core/mst-operations.ts:137](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L137)* +*Defined in [src/core/mst-operations.ts:137](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L137)* ___ @@ -40,7 +40,7 @@ ___ • **patches**: *ReadonlyArray‹[IJsonPatch](ijsonpatch.md)›* -*Defined in [src/core/mst-operations.ts:136](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L136)* +*Defined in [src/core/mst-operations.ts:136](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L136)* ___ @@ -48,7 +48,7 @@ ___ • **recording**: *boolean* -*Defined in [src/core/mst-operations.ts:139](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L139)* +*Defined in [src/core/mst-operations.ts:139](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L139)* ___ @@ -56,7 +56,7 @@ ___ • **reversedInversePatches**: *ReadonlyArray‹[IJsonPatch](ijsonpatch.md)›* -*Defined in [src/core/mst-operations.ts:138](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L138)* +*Defined in [src/core/mst-operations.ts:138](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L138)* ## Methods @@ -64,7 +64,7 @@ ___ ▸ **replay**(`target?`: IAnyStateTreeNode): *void* -*Defined in [src/core/mst-operations.ts:142](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L142)* +*Defined in [src/core/mst-operations.ts:142](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L142)* **Parameters:** @@ -80,7 +80,7 @@ ___ ▸ **resume**(): *void* -*Defined in [src/core/mst-operations.ts:141](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L141)* +*Defined in [src/core/mst-operations.ts:141](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L141)* **Returns:** *void* @@ -90,7 +90,7 @@ ___ ▸ **stop**(): *void* -*Defined in [src/core/mst-operations.ts:140](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L140)* +*Defined in [src/core/mst-operations.ts:140](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L140)* **Returns:** *void* @@ -100,7 +100,7 @@ ___ ▸ **undo**(`target?`: IAnyStateTreeNode): *void* -*Defined in [src/core/mst-operations.ts:143](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/mst-operations.ts#L143)* +*Defined in [src/core/mst-operations.ts:143](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/mst-operations.ts#L143)* **Parameters:** diff --git a/docs/API/interfaces/ireversiblejsonpatch.md b/docs/API/interfaces/ireversiblejsonpatch.md index f70d191d4..b4481c963 100644 --- a/docs/API/interfaces/ireversiblejsonpatch.md +++ b/docs/API/interfaces/ireversiblejsonpatch.md @@ -4,7 +4,7 @@ title: "IReversibleJsonPatch" sidebar_label: "IReversibleJsonPatch" --- -[mobx-state-tree - v6.0.0](../index.md) › [IReversibleJsonPatch](ireversiblejsonpatch.md) +[mobx-state-tree - v6.0.1](../index.md) › [IReversibleJsonPatch](ireversiblejsonpatch.md) ## Hierarchy @@ -27,7 +27,7 @@ sidebar_label: "IReversibleJsonPatch" • **oldValue**: *any* -*Defined in [src/core/json-patch.ts:14](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/json-patch.ts#L14)* +*Defined in [src/core/json-patch.ts:14](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/json-patch.ts#L14)* ___ @@ -37,7 +37,7 @@ ___ *Inherited from [IJsonPatch](ijsonpatch.md).[op](ijsonpatch.md#op)* -*Defined in [src/core/json-patch.ts:8](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/json-patch.ts#L8)* +*Defined in [src/core/json-patch.ts:8](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/json-patch.ts#L8)* ___ @@ -47,7 +47,7 @@ ___ *Inherited from [IJsonPatch](ijsonpatch.md).[path](ijsonpatch.md#path)* -*Defined in [src/core/json-patch.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/json-patch.ts#L9)* +*Defined in [src/core/json-patch.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/json-patch.ts#L9)* ___ @@ -57,4 +57,4 @@ ___ *Inherited from [IJsonPatch](ijsonpatch.md).[value](ijsonpatch.md#optional-value)* -*Defined in [src/core/json-patch.ts:10](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/json-patch.ts#L10)* +*Defined in [src/core/json-patch.ts:10](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/json-patch.ts#L10)* diff --git a/docs/API/interfaces/iserializedactioncall.md b/docs/API/interfaces/iserializedactioncall.md index a0903d478..f7d363e10 100644 --- a/docs/API/interfaces/iserializedactioncall.md +++ b/docs/API/interfaces/iserializedactioncall.md @@ -4,7 +4,7 @@ title: "ISerializedActionCall" sidebar_label: "ISerializedActionCall" --- -[mobx-state-tree - v6.0.0](../index.md) › [ISerializedActionCall](iserializedactioncall.md) +[mobx-state-tree - v6.0.1](../index.md) › [ISerializedActionCall](iserializedactioncall.md) ## Hierarchy @@ -24,7 +24,7 @@ sidebar_label: "ISerializedActionCall" • **args**? : *any[]* -*Defined in [src/middlewares/on-action.ts:33](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/on-action.ts#L33)* +*Defined in [src/middlewares/on-action.ts:33](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/on-action.ts#L33)* ___ @@ -32,7 +32,7 @@ ___ • **name**: *string* -*Defined in [src/middlewares/on-action.ts:31](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/on-action.ts#L31)* +*Defined in [src/middlewares/on-action.ts:31](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/on-action.ts#L31)* ___ @@ -40,4 +40,4 @@ ___ • **path**? : *undefined | string* -*Defined in [src/middlewares/on-action.ts:32](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/middlewares/on-action.ts#L32)* +*Defined in [src/middlewares/on-action.ts:32](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/middlewares/on-action.ts#L32)* diff --git a/docs/API/interfaces/isimpletype.md b/docs/API/interfaces/isimpletype.md index 286014c06..69bf914b3 100644 --- a/docs/API/interfaces/isimpletype.md +++ b/docs/API/interfaces/isimpletype.md @@ -4,7 +4,7 @@ title: "ISimpleType" sidebar_label: "ISimpleType" --- -[mobx-state-tree - v6.0.0](../index.md) › [ISimpleType](isimpletype.md) +[mobx-state-tree - v6.0.1](../index.md) › [ISimpleType](isimpletype.md) A simple type, this is, a type where the instance and the snapshot representation are the same. @@ -40,7 +40,7 @@ A simple type, this is, a type where the instance and the snapshot representatio *Inherited from [IType](itype.md).[identifierAttribute](itype.md#optional-identifierattribute)* -*Defined in [src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L89)* +*Defined in [src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L89)* Name of the identifier attribute or null if none. @@ -52,7 +52,7 @@ ___ *Inherited from [IType](itype.md).[name](itype.md#name)* -*Defined in [src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L84)* +*Defined in [src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L84)* Friendly type name. @@ -64,7 +64,7 @@ Friendly type name. *Inherited from [IType](itype.md).[create](itype.md#create)* -*Defined in [src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L96)* +*Defined in [src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L96)* Creates an instance for the type given an snapshot input. @@ -87,7 +87,7 @@ ___ *Inherited from [IType](itype.md).[describe](itype.md#describe)* -*Defined in [src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L118)* +*Defined in [src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L118)* Gets the textual representation of the type as a string. @@ -101,7 +101,7 @@ ___ *Inherited from [IType](itype.md).[is](itype.md#is)* -*Defined in [src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L104)* +*Defined in [src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L104)* Checks if a given snapshot / instance is of the given type. @@ -123,7 +123,7 @@ ___ *Inherited from [IType](itype.md).[validate](itype.md#validate)* -*Defined in [src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L113)* +*Defined in [src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L113)* Run's the type's typechecker on the given value with the given validation context. diff --git a/docs/API/interfaces/isnapshotprocessor.md b/docs/API/interfaces/isnapshotprocessor.md index afce80093..17e9fe98f 100644 --- a/docs/API/interfaces/isnapshotprocessor.md +++ b/docs/API/interfaces/isnapshotprocessor.md @@ -4,7 +4,7 @@ title: "ISnapshotProcessor" sidebar_label: "ISnapshotProcessor" --- -[mobx-state-tree - v6.0.0](../index.md) › [ISnapshotProcessor](isnapshotprocessor.md) +[mobx-state-tree - v6.0.1](../index.md) › [ISnapshotProcessor](isnapshotprocessor.md) A type that has its snapshots processed. @@ -44,7 +44,7 @@ A type that has its snapshots processed. *Inherited from [IType](itype.md).[identifierAttribute](itype.md#optional-identifierattribute)* -*Defined in [src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L89)* +*Defined in [src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L89)* Name of the identifier attribute or null if none. @@ -56,7 +56,7 @@ ___ *Inherited from [IType](itype.md).[name](itype.md#name)* -*Defined in [src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L84)* +*Defined in [src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L84)* Friendly type name. @@ -68,7 +68,7 @@ Friendly type name. *Inherited from [IType](itype.md).[create](itype.md#create)* -*Defined in [src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L96)* +*Defined in [src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L96)* Creates an instance for the type given an snapshot input. @@ -91,7 +91,7 @@ ___ *Inherited from [IType](itype.md).[describe](itype.md#describe)* -*Defined in [src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L118)* +*Defined in [src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L118)* Gets the textual representation of the type as a string. @@ -105,7 +105,7 @@ ___ *Inherited from [IType](itype.md).[is](itype.md#is)* -*Defined in [src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L104)* +*Defined in [src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L104)* Checks if a given snapshot / instance is of the given type. @@ -127,7 +127,7 @@ ___ *Inherited from [IType](itype.md).[validate](itype.md#validate)* -*Defined in [src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L113)* +*Defined in [src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L113)* Run's the type's typechecker on the given value with the given validation context. diff --git a/docs/API/interfaces/isnapshotprocessors.md b/docs/API/interfaces/isnapshotprocessors.md index 57d961d2a..08419b791 100644 --- a/docs/API/interfaces/isnapshotprocessors.md +++ b/docs/API/interfaces/isnapshotprocessors.md @@ -4,7 +4,7 @@ title: "ISnapshotProcessors" sidebar_label: "ISnapshotProcessors" --- -[mobx-state-tree - v6.0.0](../index.md) › [ISnapshotProcessors](isnapshotprocessors.md) +[mobx-state-tree - v6.0.1](../index.md) › [ISnapshotProcessors](isnapshotprocessors.md) Snapshot processors. @@ -33,7 +33,7 @@ Snapshot processors. ▸ **postProcessor**(`snapshot`: IT["SnapshotType"], `node`: [Instance](../index.md#instance)‹IT›): *CustomS* -*Defined in [src/types/utility-types/snapshotProcessor.ts:211](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/snapshotProcessor.ts#L211)* +*Defined in [src/types/utility-types/snapshotProcessor.ts:211](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/snapshotProcessor.ts#L211)* Function that transforms an output snapshot. @@ -52,7 +52,7 @@ ___ ▸ **preProcessor**(`snapshot`: CustomC): *IT["CreationType"]* -*Defined in [src/types/utility-types/snapshotProcessor.ts:206](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/snapshotProcessor.ts#L206)* +*Defined in [src/types/utility-types/snapshotProcessor.ts:206](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/snapshotProcessor.ts#L206)* Function that transforms an input snapshot. diff --git a/docs/API/interfaces/itype.md b/docs/API/interfaces/itype.md index 8a808fd02..afc7638f1 100644 --- a/docs/API/interfaces/itype.md +++ b/docs/API/interfaces/itype.md @@ -4,7 +4,7 @@ title: "IType" sidebar_label: "IType" --- -[mobx-state-tree - v6.0.0](../index.md) › [IType](itype.md) +[mobx-state-tree - v6.0.1](../index.md) › [IType](itype.md) A type, either complex or simple. @@ -50,7 +50,7 @@ A type, either complex or simple. • **identifierAttribute**? : *undefined | string* -*Defined in [src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L89)* +*Defined in [src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L89)* Name of the identifier attribute or null if none. @@ -60,7 +60,7 @@ ___ • **name**: *string* -*Defined in [src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L84)* +*Defined in [src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L84)* Friendly type name. @@ -70,7 +70,7 @@ Friendly type name. ▸ **create**(`snapshot?`: [C](undefined), `env?`: any): *this["Type"]* -*Defined in [src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L96)* +*Defined in [src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L96)* Creates an instance for the type given an snapshot input. @@ -91,7 +91,7 @@ ___ ▸ **describe**(): *string* -*Defined in [src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L118)* +*Defined in [src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L118)* Gets the textual representation of the type as a string. @@ -103,7 +103,7 @@ ___ ▸ **is**(`thing`: any): *thing is C | this["Type"]* -*Defined in [src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L104)* +*Defined in [src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L104)* Checks if a given snapshot / instance is of the given type. @@ -123,7 +123,7 @@ ___ ▸ **validate**(`thing`: C, `context`: [IValidationContext](../index.md#ivalidationcontext)): *[IValidationResult](../index.md#ivalidationresult)* -*Defined in [src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type.ts#L113)* +*Defined in [src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type.ts#L113)* Run's the type's typechecker on the given value with the given validation context. diff --git a/docs/API/interfaces/ivalidationcontextentry.md b/docs/API/interfaces/ivalidationcontextentry.md index 6ca6b043f..f9e676769 100644 --- a/docs/API/interfaces/ivalidationcontextentry.md +++ b/docs/API/interfaces/ivalidationcontextentry.md @@ -4,7 +4,7 @@ title: "IValidationContextEntry" sidebar_label: "IValidationContextEntry" --- -[mobx-state-tree - v6.0.0](../index.md) › [IValidationContextEntry](ivalidationcontextentry.md) +[mobx-state-tree - v6.0.1](../index.md) › [IValidationContextEntry](ivalidationcontextentry.md) Validation context entry, this is, where the validation should run against which type @@ -25,7 +25,7 @@ Validation context entry, this is, where the validation should run against which • **path**: *string* -*Defined in [src/core/type/type-checker.ts:17](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type-checker.ts#L17)* +*Defined in [src/core/type/type-checker.ts:17](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type-checker.ts#L17)* Subpath where the validation should be run, or an empty string to validate it all @@ -35,6 +35,6 @@ ___ • **type**: *[IAnyType](ianytype.md)* -*Defined in [src/core/type/type-checker.ts:19](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type-checker.ts#L19)* +*Defined in [src/core/type/type-checker.ts:19](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type-checker.ts#L19)* Type to validate the subpath against diff --git a/docs/API/interfaces/ivalidationerror.md b/docs/API/interfaces/ivalidationerror.md index ec0cf74e3..d8fcbb010 100644 --- a/docs/API/interfaces/ivalidationerror.md +++ b/docs/API/interfaces/ivalidationerror.md @@ -4,7 +4,7 @@ title: "IValidationError" sidebar_label: "IValidationError" --- -[mobx-state-tree - v6.0.0](../index.md) › [IValidationError](ivalidationerror.md) +[mobx-state-tree - v6.0.1](../index.md) › [IValidationError](ivalidationerror.md) Type validation error @@ -26,7 +26,7 @@ Type validation error • **context**: *[IValidationContext](../index.md#ivalidationcontext)* -*Defined in [src/core/type/type-checker.ts:28](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type-checker.ts#L28)* +*Defined in [src/core/type/type-checker.ts:28](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type-checker.ts#L28)* Validation context @@ -36,7 +36,7 @@ ___ • **message**? : *undefined | string* -*Defined in [src/core/type/type-checker.ts:32](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type-checker.ts#L32)* +*Defined in [src/core/type/type-checker.ts:32](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type-checker.ts#L32)* Error message @@ -46,6 +46,6 @@ ___ • **value**: *any* -*Defined in [src/core/type/type-checker.ts:30](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/core/type/type-checker.ts#L30)* +*Defined in [src/core/type/type-checker.ts:30](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/core/type/type-checker.ts#L30)* Value that was being validated, either a snapshot or an instance diff --git a/docs/API/interfaces/referenceoptionsgetset.md b/docs/API/interfaces/referenceoptionsgetset.md index 4b6bb876f..5d4092142 100644 --- a/docs/API/interfaces/referenceoptionsgetset.md +++ b/docs/API/interfaces/referenceoptionsgetset.md @@ -4,7 +4,7 @@ title: "ReferenceOptionsGetSet" sidebar_label: "ReferenceOptionsGetSet" --- -[mobx-state-tree - v6.0.0](../index.md) › [ReferenceOptionsGetSet](referenceoptionsgetset.md) +[mobx-state-tree - v6.0.1](../index.md) › [ReferenceOptionsGetSet](referenceoptionsgetset.md) ## Type parameters @@ -27,7 +27,7 @@ sidebar_label: "ReferenceOptionsGetSet" ▸ **get**(`identifier`: [ReferenceIdentifier](../index.md#referenceidentifier), `parent`: IAnyStateTreeNode | null): *ReferenceT‹IT›* -*Defined in [src/types/utility-types/reference.ts:442](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/reference.ts#L442)* +*Defined in [src/types/utility-types/reference.ts:444](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/reference.ts#L444)* **Parameters:** @@ -44,7 +44,7 @@ ___ ▸ **set**(`value`: ReferenceT‹IT›, `parent`: IAnyStateTreeNode | null): *[ReferenceIdentifier](../index.md#referenceidentifier)* -*Defined in [src/types/utility-types/reference.ts:443](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/reference.ts#L443)* +*Defined in [src/types/utility-types/reference.ts:445](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/reference.ts#L445)* **Parameters:** diff --git a/docs/API/interfaces/referenceoptionsoninvalidated.md b/docs/API/interfaces/referenceoptionsoninvalidated.md index ea05946a3..3aa008321 100644 --- a/docs/API/interfaces/referenceoptionsoninvalidated.md +++ b/docs/API/interfaces/referenceoptionsoninvalidated.md @@ -4,7 +4,7 @@ title: "ReferenceOptionsOnInvalidated" sidebar_label: "ReferenceOptionsOnInvalidated" --- -[mobx-state-tree - v6.0.0](../index.md) › [ReferenceOptionsOnInvalidated](referenceoptionsoninvalidated.md) +[mobx-state-tree - v6.0.1](../index.md) › [ReferenceOptionsOnInvalidated](referenceoptionsoninvalidated.md) ## Type parameters @@ -26,4 +26,4 @@ sidebar_label: "ReferenceOptionsOnInvalidated" • **onInvalidated**: *[OnReferenceInvalidated](../index.md#onreferenceinvalidated)‹ReferenceT‹IT››* -*Defined in [src/types/utility-types/reference.ts:448](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/reference.ts#L448)* +*Defined in [src/types/utility-types/reference.ts:450](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/reference.ts#L450)* diff --git a/docs/API/interfaces/unionoptions.md b/docs/API/interfaces/unionoptions.md index beac4a916..b911222ef 100644 --- a/docs/API/interfaces/unionoptions.md +++ b/docs/API/interfaces/unionoptions.md @@ -4,7 +4,7 @@ title: "UnionOptions" sidebar_label: "UnionOptions" --- -[mobx-state-tree - v6.0.0](../index.md) › [UnionOptions](unionoptions.md) +[mobx-state-tree - v6.0.1](../index.md) › [UnionOptions](unionoptions.md) ## Hierarchy @@ -23,7 +23,7 @@ sidebar_label: "UnionOptions" • **dispatcher**? : *[ITypeDispatcher](../index.md#itypedispatcher)* -*Defined in [src/types/utility-types/union.ts:26](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/union.ts#L26)* +*Defined in [src/types/utility-types/union.ts:26](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/union.ts#L26)* ___ @@ -31,4 +31,4 @@ ___ • **eager**? : *undefined | false | true* -*Defined in [src/types/utility-types/union.ts:25](https://github.com/mobxjs/mobx-state-tree/blob/030cb3bb/src/types/utility-types/union.ts#L25)* +*Defined in [src/types/utility-types/union.ts:25](https://github.com/mobxjs/mobx-state-tree/blob/7097c4d6/src/types/utility-types/union.ts#L25)* diff --git a/package.json b/package.json index 750cfef1e..f0dbc6866 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mobx-state-tree", - "version": "6.0.0", + "version": "6.0.1", "description": "Opinionated, transactional, MobX powered state container", "main": "dist/mobx-state-tree.js", "umd:main": "dist/mobx-state-tree.umd.js", diff --git a/website/i18n/en.json b/website/i18n/en.json index 59b0635ff..fe76787c0 100644 --- a/website/i18n/en.json +++ b/website/i18n/en.json @@ -9,7 +9,7 @@ "title": "API_header" }, "API/index": { - "title": "mobx-state-tree - v6.0.0", + "title": "mobx-state-tree - v6.0.1", "sidebar_label": "Globals" }, "API/interfaces/customtypeoptions": {