Skip to main content

Function: Model()

Call Signature​

function Model<TProps, A, FS, TS>(fnModelProps, modelOptions?): _Model<unknown, TProps, FS, TS>;

Base abstract class for models.

Never override the constructor, use onInit or onAttachedToRootStore instead.

Type Parameters​

Type ParameterDefault typeDescription
TProps extends ModelProps-Model properties type.
A extends []--
FS extends Record<string, any>never-
TS extends Record<string, any>never-

Parameters​

ParameterTypeDescription
fnModelProps(...args) => TPropsFunction that generates model properties.
modelOptions?ModelOptions<TProps, FS, TS>Model options.

Returns​

_Model<unknown, TProps, FS, TS>

Call Signature​

function Model<TProps, FS, TS>(modelProps, modelOptions?): _Model<unknown, TProps, FS, TS>;

Base abstract class for models.

Never override the constructor, use onInit or onAttachedToRootStore instead.

Type Parameters​

Type ParameterDefault typeDescription
TProps extends ModelProps-Model properties type.
FS extends Record<string, any>never-
TS extends Record<string, any>never-

Parameters​

ParameterTypeDescription
modelPropsTPropsModel properties.
modelOptions?ModelOptions<TProps, FS, TS>Model options.

Returns​

_Model<unknown, TProps, FS, TS>