knockout-mapping

knockout.mapping

Object mapping plugin for Knockout

Documentation

Official documentation here.

Install

Bower

bower install bower-knockout-mapping --save-dev

NPM

npm install knockout-mapping --save

Quick Start

var data = {
    email: '[e-mail]',
    name: 'demo',
    addresses: [
        { type: 'home', country: 'Romania', city: 'Cluj' },
        { type: 'work', country: 'Spain', city: 'Barcelona' }
    ]
};

// Create a view model from data
var viewModel = ko.mapping.fromJS(data);

// Now use the viewModel to change some values (properties are now observable)
viewModel.email('[e-mail]');
viewModel.name('demo2');
viewModel.addresses()[0].city('Bucharest');

// Retrieve the updated data (as JS object)
var newData = ko.mapping.toJS(viewModel);

// newData now looks like this
{
  email: '[e-mail]',
  name: 'demo2',
  addresses: [
    { type: 'home', country: 'Romania', city: 'Bucharest' },
    { type: 'work', country: 'Spain', city: 'Barcelona' }
  ]
}

Run this example in JSFiddle.

Test

Continuous Integration tests are done with Travis, and the associated Gulp task is test-ci. For development test task is used, which runs the tests against the latest version of Knockout.

License

MIT

Changelog

2.6.0 (2016-02-28)

• Issue #124: Use hasOwnProperty to check for bucket existence
• Small performance improvements e6c5631, f97d5cd, 57a0b56
• Issue #96: Fix incorrect handling of properties with periods
• Issue #205: Allow JSON.stringify parameters to be specified to ko.mapping.toJSON
• Issue #9: Fix pure computeds are treated the same as deferred, not auto-evaluated after mapping