imodeltype.md

id	title	sidebar_label
imodeltype	IModelType	IModelType

mobx-state-tree - v5.2.0 › IModelType

Type parameters

▪ PROPS: ModelProperties

▪ OTHERS

▪ CustomC

▪ CustomS

Hierarchy

• IType‹ModelCreationType2‹PROPS, CustomC›, ModelSnapshotType2‹PROPS, CustomS›, ModelInstanceType‹PROPS, OTHERS››

  ↳ IModelType

  ↳ IAnyModelType

Index

Properties

• identifierAttribute
• name
• properties

Methods

• actions
• create
• describe
• extend
• is
• named
• postProcessSnapshot
• preProcessSnapshot
• props
• validate
• views
• volatile

Properties

Optional identifierAttribute

• identifierAttribute? : undefined | string

Inherited from IType.identifierAttribute

Defined in packages/mobx-state-tree/src/core/type/type.ts:89

Name of the identifier attribute or null if none.

---

name

• name: string

Inherited from IType.name

Defined in packages/mobx-state-tree/src/core/type/type.ts:84

Friendly type name.

---

properties

• properties: PROPS

Defined in packages/mobx-state-tree/src/types/complex-types/model.ts:187

Methods

actions

▸ actions<A>(fn: function): IModelType‹PROPS, OTHERS & A, CustomC, CustomS›

Defined in packages/mobx-state-tree/src/types/complex-types/model.ts:201

Type parameters:

▪ A: ModelActions

Parameters:

▪ fn: function

▸ (self: Instance‹this›): A

Parameters:

Name	Type
self	Instance‹this›

Returns: IModelType‹PROPS, OTHERS & A, CustomC, CustomS›

---

create

▸ create(snapshot?: C, env?: any): this["Type"]

Inherited from IType.create

Defined in packages/mobx-state-tree/src/core/type/type.ts:96

Creates an instance for the type given an snapshot input.

Parameters:

Name	Type
snapshot?	C
env?	any

Returns: this["Type"]

An instance of that type.

---

describe

▸ describe(): string

Inherited from IType.describe

Defined in packages/mobx-state-tree/src/core/type/type.ts:118

Gets the textual representation of the type as a string.

Returns: string

---

extend

▸ extend<A, V, VS>(fn: function): IModelType‹PROPS, OTHERS & A & V & VS, CustomC, CustomS›

Defined in packages/mobx-state-tree/src/types/complex-types/model.ts:209

Type parameters:

▪ A: ModelActions

▪ V: Object

▪ VS: Object

Parameters:

▪ fn: function

▸ (self: Instance‹this›): object

Parameters:

Name	Type
self	Instance‹this›

Returns: IModelType‹PROPS, OTHERS & A & V & VS, CustomC, CustomS›

---

is

▸ is(thing: any): thing is ModelCreationType2<PROPS, CustomC> | this["Type"]

Inherited from IType.is

Defined in packages/mobx-state-tree/src/core/type/type.ts:104

Checks if a given snapshot / instance is of the given type.

Parameters:

Name	Type	Description
thing	any	Snapshot or instance to be checked.

Returns: thing is ModelCreationType2<PROPS, CustomC> | this["Type"]

true if the value is of the current type, false otherwise.

---

named

▸ named(newName: string): IModelType‹PROPS, OTHERS, CustomC, CustomS›

Defined in packages/mobx-state-tree/src/types/complex-types/model.ts:189

Parameters:

Name	Type
newName	string

Returns: IModelType‹PROPS, OTHERS, CustomC, CustomS›

---

postProcessSnapshot

▸ postProcessSnapshot<NewS>(fn: function): IModelType‹PROPS, OTHERS, CustomC, NewS›

Defined in packages/mobx-state-tree/src/types/complex-types/model.ts:217

Type parameters:

▪ NewS

Parameters:

▪ fn: function

▸ (snapshot: ModelSnapshotType2‹PROPS, CustomS›): NewS

Parameters:

Name	Type
snapshot	ModelSnapshotType2‹PROPS, CustomS›

Returns: IModelType‹PROPS, OTHERS, CustomC, NewS›

---

preProcessSnapshot

▸ preProcessSnapshot<NewC>(fn: function): IModelType‹PROPS, OTHERS, NewC, CustomS›

Defined in packages/mobx-state-tree/src/types/complex-types/model.ts:213

Type parameters:

▪ NewC

Parameters:

▪ fn: function

▸ (snapshot: NewC): ModelCreationType2‹PROPS, CustomC›

Parameters:

Name	Type
snapshot	NewC

Returns: IModelType‹PROPS, OTHERS, NewC, CustomS›

---

props

▸ props<PROPS2>(props: PROPS2): IModelType‹PROPS & ModelPropertiesDeclarationToProperties‹PROPS2›, OTHERS, CustomC, CustomS›

Defined in packages/mobx-state-tree/src/types/complex-types/model.ts:193

Type parameters:

▪ PROPS2: ModelPropertiesDeclaration

Parameters:

Name	Type
props	PROPS2

Returns: IModelType‹PROPS & ModelPropertiesDeclarationToProperties‹PROPS2›, OTHERS, CustomC, CustomS›

---

validate

▸ validate(thing: ModelCreationType2‹PROPS, CustomC›, context: IValidationContext): IValidationResult

Inherited from IType.validate

Defined in packages/mobx-state-tree/src/core/type/type.ts:113

Run's the type's typechecker on the given value with the given validation context.

Parameters:

Name	Type	Description
thing	ModelCreationType2‹PROPS, CustomC›	Value to be checked, either a snapshot or an instance.
context	IValidationContext	Validation context, an array of { subpaths, subtypes } that should be validated

Returns: IValidationResult

The validation result, an array with the list of validation errors.

---

views

▸ views<V>(fn: function): IModelType‹PROPS, OTHERS & V, CustomC, CustomS›

Defined in packages/mobx-state-tree/src/types/complex-types/model.ts:197

Type parameters:

▪ V: Object

Parameters:

▪ fn: function

▸ (self: Instance‹this›): V

Parameters:

Name	Type
self	Instance‹this›

Returns: IModelType‹PROPS, OTHERS & V, CustomC, CustomS›

---

volatile

▸ volatile<TP>(fn: function): IModelType‹PROPS, OTHERS & TP, CustomC, CustomS›

Defined in packages/mobx-state-tree/src/types/complex-types/model.ts:205

Type parameters:

▪ TP: object

Parameters:

▪ fn: function

▸ (self: Instance‹this›): TP

Parameters:

Name	Type
self	Instance‹this›

Returns: IModelType‹PROPS, OTHERS & TP, CustomC, CustomS›