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

Latest commit

 

History

History
1013 lines (578 loc) · 32.6 KB

fakemodel.md

File metadata and controls

1013 lines (578 loc) · 32.6 KB

redux-data-service > FakeModel

Class: FakeModel

Hierarchy

Model<IFakeModelData>

↳ FakeModel

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

⊕ new FakeModel(modelData: * Partial<IFakeModelData> & object*, meta?: Partial<IModelMeta<IFakeModelData>>, relatedModels?: IModelsMap): FakeModel

Inherited from Model.constructor

Defined in Model/Model.ts:105

Parameters:

Name Type Default value
modelData Partial<IFakeModelData> & object -
Default value meta Partial<IModelMeta<IFakeModelData>> {}
Default value relatedModels IModelsMap {}

Returns: FakeModel

Properties

dateDeleted

● dateDeleted: Date

Implementation of IFakeModel.dateDeleted

Inherited from Model.dateDeleted

Defined in Model/Model.ts:84

dateUpdated

● dateUpdated: Date

Implementation of IFakeModel.dateUpdated

Inherited from Model.dateUpdated

Defined in Model/Model.ts:81

fields

● fields: IModelKeys< IFakeModelData & any, IFieldType<any>>

Implementation of IFakeModel.fields

Inherited from Model.fields

Defined in Model/Model.ts:73

fullText

● fullText: string

Implementation of IFakeModel.fullText

Defined in Model/Model.mock.ts:14

id

● id: string

Implementation of IFakeModel.id

Inherited from Model.id

Defined in Model/Model.ts:78

<Protected> meta

● meta: IModelMeta<IFakeModelData>

Inherited from Model.meta

Defined in Model/Model.ts:104

<Protected> modelData

● modelData: Partial<IFakeModelData>

Inherited from Model.modelData

Defined in Model/Model.ts:103

parentIdFieldName

● parentIdFieldName: string

Implementation of IFakeModel.parentIdFieldName

Inherited from Model.parentIdFieldName

Defined in Model/Model.ts:93

parentServiceName

● parentServiceName: any

Implementation of IFakeModel.parentServiceName

Inherited from Model.parentServiceName

Defined in Model/Model.ts:90

<Protected> relatedModels

● relatedModels: IModelsMap

Inherited from Model.relatedModels

Defined in Model/Model.ts:105

relationships

● relationships: object

Implementation of IFakeModel.relationships

Inherited from Model.relationships

Defined in Model/Model.ts:75

Type declaration

serializeThroughParent

● serializeThroughParent: boolean

Implementation of IFakeModel.serializeThroughParent

Inherited from Model.serializeThroughParent

Defined in Model/Model.ts:87

serviceName

● serviceName: string = "fakeModel"

Implementation of IFakeModel.serviceName

Overrides Model.serviceName

Defined in Model/Model.mock.ts:11

validationRules

● validationRules: IModelKeys<IFakeModelData>

Implementation of IFakeModel.validationRules

Inherited from Model.validationRules

Defined in Model/Model.ts:74

Accessors

errors

geterrors(): objectseterrors(value: object): void

Inherited from Model.errors

Defined in Model/Model.ts:664

Get the list of errors, which may have been created from calling this.validate() or as a response from the API.

Returns: object

Inherited from Model.errors

Defined in Model/Model.ts:673

Dispatch an action to Redux to set the error state of the Model.

Parameters:

Name Type Description
value object

Returns: void

hasUnsavedChanges

gethasUnsavedChanges(): boolean

Inherited from Model.hasUnsavedChanges

Defined in Model/Model.ts:704

Determine if the model or its previously loaded relationships have unsaved changes.

Returns: boolean

isDestroying

getisDestroying(): boolean

Inherited from Model.isDestroying

Defined in Model/Model.ts:591

Determine if the current instance of the Model has been marked for destruction. That is, this instance is being removed from the Redux store and its subscriptions are being torn down.

Returns: boolean

isDirty

getisDirty(): boolean

Inherited from Model.isDirty

Defined in Model/Model.ts:682

Determine if the Model's data has changed without being saved.

Returns: boolean

isLoading

getisLoading(): booleansetisLoading(value: boolean): void

Inherited from Model.isLoading

Defined in Model/Model.ts:635

Determine if the Model is currently loading.

Returns: boolean

Inherited from Model.isLoading

Defined in Model/Model.ts:644

Dispatch an action to Redux to set the isLoading state of the Model

Parameters:

Name Type Description
value boolean

Returns: void

isNew

getisNew(): boolean

Inherited from Model.isNew

Defined in Model/Model.ts:715

Determine if the Model is a new object which has not been committed to the API yet.

Returns: boolean

isShadow

getisShadow(): boolean

Inherited from Model.isShadow

Defined in Model/Model.ts:654

Determine if the Model is a "shadow" object: its data is currently being loaded and this instance of the Model is used as a temporary placeholder until we get a response from the API.

Returns: boolean

parentModelId

getparentModelId(): anysetparentModelId(value: any): void

Inherited from Model.parentModelId

Defined in Model/Model.ts:95

Returns: any

Inherited from Model.parentModelId

Defined in Model/Model.ts:99

Parameters:

Name Type
value any

Returns: void

Methods

applyUpdates

▸ applyUpdates(changes?: Partial<IFakeModelData>, meta?: Partial<IModelMeta<IFakeModelData>>, relatedModels?: any): IModel<IFakeModelData>

Implementation of IFakeModel.applyUpdates

Inherited from Model.applyUpdates

Defined in Model/Model.ts:351

Since this class is meant to be immutable, you can apply new updates here. The changes will be deep merged with the existing modelData and/or meta, and a new instance of the class will be returned with those values without mutating the current instance of the class.

Note that this is applied locally. Chances are you will want to dispatch an action instead, via one of the magic setters (so your components will know to update).

Parameters:

Name Type Default value
Default value changes Partial<IFakeModelData> {}
Default value meta Partial<IModelMeta<IFakeModelData>> {}
Default value relatedModels any {}

Returns: IModel<IFakeModelData>

<Protected> checkFieldUpdateIsAllowed

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

Inherited from Model.checkFieldUpdateIsAllowed

Defined in Model/Model.ts:408

Throw a TypeError if the provided key is an invalid fieldType, or the value is an invalid type for that fieldType.

Parameters:

Name Type Description
key any -
value any

Returns: void

delete

▸ delete(): Promise<IModel<IFakeModelData>>

Inherited from Model.delete

Defined in Model/Model.ts:286

Dispatch an action to Redux to delete the Model

Returns: Promise<IModel<IFakeModelData>>

forceReload

▸ forceReload(): void

Implementation of IFakeModel.forceReload

Inherited from Model.forceReload

Defined in Model/Model.ts:334

Dispatch an action to the DataService to force it to reload the model from the API.

Returns: void

getData

▸ getData(): object

Defined in Model/Model.mock.ts:16

Returns: object

getField

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

Inherited from Model.getField

Defined in Model/Model.ts:391

This method is called by the magic getters for the properties decorated by the @attr decorator. The actual data for the decorated properties is stored in modelData.

Parameters:

Name Type Description
fieldName string -
Optional defaultValue any -

Returns: any

getFieldError

▸ getFieldError(fieldName: any): any

Inherited from Model.getFieldError

Defined in Model/Model.ts:726

Parameters:

Name Type
fieldName any

Returns: any

getRelated

▸ getRelated(fieldName: string): any

Inherited from Model.getRelated

Defined in Model/Model.ts:450

This method is called by the magic getters for the properties decorated by the @belongsTo and @hasMany decorators.

It will use the relationship definition created by the decorator to grab the DataService of the related field and return an Observable which provides the corresponding item or items.

If the content has not been loaded yet, the DataService will dispatch an action to load the data.

Parameters:

Name Type Description
fieldName string -

Returns: any

getServiceForRelationship

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

Implementation of IFakeModel.getServiceForRelationship

Inherited from Model.getServiceForRelationship

Defined in Model/Model.ts:551

Get the DataService associated to the relationship specified at the given name of the related field

Parameters:

Name Type Description
relationshipKey string -

Returns: DataService<any>

<Protected> getValidationRulesForField

▸ getValidationRulesForField(fieldName: any): any

Inherited from Model.getValidationRulesForField

Defined in Model/Model.ts:275

Get the validationRules for the given fieldName. Works with local or nested fields.

Parameters:

Name Type Description
fieldName any -

Returns: any

getWillDestroyObservable$

▸ getWillDestroyObservable$(): Observable<boolean>

Inherited from Model.getWillDestroyObservable$

Defined in Model/Model.ts:601

Subscribe to this Observable to be notified when the current instance of the Model has been marked for destruction. That is, this instance is being removed from the Redux store and its subscriptions are being torn down.

Returns: Observable<boolean>

initializeNewModel

▸ initializeNewModel(): void

Implementation of IFakeModel.initializeNewModel

Inherited from Model.initializeNewModel

Defined in Model/Model.ts:379

This is a useful hook for doing model-specific initialization when creating a new, unsaved model, such as creating related Models and setting default session values.

Returns: void

isFieldDirty

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

Implementation of IFakeModel.isFieldDirty

Inherited from Model.isFieldDirty

Defined in Model/Model.ts:691

Determine if a specific model field of the Model's data has changed without being saved.

Parameters:

Name Type
fieldName keyof IFakeModelData | string

Returns: boolean

markForDestruction

▸ markForDestruction(): void

Implementation of IFakeModel.markForDestruction

Inherited from Model.markForDestruction

Defined in Model/Model.ts:575

Call this method just before this Model instance will be removed from the Redux store. This allows us to cleanly unsubscribe to any relationship Observables that were previously subscribed to, in order to avoid a possible memory leak.

Returns: void

original

▸ original(): this

Implementation of IFakeModel.original

Inherited from Model.original

Defined in Model/Model.ts:720

Create a clone of the model without any of the unsaved changes

Returns: this

parseFieldValue

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

Implementation of IFakeModel.parseFieldValue

Inherited from Model.parseFieldValue

Defined in Model/Model.ts:739

Given a fieldName as a deep path (such as "firstName" or "person.firstName"), this will use that field's own IFieldType.normalize function to parse the given value.

Parameters:

Name Type
fieldName string
value any

Returns: Promise<any>

reset

▸ reset(): void

Implementation of IFakeModel.reset

Inherited from Model.reset

Defined in Model/Model.ts:306

Dispatch an action to Redux to reset the Model to its original state. Note: new items will be removed from the Redux store.

Returns: void

save

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

Implementation of IFakeModel.save

Inherited from Model.save

Defined in Model/Model.ts:129

Dispatch an action to Redux to commit the pending changes to the API.

Returns a promise which resolves with the new Model on success, or the error response on failure. If there were no changes, it will resolve immediately with the current instance of the Model.

Will reject with validation errors if model is invalid.

Parameters:

Name Type
Optional progressSubscriber Subscriber<any>

Returns: Promise<IModel<IFakeModelData>>

saveModel

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

Implementation of IFakeModel.saveModel

Inherited from Model.saveModel

Defined in Model/Model.ts:158

Dispatch an action to Redux to commit the pending changes to the API for just this model, without first saving any related models with pending changes (unless they're serialized with this model).

Returns a promise which resolves with the new Model on success, or the error response on failure.

If this model was loaded initially as a nested model, and the parent is marked to serialize this model, then saving this model will instead save the parent model.

Note that this method does not validate the model or check if it has pending changes. You probably want to use the save() method instead.

Parameters:

Name Type
Optional progressSubscriber Subscriber<any>

Returns: Promise<IModel<any>>

saveRelatedModels

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

Implementation of IFakeModel.saveRelatedModels

Inherited from Model.saveRelatedModels

Defined in Model/Model.ts:195

Dispatch an action to Redux to commit the pending changes to the API for any of the related models which have already been loaded and would not be serialized when this model is saved. After each model is saved, its new copy is set onto a new copy this model.

Returns a promise which resolves with each of the new models.

Note that this method does not validate the related models before it saves them.

Returns: Promise<IModel<IFakeModelData>[]>

setField

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

Inherited from Model.setField

Defined in Model/Model.ts:430

This method is called by the magic setters for the properties decorated by the @attr decorator.

Since this class is meant to be immutable, attempting to set on a property will actually dispatch an action to Redux, where a new instance of the Model will be created and stored.

The current instance of the Model will not be mutated!

Parameters:

Name Type Description
fieldName string -
value any

Returns: void

setMetaField

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

Inherited from Model.setMetaField

Defined in Model/Model.ts:621

This method is called by the magic setters for some of the meta properties.

Since this class is meant to be immutable, attempting to set on a property will actually dispatch an action to Redux, where a new instance of the Model will be created and stored.

Parameters:

Name Type Description
fieldName any -
value any

Returns: void

setRelated

▸ setRelated(fieldName: string, value: any): void

Inherited from Model.setRelated

Defined in Model/Model.ts:521

This method is called by the magic setters for the properties decorated by the @belongsTo and @hasMany decorators.

Since the class is meant to be immutable, the related item or items will not be set directly on this instance. Instead, the magic setter for the related field on this class (which tracks the relationship) will be called with the ID or IDs of the value provided, which will dispatch an action to the DataService.

Parameters:

Name Type Description
fieldName string -
value any

Returns: void

<Protected> triggerWillDestroyObservable

▸ triggerWillDestroyObservable(): void

Inherited from Model.triggerWillDestroyObservable

Defined in Model/Model.ts:564

This is an internal method which will tell the WillDestroyObservable to emit a value

Returns: void

unload

▸ unload(): void

Implementation of IFakeModel.unload

Inherited from Model.unload

Defined in Model/Model.ts:323

Dispatch an action to Redux to remove this Model from its data store.

Returns: void

validate

▸ validate(includeRelatedModels?: boolean): IModelKeys<IFakeModelData>

Inherited from Model.validate

Defined in Model/Model.ts:221

Perform client-side validation on the Model based on the validationRules as defined by property decorators. The validation results will be returned immediately and dispatched to Redux.

We currently use Validate.JS as our validation library.

If includeRelatedModels is set to true, any related model on this model which has been loaded previously will be validated as well. The keys for the validation results of nested models will be flattened with "." separator

Parameters:

Name Type Default value Description
Default value includeRelatedModels boolean false -

Returns: IModelKeys<IFakeModelData>

validateField

▸ validateField(fieldName: any): any

Inherited from Model.validateField

Defined in Model/Model.ts:251

Perform client-side validation on the Model based on the validationRules as defined for the given fieldName. The field's validation results will be returned immediately and dispatched to Redux.

Note: this works with nested paths (such as "person.firstName") in addition to fields local to the model.

Parameters:

Name Type Description
fieldName any -

Returns: any