Skip to main content

Interface: Mapper

Properties

[ERROR_HANDLER]

[ERROR_HANDLER]: ErrorHandler

Defined in

lib/types.ts:279


[MAPPINGS]

[MAPPINGS]: Map<MetadataIdentifier<any>, Map<MetadataIdentifier<any>, Mapping<any, any>>>

Defined in

lib/types.ts:280


[METADATA_MAP]

[METADATA_MAP]: Map<MetadataIdentifier<any>, Metadata[]>

Defined in

lib/types.ts:283


[METADATA_OBJECT_MAP]

[METADATA_OBJECT_MAP]: Map<MetadataIdentifier<any>, [asSource?: Record<string, unknown>, asDestination?: Record<string, unknown>]>

Defined in

lib/types.ts:284


[NAMING_CONVENTIONS]

[NAMING_CONVENTIONS]: NamingConventionInput

Defined in

lib/types.ts:282


[PROFILE_CONFIGURATION_CONTEXT]

[PROFILE_CONFIGURATION_CONTEXT]: Set<MappingConfiguration<any, any>>

Defined in

lib/types.ts:293


[RECURSIVE_COUNT]

[RECURSIVE_COUNT]: Map<MetadataIdentifier<any>, ArrayKeyedMap>

Defined in

lib/types.ts:292


[RECURSIVE_DEPTH]

[RECURSIVE_DEPTH]: Map<MetadataIdentifier<any>, ArrayKeyedMap>

Defined in

lib/types.ts:291


[STRATEGY]

[STRATEGY]: MappingStrategy<MetadataIdentifier<any>>

Defined in

lib/types.ts:281

Methods

dispose

dispose(): void

Returns

void

Defined in

lib/types.ts:277


map

map<TSource, TDestination>(sourceObject, sourceIdentifier, destinationIdentifier, options?): TDestination

Type parameters

NameType
TSourceextends Dictionary<TSource>
TDestinationextends Dictionary<TDestination>

Parameters

NameType
sourceObjectTSource
sourceIdentifierModelIdentifier<TSource>
destinationIdentifierModelIdentifier<TDestination>
options?MapOptions<TSource, TDestination, Record<string, any>>

Returns

TDestination

Defined in

lib/types.ts:149

map<TSource>(sourceObject, identifier, options?): TSource

Type parameters

NameType
TSourceextends Dictionary<TSource>

Parameters

NameType
sourceObjectTSource
identifierModelIdentifier<TSource>
options?MapOptions<TSource, TSource, Record<string, any>>

Returns

TSource

Defined in

lib/types.ts:158


mapArray

mapArray<TSource, TDestination>(sourceArray, sourceIdentifier, destinationIdentifier, options?): TDestination[]

Type parameters

NameType
TSourceextends Dictionary<TSource>
TDestinationextends Dictionary<TDestination>

Parameters

NameType
sourceArrayTSource[]
sourceIdentifierModelIdentifier<TSource>
destinationIdentifierModelIdentifier<TDestination>
options?MapOptions<TSource[], TDestination[], Record<string, any>>

Returns

TDestination[]

Defined in

lib/types.ts:179

mapArray<TSource>(sourceArray, identifier, options?): TSource[]

Type parameters

NameType
TSourceextends Dictionary<TSource>

Parameters

NameType
sourceArrayTSource[]
identifierModelIdentifier<TSource>
options?MapOptions<TSource[], TSource[], Record<string, any>>

Returns

TSource[]

Defined in

lib/types.ts:188


mapArrayAsync

mapArrayAsync<TSource, TDestination>(sourceArray, sourceIdentifier, destinationIdentifier, options?): Promise<TDestination[]>

Type parameters

NameType
TSourceextends Dictionary<TSource>
TDestinationextends Dictionary<TDestination>

Parameters

NameType
sourceArrayTSource[]
sourceIdentifierModelIdentifier<TSource>
destinationIdentifierModelIdentifier<TDestination>
options?MapOptions<TSource[], TDestination[], Record<string, any>>

Returns

Promise<TDestination[]>

Defined in

lib/types.ts:194

mapArrayAsync<TSource>(sourceArray, identifier, options?): Promise<TSource[]>

Type parameters

NameType
TSourceextends Dictionary<TSource>

Parameters

NameType
sourceArrayTSource[]
identifierModelIdentifier<TSource>
options?MapOptions<TSource[], TSource[], Record<string, any>>

Returns

Promise<TSource[]>

Defined in

lib/types.ts:203


mapAsync

mapAsync<TSource, TDestination>(sourceObject, sourceIdentifier, destinationIdentifier, options?): Promise<TDestination>

Type parameters

NameType
TSourceextends Dictionary<TSource>
TDestinationextends Dictionary<TDestination>

Parameters

NameType
sourceObjectTSource
sourceIdentifierModelIdentifier<TSource>
destinationIdentifierModelIdentifier<TDestination>
options?MapOptions<TSource, TDestination, Record<string, any>>

Returns

Promise<TDestination>

Defined in

lib/types.ts:164

mapAsync<TSource>(sourceObject, identifier, options?): Promise<TSource>

Type parameters

NameType
TSourceextends Dictionary<TSource>

Parameters

NameType
sourceObjectTSource
identifierModelIdentifier<TSource>
options?MapOptions<TSource, TSource, Record<string, any>>

Returns

Promise<TSource>

Defined in

lib/types.ts:173


mutate

mutate<TSource, TDestination>(sourceObject, destinationObject, sourceIdentifier, destinationIdentifier, options?): void

Type parameters

NameType
TSourceextends Dictionary<TSource>
TDestinationextends Dictionary<TDestination>

Parameters

NameType
sourceObjectTSource
destinationObjectTDestination
sourceIdentifierModelIdentifier<TSource>
destinationIdentifierModelIdentifier<TDestination>
options?MapOptions<TSource, TDestination, Record<string, any>>

Returns

void

Defined in

lib/types.ts:209

mutate<TSource>(sourceObject, destinationObject, identifier, options?): void

Type parameters

NameType
TSourceextends Dictionary<TSource>

Parameters

NameType
sourceObjectTSource
destinationObjectTSource
identifierModelIdentifier<TSource>
options?MapOptions<TSource, TSource, Record<string, any>>

Returns

void

Defined in

lib/types.ts:219


mutateArray

mutateArray<TSource, TDestination>(sourceArray, destinationArray, sourceIdentifier, destinationIdentifier, options?): void

Type parameters

NameType
TSourceextends Dictionary<TSource>
TDestinationextends Dictionary<TDestination>

Parameters

NameType
sourceArrayTSource[]
destinationArrayTDestination[]
sourceIdentifierModelIdentifier<TSource>
destinationIdentifierModelIdentifier<TDestination>
options?MapOptions<TSource[], TDestination[], Record<string, any>>

Returns

void

Defined in

lib/types.ts:243

mutateArray<TSource>(sourceArray, destinationArray, identifier, options?): void

Type parameters

NameType
TSourceextends Dictionary<TSource>

Parameters

NameType
sourceArrayTSource[]
destinationArrayTSource[]
identifierModelIdentifier<TSource>
options?MapOptions<TSource[], TSource[], Record<string, any>>

Returns

void

Defined in

lib/types.ts:253


mutateArrayAsync

mutateArrayAsync<TSource, TDestination>(sourceArray, destinationArray, sourceIdentifier, destinationIdentifier, options?): Promise<void>

Type parameters

NameType
TSourceextends Dictionary<TSource>
TDestinationextends Dictionary<TDestination>

Parameters

NameType
sourceArrayTSource[]
destinationArrayTDestination[]
sourceIdentifierModelIdentifier<TSource>
destinationIdentifierModelIdentifier<TDestination>
options?MapOptions<TSource[], TDestination[], Record<string, any>>

Returns

Promise<void>

Defined in

lib/types.ts:260

mutateArrayAsync<TSource>(sourceArray, destinationArray, identifier, options?): Promise<void>

Type parameters

NameType
TSourceextends Dictionary<TSource>

Parameters

NameType
sourceArrayTSource[]
destinationArrayTSource[]
identifierModelIdentifier<TSource>
options?MapOptions<TSource[], TSource[], Record<string, any>>

Returns

Promise<void>

Defined in

lib/types.ts:270


mutateAsync

mutateAsync<TSource, TDestination>(sourceObject, destinationObject, sourceIdentifier, destinationIdentifier, options?): Promise<void>

Type parameters

NameType
TSourceextends Dictionary<TSource>
TDestinationextends Dictionary<TDestination>

Parameters

NameType
sourceObjectTSource
destinationObjectTDestination
sourceIdentifierModelIdentifier<TSource>
destinationIdentifierModelIdentifier<TDestination>
options?MapOptions<TSource, TDestination, Record<string, any>>

Returns

Promise<void>

Defined in

lib/types.ts:226

mutateAsync<TSource>(sourceObject, destinationObject, identifier, options?): Promise<void>

Type parameters

NameType
TSourceextends Dictionary<TSource>

Parameters

NameType
sourceObjectTSource
destinationObjectTSource
identifierModelIdentifier<TSource>
options?MapOptions<TSource, TSource, Record<string, any>>

Returns

Promise<void>

Defined in

lib/types.ts:236