AutoMapper | automapper-nartc

Hierarchy

AutoMapperBase
- AutoMapper

Index

Constructors

constructor

new AutoMapper(): AutoMapper

Overrides AutoMapperBase.constructor
- Defined in automapper.ts:46
Returns AutoMapper

Properties

Protected _mappings

_mappings: object

Type declaration

[key: string]: Mapping

Private _profiles

_profiles: object

Type declaration

[key: string]: MappingProfile

Static Private _instance

_instance: AutoMapper = new AutoMapper()

Methods

Private _createMapForMember

_createMapForMember<TSource, TDestination>(mapping: Mapping<TSource, TDestination>, key: keyof TDestination, fn: ForMemberExpression<TSource, TDestination>, fluentFunctions: CreateMapFluentFunctions<TSource, TDestination>): CreateMapFluentFunctions<TSource, TDestination>

- Defined in automapper.ts:272
Type parameters
- TSource: __type
- TDestination: __type
Parameters
- mapping: Mapping<TSource, TDestination>
- key: keyof TDestination
- fn: ForMemberExpression<TSource, TDestination>
- fluentFunctions: CreateMapFluentFunctions<TSource, TDestination>
Returns CreateMapFluentFunctions<TSource, TDestination>

Private _createMapForPath

_createMapForPath<TDestination, TSource>(mapping: Mapping<TDestination, TSource>, key: keyof TSource, fn: ForMemberExpression<TDestination, TSource>, fluentFunctions: CreateReverseMapFluentFunctions<TDestination, TSource>): CreateReverseMapFluentFunctions<TDestination, TSource>

- Defined in automapper.ts:350
Type parameters
- TDestination: __type
- TSource: __type
Parameters
- mapping: Mapping<TDestination, TSource>
- key: keyof TSource
- fn: ForMemberExpression<TDestination, TSource>
- fluentFunctions: CreateReverseMapFluentFunctions<TDestination, TSource>
Returns CreateReverseMapFluentFunctions<TDestination, TSource>

Private _createMappingFluentFunctions

_createMappingFluentFunctions<TSource, TDestination>(mapping: Mapping<TSource, TDestination>): CreateMapFluentFunctions<TSource, TDestination>

- Defined in automapper.ts:241
Type parameters
- TSource: __type
- TDestination: __type
Parameters
- mapping: Mapping<TSource, TDestination>
Returns CreateMapFluentFunctions<TSource, TDestination>

Protected _createMappingObject

_createMappingObject<TSource, TDestination>(source: Constructable<TSource>, destination: Constructable<TDestination>): Mapping<TSource, TDestination>

Inherited from AutoMapperBase._createMappingObject
- Defined in base.ts:339
Type parameters
- TSource: object
- TDestination: object
Parameters
- source: Constructable<TSource>
- destination: Constructable<TDestination>
Returns Mapping<TSource, TDestination>

Private _createReverseMap

_createReverseMap<TSource, TDestination>(mapping: Mapping<TSource, TDestination>): CreateReverseMapFluentFunctions<TDestination, TSource>

- Defined in automapper.ts:330
Type parameters
- TSource: __type
- TDestination: __type
Parameters
- mapping: Mapping<TSource, TDestination>
Returns CreateReverseMapFluentFunctions<TDestination, TSource>

Protected _createReverseMappingObject

_createReverseMappingObject<TSource, TDestination>(mapping: Mapping<TSource, TDestination>): Mapping<TDestination, TSource>

Inherited from AutoMapperBase._createReverseMappingObject
- Defined in base.ts:362
Type parameters
- TSource: object
- TDestination: object
Parameters
- mapping: Mapping<TSource, TDestination>
Returns Mapping<TDestination, TSource>

Protected _dispose

_dispose(): void

Inherited from AutoMapperBase._dispose
- Defined in base.ts:459
Returns void

Protected _getKeyFromMemberFn

_getKeyFromMemberFn<T>(fn: ForPathDestinationFn<T>): keyof T

Inherited from AutoMapperBase._getKeyFromMemberFn
- Defined in base.ts:401
Type parameters
- T: object
Parameters
- fn: ForPathDestinationFn<T>
Returns keyof T

Protected _getMapping

_getMapping<TSource, TDestination>(source: Constructable<TSource>, destination: Constructable<TDestination>): Mapping<TSource, TDestination>

Inherited from AutoMapperBase._getMapping
- Defined in base.ts:422
Type parameters
- TSource
- TDestination
Parameters
- source: Constructable<TSource>
- destination: Constructable<TDestination>
Returns Mapping<TSource, TDestination>

Protected _getMappingForDestination

_getMappingForDestination<TSource, TDestination>(destination: Constructable<TDestination>): Mapping<TSource, TDestination>

Inherited from AutoMapperBase._getMappingForDestination
- Defined in base.ts:439
Type parameters
- TSource
- TDestination
Parameters
- destination: Constructable<TDestination>
Returns Mapping<TSource, TDestination>

Protected _map

_map<TSource, TDestination>(sourceObj: TSource, mapping: Mapping<TSource, TDestination>, option?: MapActionOptions<TSource, TDestination>, isArrayMap?: boolean): TDestination

Inherited from AutoMapperBase._map
- Defined in base.ts:80
Type parameters
- TSource: object
- TDestination: object
Parameters
- sourceObj: TSource
- mapping: Mapping<TSource, TDestination>
- Default value option: MapActionOptions<TSource, TDestination> = { beforeMap: undefined, afterMap: undefined }
- Default value isArrayMap: boolean = false
Returns TDestination

Protected _mapArray

_mapArray<TSource, TDestination>(sourceArray: TSource[], mapping: Mapping<TSource, TDestination>, option?: MapActionOptions<TSource[], TDestination[]>): TDestination[]

Inherited from AutoMapperBase._mapArray
- Defined in base.ts:53
Type parameters
- TSource: object
- TDestination: object
Parameters
- sourceArray: TSource[]
- mapping: Mapping<TSource, TDestination>
- Default value option: MapActionOptions<TSource[], TDestination[]> = {beforeMap: undefined,afterMap: undefined}
Returns TDestination[]

Protected _mapArrayAsync

_mapArrayAsync<TSource, TDestination>(sourceArray: TSource[], mapping: Mapping<TSource, TDestination>, option?: MapActionOptions<TSource[], TDestination[]>): Promise<TDestination[]>

Inherited from AutoMapperBase._mapArrayAsync
- Defined in base.ts:303
Type parameters
- TSource: object
- TDestination: object
Parameters
- sourceArray: TSource[]
- mapping: Mapping<TSource, TDestination>
- Default value option: MapActionOptions<TSource[], TDestination[]> = {beforeMap: undefined,afterMap: undefined}
Returns Promise<TDestination[]>

Protected _mapAsync

_mapAsync<TSource, TDestination>(sourceObj: TSource, mapping: Mapping<TSource, TDestination>, option?: MapActionOptions<TSource, TDestination>): Promise<TDestination>

Inherited from AutoMapperBase._mapAsync
- Defined in base.ts:289
Type parameters
- TSource: object
- TDestination: object
Parameters
- sourceObj: TSource
- mapping: Mapping<TSource, TDestination>
- Default value option: MapActionOptions<TSource, TDestination> = {beforeMap: undefined,afterMap: undefined}
Returns Promise<TDestination>

addProfile

addProfile(profile: MappingProfile): AutoMapper

- Defined in automapper.ts:207
Add MappingProfile to the current instance of AutoMapper

Parameters
- profile: MappingProfile
  
  Profile being added
Returns AutoMapper

createMap

createMap<TSource, TDestination>(source: Constructable<TSource>, destination: Constructable<TDestination>): CreateMapFluentFunctions<TSource, TDestination>

- Defined in automapper.ts:223
Create a mapping between Source and Destination without initializing the Mapper

Type parameters
- TSource: __type
- TDestination: __type
Parameters
- source: Constructable<TSource>
  
  the Source model
- destination: Constructable<TDestination>
  
  the Destination model
Returns CreateMapFluentFunctions<TSource, TDestination>

dispose

dispose(): void

- Defined in automapper.ts:234
Dispose Mappings and Profiles created on the Mapper singleton

Returns void

Protected getTransformationType

getTransformationType<TSource, TDestination>(forMemberFn: ForMemberExpression<TSource, TDestination>): TransformationType

Inherited from AutoMapperBase.getTransformationType
- Defined in base.ts:25
Type parameters
- TSource: object
- TDestination: __type
Parameters
- forMemberFn: ForMemberExpression<TSource, TDestination>
Returns TransformationType

initialize

initialize(configFn: function): void

- Defined in automapper.ts:72
Initialize Mapper
example
```
Mapper.initialize(config => {
  config.addProfile(new Profile());
  config.createMap(Source, Destination);
})
```
Parameters
- configFn: function
  
  Config function callback
  - - (config: Configuration): void
    - Parameters
      - config: Configuration
      Returns void
Returns void

map

map<TSource, TDestination>(sourceObj: TSource, destination: Constructable<TDestination>, option?: MapActionOptions<TSource, TDestination>): TDestination

- Defined in automapper.ts:107
Map from Source to Destination
example
```
const user = new User();
user.firstName = 'John';
user.lastName = 'Doe';

const userVm = Mapper.map(user, UserVm);
```
Type parameters
- TSource: __type
- TDestination: __type
Parameters
- sourceObj: TSource
  
  the sourceObj that are going to be mapped
- destination: Constructable<TDestination>
  
  the Destination model to receive the mapped values
- Optional option: MapActionOptions<TSource, TDestination>
  
  Optional mapping option
Returns TDestination

mapArray

mapArray<TSource, TDestination>(sourceObj: TSource[], destination: Constructable<TDestination>, option?: MapActionOptions<TSource[], TDestination[]>): TDestination[]

- Defined in automapper.ts:164
Map from a list of Source to a list of Destination
example
```
const addresses = [];
addresses.push(new Address(), new Address());

const addressesVm = Mapper.mapArray(addresses, AddressVm);
```
Type parameters
- TSource: __type
- TDestination: __type
Parameters
- sourceObj: TSource[]
  
  the sourceObj that are going to be mapped
- destination: Constructable<TDestination>
  
  the Destination model to receive the mapped values
- Optional option: MapActionOptions<TSource[], TDestination[]>
  
  Optional mapping option
Returns TDestination[]

mapArrayAsync

mapArrayAsync<TSource, TDestination>(sourceObj: TSource[], destination: Constructable<TDestination>, option?: MapActionOptions<TSource[], TDestination[]>): Promise<TDestination[]>

- Defined in automapper.ts:193
Map from a list of Source to a list of Destination async. Mapping operation will be run as a micro task.
example
```
const addresses = [];
addresses.push(new Address(), new Address());

const addressesVm = await Mapper.mapArrayAsync(addresses, AddressVm);
```
Type parameters
- TSource: __type
- TDestination: __type
Parameters
- sourceObj: TSource[]
  
  the sourceObj that are going to be mapped
- destination: Constructable<TDestination>
  
  the Destination model to receive the mapped values
- Optional option: MapActionOptions<TSource[], TDestination[]>
  
  Optional mapping option
Returns Promise<TDestination[]>

Promise that resolves a TDestination[]

mapAsync

mapAsync<TSource, TDestination>(sourceObj: TSource, destination: Constructable<TDestination>, option?: MapActionOptions<TSource, TDestination>): Promise<TDestination>

- Defined in automapper.ts:137
Map from Source to Destination Async. Mapping operation will be run as a micro task.
example
```
const user = new User();
user.firstName = 'John';
user.lastName = 'Doe';

const userVm = await Mapper.mapAsync(user, UserVm);
```
Type parameters
- TSource: __type
- TDestination: __type
Parameters
- sourceObj: TSource
  
  the sourceObj that are going to be mapped
- destination: Constructable<TDestination>
  
  the Destination model to receive the mapped values
- Optional option: MapActionOptions<TSource, TDestination>
  
  Optional mapping option
Returns Promise<TDestination>

Promise that resolves TDestination

Static getInstance

getInstance(): AutoMapper

- Defined in automapper.ts:44
static
- Get the Mapper instance
Returns AutoMapper

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AutoMapper

Properties

Protected _mappings

Type declaration

[key: string]: Mapping

Private _profiles

Type declaration

[key: string]: MappingProfile

Static Private _instance

Methods

Private _createMapForMember

Type parameters

TSource: __type

TDestination: __type

Parameters

mapping: Mapping<TSource, TDestination>

key: keyof TDestination

fn: ForMemberExpression<TSource, TDestination>

fluentFunctions: CreateMapFluentFunctions<TSource, TDestination>

Returns CreateMapFluentFunctions<TSource, TDestination>

Private _createMapForPath

Type parameters

TDestination: __type

TSource: __type

Parameters

mapping: Mapping<TDestination, TSource>

key: keyof TSource

fn: ForMemberExpression<TDestination, TSource>

fluentFunctions: CreateReverseMapFluentFunctions<TDestination, TSource>

Returns CreateReverseMapFluentFunctions<TDestination, TSource>

Private _createMappingFluentFunctions

Type parameters

TSource: __type

TDestination: __type

Parameters

mapping: Mapping<TSource, TDestination>

Returns CreateMapFluentFunctions<TSource, TDestination>

Protected _createMappingObject

Type parameters

TSource: object

TDestination: object

Parameters

source: Constructable<TSource>

destination: Constructable<TDestination>

Returns Mapping<TSource, TDestination>

Private _createReverseMap

Type parameters

TSource: __type

TDestination: __type

Parameters

mapping: Mapping<TSource, TDestination>

Returns CreateReverseMapFluentFunctions<TDestination, TSource>

Protected _createReverseMappingObject

Type parameters

TSource: object

TDestination: object

Parameters

mapping: Mapping<TSource, TDestination>

Returns Mapping<TDestination, TSource>

Protected _dispose

Returns void

Protected _getKeyFromMemberFn

Type parameters

T: object

Parameters

fn: ForPathDestinationFn<T>

Returns keyof T

Protected _getMapping

Type parameters

TSource

TDestination

Parameters

source: Constructable<TSource>