Class BaseModel<TProps, FromSnapshotOverride, ToSnapshotOverride, ModelIdPropertyName>Abstract

constructor

• new BaseModel<
      TProps extends ModelProps,
      FromSnapshotOverride extends Record<string, any>,
      ToSnapshotOverride extends Record<string, any>,
      ModelIdPropertyName extends string = never,
  >(
      data: ModelPropsToTransformedCreationData<TProps>,
  ): BaseModel<
      TProps,
      FromSnapshotOverride,
      ToSnapshotOverride,
      ModelIdPropertyName,
  >

  Creates an instance of a model.

  Type Parameters

  • TProps extends ModelProps
  • FromSnapshotOverride extends Record<string, any>
  • ToSnapshotOverride extends Record<string, any>
  • ModelIdPropertyName extends string = never

  Parameters

  • data: ModelPropsToTransformedCreationData<TProps>

  Returns BaseModel<TProps, FromSnapshotOverride, ToSnapshotOverride, ModelIdPropertyName>

[fromSnapshotOverrideTypeSymbol]

[modelIdPropertyNameSymbol]

[propsTypeSymbol]

[toSnapshotOverrideTypeSymbol]

Readonly$

Readonly$modelType

$modelId

• get $modelId(): ModelIdPropertyType<TProps, ModelIdPropertyName>

  Model internal id. Can be modified inside a model action. It will return undefined if there's no id prop set.

  Returns ModelIdPropertyType<TProps, ModelIdPropertyName>
• set $modelId(newId: ModelIdPropertyType<TProps, ModelIdPropertyName>): void

  Parameters

  • newId: ModelIdPropertyType<TProps, ModelIdPropertyName>

  Returns void

getRefId

• getRefId(): undefined | string

  Can be overridden to offer a reference id to be used in reference resolution. By default it will use the idProp if available or return undefined otherwise.

  Returns undefined | string

toString

• toString(options?: { withData?: boolean }): string

  Parameters

  • Optionaloptions: { withData?: boolean }

  Returns string

typeCheck

• typeCheck(): null | TypeCheckError

  Performs a type check over the model instance. For this to work a data type has to be declared as part of the model properties.

  Returns null | TypeCheckError

  A TypeCheckError or null if there is no error.