Model | easy-models

Hierarchy

Serializable
- Model

Index

Methods

mergeValue

mergeValue<T>(key: keyof T & string, model: T): void

- Defined in Model.ts:65
By default, this method looks for a merge<Key>FromModel method on the receiver, and invokes it if found. If not found, and model is not null, the value for the given key is taken from model.

Type parameters
- T: Model
Parameters
- key: keyof T & string
  
  the name of the property to merge.
- model: T
  
  the model to merge from.
Returns void

mergeValues

mergeValues<T>(model: T): void

- Defined in Model.ts:93
Merges the values of the given model into the receiver, using Model.mergeValue for each key in Serializable.JSONKeyPaths.

Type parameters
- T: Model
Parameters
- model: T
  
  the model to merge from.
Returns void

toJSON

toJSON(): any

- Defined in Model.ts:154
Serializes a model into an object.

Note: This does not throw the error if it occurs during serialization. Check Model.toObject if you need that.

Returns any

toObject

toObject(): any

- Defined in Model.ts:144
Serializes a model into an object.

Returns any

validate

validate(): boolean

- Defined in Model.ts:114
Validates the model.

The default implementation simply invokes validate<Key> for all keys in Serializable.JSONKeyPaths.

Returns boolean

true if the model is valid, false otherwise.

Static JSONKeyPaths

JSONKeyPaths(): object

Inherited from Serializable.JSONKeyPaths
- Defined in Serializable.ts:35
Specifies how to map property keys to different key paths in JSON.

Values in the object can either be key paths in the JSON representation of the receiver or an array of such key paths. If an array is used, the deserialized value will be an object containing all of the keys in the array.

Any keys omitted will not participate in JSON serialization.
example
```
public static JSONKeyPaths() {
    return {
        name: "POI.name",
        point: ["latitude", "longitude"],
        starred: "starred",
    };
}
```
Returns object
- [key: string]: string | string[]

Static Optional JSONTransformerForKey

JSONTransformerForKey(key: string): ValueTransformer | undefined

Inherited from Serializable.JSONTransformerForKey
- Defined in Serializable.ts:47
Specifies how to convert a JSON value to the given property key. If reversible, the transformer will also be used to convert the property value back to JSON.

If the receiver implements a <key>JSONTransformer method, the result of that method will be used instead.

Parameters
- key: string
  
  the name of the property.
Returns ValueTransformer | undefined

a value transformer, or undefined if no transformation should be performed.

Static Optional classForParsingObject

classForParsingObject<T>(json: any): Newable<T>

Inherited from Serializable.classForParsingObject
- Defined in Serializable.ts:59
Overridden to parse the receiver as a different class, based on information in the provided object.

This is mostly useful for class clusters, where the abstract base class would be passed, but a subclass should be instantiated instead.

Type parameters
- T: Serializable
Parameters
- json: any
  
  object to check the class for.
Returns Newable<T>

the class that should be parsed (which may be the receiver), or undefined to abort parsing (e.g. if the data is invalid).

Static create

create<T>(this: Newable<T>, json: Partial<T>): T | null

- Defined in Model.ts:39
Initializes a model with the given object.

Type parameters
- T: Model
Parameters
- this: Newable<T>
- json: Partial<T>
  
  An object.
Returns T | null

Static from

from<T>(this: Newable<T>, json: any): T | null

- Defined in Model.ts:12
Deserializes a model from an object.

Type parameters
- T: Model
Parameters
- this: Newable<T>
- json: any
  
  An object.
Returns T | null

Static fromArray

fromArray<T>(this: Newable<T>, json: any[]): T[] | null

- Defined in Model.ts:21
Attempts to parse an array of objects into model objects of a specific class.

Type parameters
- T: Model
Parameters
- this: Newable<T>
- json: any[]
  
  An array of objects.
Returns T[] | null

Static toArray

toArray<T>(this: Newable<T>, models: T[]): any[] | null

- Defined in Model.ts:30
Converts an array of models into an object array.

Type parameters
- T: Serializable
Parameters
- this: Newable<T>
- models: T[]
  
  An array of models to use for JSON serialization.
Returns any[] | null

Generated using TypeDoc

Hierarchy

Index

Methods

Methods

mergeValue

Type parameters

T: Model

Parameters

key: keyof T & string

model: T

Returns void

mergeValues

Type parameters

T: Model

Parameters

model: T

Returns void

toJSON

Returns any

toObject

Returns any

validate

Returns boolean

Static JSONKeyPaths

Returns object

[key: string]: string | string[]

Static Optional JSONTransformerForKey

Parameters

key: string

Returns ValueTransformer | undefined

Static Optional classForParsingObject

Type parameters

T: Serializable

Parameters

json: any

Returns Newable<T>

Static create

Type parameters

T: Model

Parameters

this: Newable<T>

json: Partial<T>

Returns T | null

Static from

Type parameters

T: Model

Parameters

this: Newable<T>

json: any

Returns T | null

Static fromArray

Type parameters

T: Model

Parameters

this: Newable<T>

json: any[]

Returns T[] | null

Static toArray

Type parameters

T: Serializable

Parameters

this: Newable<T>

models: T[]

Returns any[] | null