Package Exports

javascript-orm-mapper

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (javascript-orm-mapper) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Javascript orm mapper

This library provides a simple way to map data from json to javascript objects that use multiple data types, including relational data types, for example: OneToMany

Installation

$ npm i javascript-orm-mapper

Tests

$ npm test

Defining Models

You can define models just like normal classes. There are no limits, you can define own methods, getters properties and whatever you want. All you have to do to make your class mappable is describing properties with type annotations

// Create database
const database = new Database()

// Post
@Entity({
    name: 'post',
    database: database
})
class Post extends Model {
    @Id()
    @String()
    id: string = ''

    @String()
    name: string = ''

    @OneToMany('comment')
    comments: Comment[] = []
}

// Comment
@Entity({
    name: 'comment',
    database: database
})
class Comment extends Model {
    @Id()
    @String()
    id: string = ''

    @String()
    content: string = ''

    @ManyToOne('post')
    post: Post = null
}

Mapping data to objects

let post = <Post>ModelMapper.persist({
    id: 1,
    name: 123,
    comments: [
        {
            id: 1,
            content: "Lorem ipsum",
            post: {
                id: 1,
                name: "New name"
            }
        }
    ]
}, Post)

// Result
// Post {
//   __orm_uid: "bf9929cb-f852-43a0-9260-2e3fb89833b7",
//   id: "1",
//   name: "New name",
//   comments: [
//     Comment { 
//        __orm_uid: "6599f446-fb0d-4194-abbd-659d40d5c9fb",
//        content: "Lorem ipsum",
//        post: Post {
//            __orm_uid: "bf9929cb-f852-43a0-9260-2e3fb89833b7",
//            id: "1",
//            name: "New name",
//            comments: [
//                [Circural]  
//            ]
//        }
//     }
//   ]
// }