imodel.md

redux-data-service > IModel

Interface: IModel

Type parameters

T : IModelData

T

T

T

T

T

Hierarchy

IModelMeta<T>

IModelData

↳ IAttrs

↳ IRelationship

↳ IModel

↳ IFakeModel

Implemented by

• FakeModel
• Model

Index

Properties

• changes
• dateDeleted
• dateUpdated
• errors
• fields
• hasUnsavedChanges
• id
• isDestroying
• isDirty
• isLoading
• isNew
• isShadow
• parentIdFieldName
• parentModelId
• parentServiceName
• relationships
• serializeThroughParent
• serviceName
• validationRules
• willDestroyObservable$

Methods

• applyUpdates
• forceReload
• getField
• getFieldError
• getRelated
• getServiceForRelationship
• initializeNewModel
• isFieldDirty
• markForDestruction
• original
• parseFieldValue
• reset
• save
• saveModel
• saveRelatedModels
• setField
• setRelated
• unload
• validate
• validateField

---

Properties

<Optional> changes

● changes: Partial<T>

Inherited from IModelMeta.changes

Defined in Model/IModel.ts:26

---

dateDeleted

● dateDeleted: Date

Inherited from IModelData.dateDeleted

Defined in Model/IModel.ts:13

---

dateUpdated

● dateUpdated: Date

Inherited from IModelData.dateUpdated

Defined in Model/IModel.ts:12

---

errors

● errors: IModelKeys<T>

Inherited from IModelMeta.errors

Defined in Model/IModel.ts:27

---

fields

● fields: IModelKeys<T, IFieldType>

Inherited from IAttrs.fields

Overrides IFieldTypes.fields

Defined in Model/Decorators/Attr.ts:11

---

hasUnsavedChanges

● hasUnsavedChanges: boolean

Defined in Model/IModel.ts:34

---

id

● id: string

Inherited from IModelData.id

Defined in Model/IModel.ts:11

---

<Optional> isDestroying

● isDestroying: boolean

Inherited from IModelMeta.isDestroying

Defined in Model/IModel.ts:28

---

isDirty

● isDirty: boolean

Defined in Model/IModel.ts:33

---

isLoading

● isLoading: boolean

Inherited from IModelMeta.isLoading

Defined in Model/IModel.ts:25

---

isNew

● isNew: boolean

Defined in Model/IModel.ts:35

---

isShadow

● isShadow: boolean

Inherited from IModelMeta.isShadow

Defined in Model/IModel.ts:24

---

<Optional> parentIdFieldName

● parentIdFieldName: string

Inherited from IModelData.parentIdFieldName

Defined in Model/IModel.ts:15

---

<Optional> parentModelId

● parentModelId: string

Defined in Model/IModel.ts:37

---

<Optional> parentServiceName

● parentServiceName: string

Inherited from IModelData.parentServiceName

Defined in Model/IModel.ts:14

---

relationships

● relationships: object

Inherited from IRelationship.relationships

Defined in Model/Decorators/Relationship.ts:44

Type declaration

---

<Optional> serializeThroughParent

● serializeThroughParent: boolean

Inherited from IModelData.serializeThroughParent

Defined in Model/IModel.ts:16

---

serviceName

● serviceName: string

Defined in Model/IModel.ts:36

---

validationRules

● validationRules: IModelKeys<T>

Inherited from IValidate.validationRules

Overrides IValidate.validationRules

Defined in Model/Decorators/Validation.ts:6

---

<Optional> willDestroyObservable$

● willDestroyObservable$: Subject<boolean>

Inherited from IModelMeta.willDestroyObservable$

Defined in Model/IModel.ts:29

---

Methods

applyUpdates

▸ applyUpdates(changes?: Partial<T>, meta?: Partial<IModelMeta<T>>, relationships?: any): IModel<T>

Defined in Model/IModel.ts:46

Parameters:

Name	Type
Optional changes	Partial<T>
Optional meta	Partial<IModelMeta<T>>
Optional relationships	any

Returns: IModel<T>

---

forceReload

▸ forceReload(): void

Defined in Model/IModel.ts:45

Returns: void

---

getField

▸ getField(fieldName: any, defaultValue: any): any

Inherited from IAttrs.getField

Defined in Model/Decorators/Attr.ts:12

Parameters:

Name	Type
fieldName	any
defaultValue	any

Returns: any

---

getFieldError

▸ getFieldError(fieldName: string): string | undefined

Defined in Model/IModel.ts:52

Parameters:

Name	Type
fieldName	string

Returns: string | undefined

---

getRelated

▸ getRelated(key: any): any

Inherited from IRelationship.getRelated

Defined in Model/Decorators/Relationship.ts:46

Parameters:

Name	Type
key	any

Returns: any

---

getServiceForRelationship

▸ getServiceForRelationship(relationshipKey: string): DataService<any>

Defined in Model/IModel.ts:51

Parameters:

Name	Type
relationshipKey	string

Returns: DataService<any>

---

initializeNewModel

▸ initializeNewModel(): void

Defined in Model/IModel.ts:47

Returns: void

---

isFieldDirty

▸ isFieldDirty(fieldName: * keyof T | string*): boolean

Defined in Model/IModel.ts:48

Parameters:

Name	Type
fieldName	keyof T | string

Returns: boolean

---

markForDestruction

▸ markForDestruction(): void

Defined in Model/IModel.ts:49

Returns: void

---

original

▸ original(): this

Defined in Model/IModel.ts:53

Returns: this

---

parseFieldValue

▸ parseFieldValue(fieldName: string, value: any): Promise<any>

Defined in Model/IModel.ts:50

Parameters:

Name	Type
fieldName	string
value	any

Returns: Promise<any>

---

reset

▸ reset(): void

Defined in Model/IModel.ts:43

Returns: void

---

save

▸ save(progressObserver?: Subscriber<any>): Promise<IModel<T>>

Defined in Model/IModel.ts:38

Parameters:

Name	Type
Optional progressObserver	Subscriber<any>

Returns: Promise<IModel<T>>

---

saveModel

▸ saveModel(progressObserver?: Subscriber<any>): Promise<IModel<T>>

Defined in Model/IModel.ts:39

Parameters:

Name	Type
Optional progressObserver	Subscriber<any>

Returns: Promise<IModel<T>>

---

saveRelatedModels

▸ saveRelatedModels(): Promise<IModel<T>[]>

Defined in Model/IModel.ts:40

Returns: Promise<IModel<T>[]>

---

setField

▸ setField(fieldName: any, value: any): void

Inherited from IAttrs.setField

Defined in Model/Decorators/Attr.ts:13

Parameters:

Name	Type
fieldName	any
value	any

Returns: void

---

setRelated

▸ setRelated(key: any, value: any): void

Inherited from IRelationship.setRelated

Defined in Model/Decorators/Relationship.ts:48

Parameters:

Name	Type
key	any
value	any

Returns: void

---

unload

▸ unload(): void

Defined in Model/IModel.ts:44

Returns: void

---

validate

▸ validate(): IModelKeys<T>

Overrides IValidate.validate

Defined in Model/IModel.ts:41

Returns: IModelKeys<T>

---

validateField

▸ validateField(fieldName: string): IModelKeys<T>

Defined in Model/IModel.ts:42

Parameters:

Name	Type
fieldName	string

Returns: IModelKeys<T>

---