Interface: Mapper
Interface: Mapper API reference from @automapper/core.
Defined in: packages/core/src/lib/types.ts:165
Properties
[ERROR_HANDLER]
[ERROR_HANDLER]:
ErrorHandler
Defined in: packages/core/src/lib/types.ts:305
[MAPPINGS]
[MAPPINGS]:
Map<MetadataIdentifier<any>,Map<MetadataIdentifier<any>,Mapping<any,any>>>
Defined in: packages/core/src/lib/types.ts:306
[METADATA_MAP]
[METADATA_MAP]:
Map<MetadataIdentifier<any>,Metadata[]>
Defined in: packages/core/src/lib/types.ts:309
[METADATA_OBJECT_MAP]
[METADATA_OBJECT_MAP]:
Map<MetadataIdentifier<any>, [Record<string,unknown>,Record<string,unknown>]>
Defined in: packages/core/src/lib/types.ts:310
[NAMING_CONVENTIONS]
[NAMING_CONVENTIONS]:
NamingConventionInput
Defined in: packages/core/src/lib/types.ts:308
[PROFILE_CONFIGURATION_CONTEXT]
[PROFILE_CONFIGURATION_CONTEXT]:
Set<MappingConfiguration<any,any>>
Defined in: packages/core/src/lib/types.ts:319
[RECURSIVE_COUNT]
[RECURSIVE_COUNT]:
Map<MetadataIdentifier<any>,ArrayKeyedMap>
Defined in: packages/core/src/lib/types.ts:318
[RECURSIVE_DEPTH]
[RECURSIVE_DEPTH]:
Map<MetadataIdentifier<any>,ArrayKeyedMap>
Defined in: packages/core/src/lib/types.ts:317
[STRATEGY]
[STRATEGY]:
MappingStrategy<MetadataIdentifier<any>>
Defined in: packages/core/src/lib/types.ts:307
Methods
dispose()
dispose():
void
Defined in: packages/core/src/lib/types.ts:303
Returns
void
map()
Call Signature
map<
TSource,TDestination>(sourceObject,sourceIdentifier,destinationIdentifier,options?):TDestination
Defined in: packages/core/src/lib/types.ts:166
Type Parameters
TSource
TSource extends Dictionary<TSource>
TDestination
TDestination extends Dictionary<TDestination>
Parameters
sourceObject
TSource
sourceIdentifier
ModelIdentifier<TSource>
destinationIdentifier
ModelIdentifier<TDestination>
options?
MapOptions<TSource, TDestination, Record<string, unknown>>
Returns
TDestination
Call Signature
map<
TSource>(sourceObject,identifier,options?):TSource
Defined in: packages/core/src/lib/types.ts:175
Type Parameters
TSource
TSource extends Dictionary<TSource>
Parameters
sourceObject
TSource
identifier
ModelIdentifier<TSource>
options?
MapOptions<TSource, TSource, Record<string, unknown>>
Returns
TSource
mapArray()
Call Signature
mapArray<
TSource,TDestination>(sourceArray,sourceIdentifier,destinationIdentifier,options?):TDestination[]
Defined in: packages/core/src/lib/types.ts:205
Type Parameters
TSource
TSource extends Dictionary<TSource>
TDestination
TDestination extends Dictionary<TDestination>
Parameters
sourceArray
TSource[]
sourceIdentifier
ModelIdentifier<TSource>
destinationIdentifier
ModelIdentifier<TDestination>
options?
MapOptions<TSource[], TDestination[], Record<string, unknown>>
Returns
TDestination[]
Call Signature
mapArray<
TSource>(sourceArray,identifier,options?):TSource[]
Defined in: packages/core/src/lib/types.ts:214
Type Parameters
TSource
TSource extends Dictionary<TSource>
Parameters
sourceArray
TSource[]
identifier
ModelIdentifier<TSource>
options?
MapOptions<TSource[], TSource[], Record<string, unknown>>
Returns
TSource[]
mapArrayAsync()
Call Signature
mapArrayAsync<
TSource,TDestination>(sourceArray,sourceIdentifier,destinationIdentifier,options?):Promise<TDestination[]>
Defined in: packages/core/src/lib/types.ts:220
Type Parameters
TSource
TSource extends Dictionary<TSource>
TDestination
TDestination extends Dictionary<TDestination>
Parameters
sourceArray
TSource[]
sourceIdentifier
ModelIdentifier<TSource>
destinationIdentifier
ModelIdentifier<TDestination>
options?
MapOptions<TSource[], TDestination[], Record<string, unknown>>
Returns
Promise<TDestination[]>
Call Signature
mapArrayAsync<
TSource>(sourceArray,identifier,options?):Promise<TSource[]>
Defined in: packages/core/src/lib/types.ts:229
Type Parameters
TSource
TSource extends Dictionary<TSource>
Parameters
sourceArray
TSource[]
identifier
ModelIdentifier<TSource>
options?
MapOptions<TSource[], TSource[], Record<string, unknown>>
Returns
Promise<TSource[]>
mapAsync()
Call Signature
mapAsync<
TSource,TDestination>(sourceObject,sourceIdentifier,destinationIdentifier,options?):Promise<TDestination>
Defined in: packages/core/src/lib/types.ts:190
Maps sourceObject and resolves with the result.
Type Parameters
TSource
TSource extends Dictionary<TSource>
TDestination
TDestination extends Dictionary<TDestination>
Parameters
sourceObject
TSource
sourceIdentifier
ModelIdentifier<TSource>
destinationIdentifier
ModelIdentifier<TDestination>
options?
MapOptions<TSource, TDestination, Record<string, unknown>>
Returns
Promise<TDestination>
Remarks
Member mapping itself is synchronous, but any beforeMap/afterMap
callbacks that return a promise are collected and awaited before the
returned promise resolves. Use the synchronous map when no async
callbacks are involved.
Call Signature
mapAsync<
TSource>(sourceObject,identifier,options?):Promise<TSource>
Defined in: packages/core/src/lib/types.ts:199
Type Parameters
TSource
TSource extends Dictionary<TSource>
Parameters
sourceObject
TSource
identifier
ModelIdentifier<TSource>
options?
MapOptions<TSource, TSource, Record<string, unknown>>
Returns
Promise<TSource>
mutate()
Call Signature
mutate<
TSource,TDestination>(sourceObject,destinationObject,sourceIdentifier,destinationIdentifier,options?):void
Defined in: packages/core/src/lib/types.ts:235
Type Parameters
TSource
TSource extends Dictionary<TSource>
TDestination
TDestination extends Dictionary<TDestination>
Parameters
sourceObject
TSource
destinationObject
TDestination
sourceIdentifier
ModelIdentifier<TSource>
destinationIdentifier
ModelIdentifier<TDestination>
options?
MapOptions<TSource, TDestination, Record<string, unknown>>
Returns
void
Call Signature
mutate<
TSource>(sourceObject,destinationObject,identifier,options?):void
Defined in: packages/core/src/lib/types.ts:245
Type Parameters
TSource
TSource extends Dictionary<TSource>
Parameters
sourceObject
TSource
destinationObject
TSource
identifier
ModelIdentifier<TSource>
options?
MapOptions<TSource, TSource, Record<string, unknown>>
Returns
void
mutateArray()
Call Signature
mutateArray<
TSource,TDestination>(sourceArray,destinationArray,sourceIdentifier,destinationIdentifier,options?):void
Defined in: packages/core/src/lib/types.ts:269
Type Parameters
TSource
TSource extends Dictionary<TSource>
TDestination
TDestination extends Dictionary<TDestination>
Parameters
sourceArray
TSource[]
destinationArray
TDestination[]
sourceIdentifier
ModelIdentifier<TSource>
destinationIdentifier
ModelIdentifier<TDestination>
options?
MapOptions<TSource[], TDestination[], Record<string, unknown>>
Returns
void
Call Signature
mutateArray<
TSource>(sourceArray,destinationArray,identifier,options?):void
Defined in: packages/core/src/lib/types.ts:279
Type Parameters
TSource
TSource extends Dictionary<TSource>
Parameters
sourceArray
TSource[]
destinationArray
TSource[]
identifier
ModelIdentifier<TSource>
options?
MapOptions<TSource[], TSource[], Record<string, unknown>>
Returns
void
mutateArrayAsync()
Call Signature
mutateArrayAsync<
TSource,TDestination>(sourceArray,destinationArray,sourceIdentifier,destinationIdentifier,options?):Promise<void>
Defined in: packages/core/src/lib/types.ts:286
Type Parameters
TSource
TSource extends Dictionary<TSource>
TDestination
TDestination extends Dictionary<TDestination>
Parameters
sourceArray
TSource[]
destinationArray
TDestination[]
sourceIdentifier
ModelIdentifier<TSource>
destinationIdentifier
ModelIdentifier<TDestination>
options?
MapOptions<TSource[], TDestination[], Record<string, unknown>>
Returns
Promise<void>
Call Signature
mutateArrayAsync<
TSource>(sourceArray,destinationArray,identifier,options?):Promise<void>
Defined in: packages/core/src/lib/types.ts:296
Type Parameters
TSource
TSource extends Dictionary<TSource>
Parameters
sourceArray
TSource[]
destinationArray
TSource[]
identifier
ModelIdentifier<TSource>
options?
MapOptions<TSource[], TSource[], Record<string, unknown>>
Returns
Promise<void>
mutateAsync()
Call Signature
mutateAsync<
TSource,TDestination>(sourceObject,destinationObject,sourceIdentifier,destinationIdentifier,options?):Promise<void>
Defined in: packages/core/src/lib/types.ts:252
Type Parameters
TSource
TSource extends Dictionary<TSource>
TDestination
TDestination extends Dictionary<TDestination>
Parameters
sourceObject
TSource
destinationObject
TDestination
sourceIdentifier
ModelIdentifier<TSource>
destinationIdentifier
ModelIdentifier<TDestination>
options?
MapOptions<TSource, TDestination, Record<string, unknown>>
Returns
Promise<void>
Call Signature
mutateAsync<
TSource>(sourceObject,destinationObject,identifier,options?):Promise<void>
Defined in: packages/core/src/lib/types.ts:262
Type Parameters
TSource
TSource extends Dictionary<TSource>
Parameters
sourceObject
TSource
destinationObject
TSource
identifier
ModelIdentifier<TSource>
options?
MapOptions<TSource, TSource, Record<string, unknown>>
Returns
Promise<void>