Class DS.Transform
The DS.Transform
class is used to serialize and deserialize model
attributes when they are saved or loaded from an
adapter. Subclassing DS.Transform
is useful for creating custom
attributes. All subclasses of DS.Transform
must implement a
serialize
and a deserialize
method.
Example
app/transforms/temperature.js | |
1 2 3 4 5 6 7 8 9 10 11 12 |
import DS from 'ember-data'; // Converts centigrade in the JSON to fahrenheit in the app export default DS.Transform.extend({ deserialize(serialized, options) { return (serialized * 1.8) + 32; }, serialize(deserialized, options) { return (deserialized - 32) / 1.8; } }); |
The options passed into the DS.attr
function when the attribute is
declared on the model is also available in the transform.
app/models/post.js | |
1 2 3 4 5 6 7 8 9 |
export default DS.Model.extend({ title: DS.attr('string'), markdown: DS.attr('markdown', { markdown: { gfm: false, sanitize: true } }) }); |
app/transforms/markdown.js | |
1 2 3 4 5 6 7 8 9 10 11 |
export default DS.Transform.extend({ serialize(deserialized, options) { return deserialized.raw; }, deserialize(serialized, options) { var markdownOptions = options.markdown || {}; return marked(serialized, markdownOptions); } }); |
Usage
app/models/requirement.js | |
1 2 3 4 5 6 |
import DS from 'ember-data'; export default DS.Model.extend({ name: DS.attr('string'), temperature: DS.attr('temperature') }); |
deserialize (serialized, options)
Defined in addon/transforms/transform.js:92
- serialized
- The serialized value
- options
- hash of options passed to `DS.attr`
- returns
- The deserialized value
When given a serialize value from a JSON object this method must return the deserialized value for the record attribute.
Example
1 2 3 |
deserialize(serialized, options) { return empty(serialized) ? null : Number(serialized); } |
serialize (deserialized, options)
Defined in addon/transforms/transform.js:71
- deserialized
- The deserialized value
- options
- hash of options passed to `DS.attr`
- returns
- The serialized value
When given a deserialized value from a record attribute this method must return the serialized value.
Example
1 2 3 4 5 |
import { isEmpty } from '@ember/utils'; serialize(deserialized, options) { return isEmpty(deserialized) ? null : Number(deserialized); } |