Class BooleanTransform

public

Extends: Transform

Defined in: ../serializer/addon/-private/transforms/boolean.js:9

The BooleanTransform class is used to serialize and deserialize boolean attributes on Ember Data record objects. This transform is used when boolean is passed as the type parameter to the attr function.

Usage

app/models/user.js

import Model, { attr } from '@ember-data/model';

export default class UserModel extends Model {
  @attr('boolean') isAdmin;
  @attr('string') name;
  @attr('string') email;
}

By default, the boolean transform only allows for values of true or false. You can opt into allowing null values for boolean attributes via attr('boolean', { allowNull: true })

app/models/user.js

import Model, { attr } from '@ember-data/model';

export default class UserModel extends Model {
  @attr('string') email;
  @attr('string') username;
  @attr('boolean', { allowNull: true }) wantsWeeklyEmail;
}

Show: Inherited Protected Private Deprecated

deserialize (serialized, options) public

Module: @ember-data/serializer

Inherited from Transform ../serializer/addon/-private/transforms/transform.js:102

serialized: The serialized value
options: hash of options passed to attr
returns: The deserialized value

When given a serialized value from a JSON object this method must return the deserialized value for the record attribute.

Example

deserialize(serialized, options) {
  return empty(serialized) ? null : Number(serialized);
}

serialize (deserialized, options) public

Module: @ember-data/serializer

Inherited from Transform ../serializer/addon/-private/transforms/transform.js:80

deserialized: The deserialized value
options: hash of options passed to attr
returns: The serialized value

When given a deserialized value from a record attribute this method must return the serialized value.

Example

import { isEmpty } from '@ember/utils';

serialize(deserialized, options) {
  return isEmpty(deserialized) ? null : Number(deserialized);
}