Skip to content
This repository was archived by the owner on Jun 16, 2021. It is now read-only.

Latest commit

 

History

History
666 lines (389 loc) · 18 KB

ifakemodel.md

File metadata and controls

666 lines (389 loc) · 18 KB

redux-data-service > IFakeModel

Interface: IFakeModel

Type parameters

T

T

T

Hierarchy

IModel<IFakeModelData>

IFakeModelData

↳ IFakeModel

Implemented by

Index

Properties

Methods


Properties

<Optional> changes

● changes: Partial<IFakeModelData>

Inherited from IModelMeta.changes

Defined in Model/IModel.ts:26


dateDeleted

● dateDeleted: Date

Inherited from IModelData.dateDeleted

Overrides IModelData.dateDeleted

Defined in Model/IModel.ts:13


dateUpdated

● dateUpdated: Date

Inherited from IModelData.dateUpdated

Overrides IModelData.dateUpdated

Defined in Model/IModel.ts:12


errors

● errors: IModelKeys<IFakeModelData>

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


fullText

● fullText: string

Inherited from IFakeModelData.fullText

Defined in Model/Model.mock.ts:26


hasUnsavedChanges

● hasUnsavedChanges: boolean

Inherited from IModel.hasUnsavedChanges

Defined in Model/IModel.ts:34


id

● id: string

Inherited from IModelData.id

Overrides 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

Inherited from IModel.isDirty

Defined in Model/IModel.ts:33


isLoading

● isLoading: boolean

Inherited from IModelMeta.isLoading

Defined in Model/IModel.ts:25


isNew

● isNew: boolean

Inherited from IModel.isNew

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

Overrides IModelData.parentIdFieldName

Defined in Model/IModel.ts:15


<Optional> parentModelId

● parentModelId: string

Inherited from IModel.parentModelId

Defined in Model/IModel.ts:37


<Optional> parentServiceName

● parentServiceName: string

Inherited from IModelData.parentServiceName

Overrides 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

Overrides IModelData.serializeThroughParent

Defined in Model/IModel.ts:16


serviceName

● serviceName: string

Inherited from IModel.serviceName

Defined in Model/IModel.ts:36


validationRules

● validationRules: IModelKeys<T>

Inherited from 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<IFakeModelData>, meta?: Partial<IModelMeta<IFakeModelData>>, relationships?: any): IModel<IFakeModelData>

Inherited from IModel.applyUpdates

Defined in Model/IModel.ts:46

Parameters:

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

Returns: IModel<IFakeModelData>


forceReload

forceReload(): void

Inherited from IModel.forceReload

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

Inherited from IModel.getFieldError

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>

Inherited from IModel.getServiceForRelationship

Defined in Model/IModel.ts:51

Parameters:

Name Type
relationshipKey string

Returns: DataService<any>


initializeNewModel

initializeNewModel(): void

Inherited from IModel.initializeNewModel

Defined in Model/IModel.ts:47

Returns: void


isFieldDirty

isFieldDirty(fieldName: * keyof IFakeModelData | string*): boolean

Inherited from IModel.isFieldDirty

Defined in Model/IModel.ts:48

Parameters:

Name Type
fieldName keyof IFakeModelData | string

Returns: boolean


markForDestruction

markForDestruction(): void

Inherited from IModel.markForDestruction

Defined in Model/IModel.ts:49

Returns: void


original

original(): this

Inherited from IModel.original

Defined in Model/IModel.ts:53

Returns: this


parseFieldValue

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

Inherited from IModel.parseFieldValue

Defined in Model/IModel.ts:50

Parameters:

Name Type
fieldName string
value any

Returns: Promise<any>


reset

reset(): void

Inherited from IModel.reset

Defined in Model/IModel.ts:43

Returns: void


save

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

Inherited from IModel.save

Defined in Model/IModel.ts:38

Parameters:

Name Type
Optional progressObserver Subscriber<any>

Returns: Promise<IModel<IFakeModelData>>


saveModel

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

Inherited from IModel.saveModel

Defined in Model/IModel.ts:39

Parameters:

Name Type
Optional progressObserver Subscriber<any>

Returns: Promise<IModel<IFakeModelData>>


saveRelatedModels

saveRelatedModels(): Promise<IModel<IFakeModelData>[]>

Inherited from IModel.saveRelatedModels

Defined in Model/IModel.ts:40

Returns: Promise<IModel<IFakeModelData>[]>


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

Inherited from IModel.unload

Defined in Model/IModel.ts:44

Returns: void


validate

validate(): IModelKeys<IFakeModelData>

Inherited from IModel.validate

Overrides IValidate.validate

Defined in Model/IModel.ts:41

Returns: IModelKeys<IFakeModelData>


validateField

validateField(fieldName: string): IModelKeys<IFakeModelData>

Inherited from IModel.validateField

Defined in Model/IModel.ts:42

Parameters:

Name Type
fieldName string

Returns: IModelKeys<IFakeModelData>