Interface: Mapper

Properties

[ERROR_HANDLER]

• [ERROR_HANDLER]: ErrorHandler

Defined in

lib/types.ts:274

---

[MAPPINGS]

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

Defined in

lib/types.ts:275

---

[METADATA_MAP]

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

Defined in

lib/types.ts:278

---

[METADATA_OBJECT_MAP]

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

Defined in

lib/types.ts:279

---

[NAMING_CONVENTIONS]

• [NAMING_CONVENTIONS]: NamingConventionInput

Defined in

lib/types.ts:277

---

[PROFILE_CONFIGURATION_CONTEXT]

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

Defined in

lib/types.ts:288

---

[RECURSIVE_COUNT]

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

Defined in

lib/types.ts:287

---

[RECURSIVE_DEPTH]

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

Defined in

lib/types.ts:286

---

[STRATEGY]

• [STRATEGY]: MappingStrategy<MetadataIdentifier<any>>

Defined in

lib/types.ts:276

Methods

dispose

▸ dispose(): void

Returns

void

Defined in

lib/types.ts:272

---

map

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

Type parameters

Name	Type
TSource	extends Dictionary<TSource>
TDestination	extends Dictionary<TDestination>

Parameters

Name	Type
sourceObject	TSource
sourceIdentifier	ModelIdentifier<TSource>
destinationIdentifier	ModelIdentifier<TDestination>
options?	MapOptions<TSource, TDestination, Record<string, any>>

Returns

TDestination

Defined in

lib/types.ts:144

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

Type parameters

Name	Type
TSource	extends Dictionary<TSource>

Parameters

Name	Type
sourceObject	TSource
identifier	ModelIdentifier<TSource>
options?	MapOptions<TSource, TSource, Record<string, any>>

Returns

TSource

Defined in

lib/types.ts:153

---

mapArray

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

Type parameters

Name	Type
TSource	extends Dictionary<TSource>
TDestination	extends Dictionary<TDestination>

Parameters

Name	Type
sourceArray	TSource[]
sourceIdentifier	ModelIdentifier<TSource>
destinationIdentifier	ModelIdentifier<TDestination>
options?	MapOptions<TSource[], TDestination[], Record<string, any>>

Returns

TDestination[]

Defined in

lib/types.ts:174

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

Type parameters

Name	Type
TSource	extends Dictionary<TSource>

Parameters

Name	Type
sourceArray	TSource[]
identifier	ModelIdentifier<TSource>
options?	MapOptions<TSource[], TSource[], Record<string, any>>

Returns

TSource[]

Defined in

lib/types.ts:183

---

mapArrayAsync

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

Type parameters

Name	Type
TSource	extends Dictionary<TSource>
TDestination	extends Dictionary<TDestination>

Parameters

Name	Type
sourceArray	TSource[]
sourceIdentifier	ModelIdentifier<TSource>
destinationIdentifier	ModelIdentifier<TDestination>
options?	MapOptions<TSource[], TDestination[], Record<string, any>>

Returns

Promise<TDestination[]>

Defined in

lib/types.ts:189

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

Type parameters

Name	Type
TSource	extends Dictionary<TSource>

Parameters

Name	Type
sourceArray	TSource[]
identifier	ModelIdentifier<TSource>
options?	MapOptions<TSource[], TSource[], Record<string, any>>

Returns

Promise<TSource[]>

Defined in

lib/types.ts:198

---

mapAsync

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

Type parameters

Name	Type
TSource	extends Dictionary<TSource>
TDestination	extends Dictionary<TDestination>

Parameters

Name	Type
sourceObject	TSource
sourceIdentifier	ModelIdentifier<TSource>
destinationIdentifier	ModelIdentifier<TDestination>
options?	MapOptions<TSource, TDestination, Record<string, any>>

Returns

Promise<TDestination>

Defined in

lib/types.ts:159

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

Type parameters

Name	Type
TSource	extends Dictionary<TSource>

Parameters

Name	Type
sourceObject	TSource
identifier	ModelIdentifier<TSource>
options?	MapOptions<TSource, TSource, Record<string, any>>

Returns

Promise<TSource>

Defined in

lib/types.ts:168

---

mutate

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

Type parameters

Name	Type
TSource	extends Dictionary<TSource>
TDestination	extends Dictionary<TDestination>

Parameters

Name	Type
sourceObject	TSource
destinationObject	TDestination
sourceIdentifier	ModelIdentifier<TSource>
destinationIdentifier	ModelIdentifier<TDestination>
options?	MapOptions<TSource, TDestination, Record<string, any>>

Returns

void

Defined in

lib/types.ts:204

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

Type parameters

Name	Type
TSource	extends Dictionary<TSource>

Parameters

Name	Type
sourceObject	TSource
destinationObject	TSource
identifier	ModelIdentifier<TSource>
options?	MapOptions<TSource, TSource, Record<string, any>>

Returns

void

Defined in

lib/types.ts:214

---

mutateArray

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

Type parameters

Name	Type
TSource	extends Dictionary<TSource>
TDestination	extends Dictionary<TDestination>

Parameters

Name	Type
sourceArray	TSource[]
destinationArray	TDestination[]
sourceIdentifier	ModelIdentifier<TSource>
destinationIdentifier	ModelIdentifier<TDestination>
options?	MapOptions<TSource[], TDestination[], Record<string, any>>

Returns

void

Defined in

lib/types.ts:238

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

Type parameters

Name	Type
TSource	extends Dictionary<TSource>

Parameters

Name	Type
sourceArray	TSource[]
destinationArray	TSource[]
identifier	ModelIdentifier<TSource>
options?	MapOptions<TSource[], TSource[], Record<string, any>>

Returns

void

Defined in

lib/types.ts:248

---

mutateArrayAsync

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

Type parameters

Name	Type
TSource	extends Dictionary<TSource>
TDestination	extends Dictionary<TDestination>

Parameters

Name	Type
sourceArray	TSource[]
destinationArray	TDestination[]
sourceIdentifier	ModelIdentifier<TSource>
destinationIdentifier	ModelIdentifier<TDestination>
options?	MapOptions<TSource[], TDestination[], Record<string, any>>

Returns

Promise<void>

Defined in

lib/types.ts:255

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

Type parameters

Name	Type
TSource	extends Dictionary<TSource>

Parameters

Name	Type
sourceArray	TSource[]
destinationArray	TSource[]
identifier	ModelIdentifier<TSource>
options?	MapOptions<TSource[], TSource[], Record<string, any>>

Returns

Promise<void>

Defined in

lib/types.ts:265

---

mutateAsync

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

Type parameters

Name	Type
TSource	extends Dictionary<TSource>
TDestination	extends Dictionary<TDestination>

Parameters

Name	Type
sourceObject	TSource
destinationObject	TDestination
sourceIdentifier	ModelIdentifier<TSource>
destinationIdentifier	ModelIdentifier<TDestination>
options?	MapOptions<TSource, TDestination, Record<string, any>>

Returns

Promise<void>

Defined in

lib/types.ts:221

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

Type parameters

Name	Type
TSource	extends Dictionary<TSource>

Parameters

Name	Type
sourceObject	TSource
destinationObject	TSource
identifier	ModelIdentifier<TSource>
options?	MapOptions<TSource, TSource, Record<string, any>>

Returns

Promise<void>

Defined in

lib/types.ts:231