Interface ObjectMapper

The ObjectMapper interface defines the methods for converting between plain javascript objects and class instances.

This is an abstraction that allows the data layer to be decoupled from the underlying object mapper implementation.

interface ObjectMapper {
    applyPropertyValue(
        object: object,
        key: string,
        value: object | Primitive | PrimitiveArray | object[],
    ): void;
    fromArray<T>(cls: ClassConstructor<T>, array: object[]): T[];
    fromObject<T>(cls: ClassConstructor<T>, object: object): T;
    toArray<T>(data: T[]): object[];
    toFlatKeyMap(data: object): Map<string, string>;
    toObject<T>(data: T): object;
}

Implemented by

CTObjectMapper

Index

Methods

applyPropertyValue fromArray fromObject toArray toFlatKeyMap toObject

Methods

applyPropertyValue

applyPropertyValue(
    object: object,
    key: string,
    value: object | Primitive | PrimitiveArray | object[],
): void
Sets the value of a property on an object hierarchy as specified by the key.
Parameters
- object: object
- key: string
  The key specifying the property to set.
- value: object | Primitive | PrimitiveArray | object[]
  The value to set.
Returns void
- Defined in src/data/mapper/api/object-mapper.ts:62

fromArray

fromArray<T>(cls: ClassConstructor<T>, array: object[]): T[]
Converts an array of plain javascript objects into an array of instances of the specified class.
Type Parameters
- T
Parameters
- cls: ClassConstructor<T>
  The desired class of the resulting object instances.
- array: object[]
Returns T[]
Throws
ObjectMappingError if the mapping or a type conversion fails.
- Defined in src/data/mapper/api/object-mapper.ts:37

fromObject

fromObject<T>(cls: ClassConstructor<T>, object: object): T
Converts a plain javascript object into an instance of the specified class.
Type Parameters
- T
Parameters
- cls: ClassConstructor<T>
  The desired class of the resulting object instance.
- object: object
Returns T
Throws
ObjectMappingError if the mapping or a type conversion fails.
- Defined in src/data/mapper/api/object-mapper.ts:20

toArray

toArray<T>(data: T[]): object[]
Converts an array of instances of a class into an array of plain javascript objects.
Type Parameters
- T
Parameters
- data: T[]
  The array of object instances to be converted.
Returns object[]
Throws
ObjectMappingError if the mapping or a type conversion fails.
- Defined in src/data/mapper/api/object-mapper.ts:45

toFlatKeyMap

toFlatKeyMap(data: object): Map<string, string>
Converts a plain javascript object into a flat Map of key-value pairs.
Parameters
- data: object
  The plain javascript object to be converted.
Returns Map<string, string>
A Map of key-value pairs.
- Defined in src/data/mapper/api/object-mapper.ts:53

toObject

toObject<T>(data: T): object
Converts an instance of a class into a plain javascript object.
Type Parameters
- T
Parameters
- data: T
  The object instance to be converted.
Returns object
Throws
ObjectMappingError if the mapping or a type conversion fails.
- Defined in src/data/mapper/api/object-mapper.ts:28

Interface ObjectMapper

Implemented by

Index

Methods

Methods

applyPropertyValue

Parameters

Returns void

fromArray

Type Parameters

Parameters

Returns T[]

Throws

fromObject

Type Parameters

Parameters

Returns T

Throws

toArray

Type Parameters

Parameters

Returns object[]

Throws

toFlatKeyMap

Parameters

Returns Map<string, string>

toObject

Type Parameters

Parameters

Returns object

Throws

Settings

On This Page