0.0.0 • Published 8 months ago
@jersmart/automapper-core v0.0.0
@jersmart/automapper-core
This is the core package that will handle mapping configurations and mapping operations.
Installation
npm i @jersmart/automapper-core
or with yarn
yarn add @jersmart/automapper-core
Usage
@jersmart/automapper-core
exposes createMapper()
method to create a Mapper
object with a accompany MappingStrategy
(read more
about Strategies)
createMapper
accepts a CreateMapperOptions
object with the following shape:
export interface CreateMapperOptions {
strategyInitializer: MappingStrategyInitializer<MetadataIdentifier>;
errorHandler?: ErrorHandler;
namingConventions?: NamingConventionInput;
}
Read more about usage on documentation site
Strategies
A given Mapper is accompanied by a Strategy by providing strategyInitializer
when using createMapper()
.
A Strategy will be responsible for:
- Discover metadata (eg:
classes
uses@AutoMap()
decorator to discover the metadata of the properties on the Classes) - Retrieve metadata: how the metadata should be retrieved from the discovery phase (eg:
classes
discovers and stores the metadata toReflect
, retrieve metadata simply gets them fromReflect
) - Apply metadata: how the metadata is applied to the Model
@automapper
provides the following official strategies:
@jersmart/automapper-classes
: Work with TS/ES6 classes.@jersmart/automapper-pojos
: Work with Interfaces/Types along with POJOs. In projects that do not make use of Class,pojos
can be used instead.@jersmart/automapper-mikro
: Work together with TS/ES6 classes along with MikroORM@jersmart/automapper-sequelize
: Work together with TS/ES6 classes along with Sequelize
0.0.0
8 months ago