Skip to content

Latest commit

 

History

History
84 lines (64 loc) · 1.64 KB

README.md

File metadata and controls

84 lines (64 loc) · 1.64 KB

@automapper/pojos

This is the official strategy from @automapper to work with Interfaces/Types along with Plain Objects

Installation

npm i @automapper/pojos

or with yarn:

yarn add @automapper/pojos

peerDependencies

@automapper/pojos depends on @automapper/core

npm i @automapper/core

or with yarn:

yarn add @automapper/core

Usage

@automapper/pojos provides pojos as a MappingStrategyInitializer. Pass pojos() to createMapper to create a Mapper that uses pojos strategy.

import { pojos, PojosMetadataMap } from '@automapper/pojos';
import { createMapper, createMap, forMember, mapFrom } from '@automapper/core';

const mapper = createMapper({
  ...,
  strategyInitializer: pojos()
});

interface User {
    firstName: string;
    lastName: string;
}

interface UserDto {
    firstName: string;
    lastName: string;
    fullName: string;
}

PojosMetadataMap.create<User>('SomeTokenForUser', {
    firstName: String,
    lastName: String
});

PojosMetadataMap.create<UserDto>('SomeTokenForUserDto', {
  firstName: String,
  lastName: String,
  fullName: String
});

createMap<User, UserDto>(
    mapper,
    'SomeTokenForUser',
    'SomeTokenForUserDto',
    forMember(
        d => d.fullName,
        mapFrom(s => s.firstName + ' ' + s.lastName)
    )
);
mapper.map<User, UserDto>(
    {firstName: 'Auto', lastName: 'Mapper'},
    'SomeTokenForUser',
    'SomeTokenForUserDto'
);
// { firstName: 'Auto', lastName: 'Mapper', fullName: 'Auto Mapper' }

Read more about this strategy on pojos documentation