Giter Club home page Giter Club logo

ts-data-mapper's Introduction

ts-data-mapper

A typescript mapping tool supports mutual transforming between domain model and orm entity. In most case, domain model is not fully compatible with orm entity. you may need a mapping tool to convert model to entity when persisting and convert it back when accessing data.

installation

npm i ts-data-mapper

usage

  • pseudo-code below is for describing usage, not working directly.
  1. assuming you have class Model and class Entity as below
class Model {
  name: string
  otherInfo: OtherType
}

@Entity()
class Entity {
  @Column()
  name: string
  @Column()
  otherInfo: string
}
  1. create a mapper (Model to Entity mapping)
import { Mapper } from 'ts-data-mapper'

const mapper = new Mapper(Model, Entity)
  1. define mapping rules. you can direct map property(i.e. name), and map a property using a mapping function(i.e. otherInfo), when direct mapping a property, you can also assign the second parameter(deep?: boolean) to true to deep clone corresponding property value. Methods below (directMap and map) has type check, property key intellisense and supports method chaining.
mapper.directMap('name').map('otherInfo', (model) => JSON.stringify(model.otherInfo));

if it has a bunch of property to map directly, you can also do below.

mapper.directMap(['name', 'gender'])
  1. map a source object to a target.
const model = new Model();
const entity = mapper.exec(model);
  1. (unnecessary) you may want to add a 'toEntity' method to class Model and a 'toModel' method to class Entity
class Model {
  //...

  toEntity(): Entity {
    const mapper = new Mapper(Model, Entity).directMap('name').map('otherInfo', (model) => JSON.stringify(model.otherInfo));
    return mapper.exec(this);
  }
}

class Entity {
  //...

  toModel(): Model {
    const mapper = new Mapper(Entity, Model).directMap('name').map('otherInfo', (model) => JSON.parse(model.otherInfo));
    return mapper.exec(this);
  }
}

ts-data-mapper's People

Contributors

zsynuting avatar

Stargazers

Roman Vasilev avatar  avatar Roman avatar ebigram avatar toby avatar  avatar 赵磊鹏 avatar Hemisu avatar zhanglun avatar Yann avatar

Watchers

James Cloos avatar  avatar

ts-data-mapper's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.