Appearance

Documentation / @ember-data/serializer / json / default

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:76

⚠️ This is LEGACY documentation for a feature that is no longer encouraged to be used. If starting a new app or thinking of implementing a new adapter, consider writing a Handler instead to be used with the RequestManager

In EmberData a Serializer is used to serialize and deserialize records when they are transferred in and out of an external source. This process involves normalizing property names, transforming attribute values and serializing relationships.

By default, EmberData uses and recommends the JSONAPISerializer.

JSONSerializer is useful for simpler or legacy backends that may not support the http://jsonapi.org/ spec.

For example, given the following User model and JSON payload:

app/models/user.js
js
import Model, { attr, belongsTo, hasMany } from '@ember-data/model';

export default class UserModel extends Model {
  @hasMany('user') friends;
  @belongsTo('location') house;

  @attr('string') name;
}
js
{
  id: 1,
  name: 'Sebastian',
  friends: [3, 4],
  links: {
    house: '/houses/lefkada'
  }
}

JSONSerializer will normalize the JSON payload to the JSON API format that the Ember Data store expects.

You can customize how JSONSerializer processes its payload by passing options in the attrs hash or by subclassing the JSONSerializer and overriding hooks:

  • To customize how a single record is normalized, use the normalize hook.
  • To customize how JSONSerializer normalizes the whole server response, use the normalizeResponse hook.
  • To customize how JSONSerializer normalizes a specific response from the server, use one of the many specific normalizeResponse hooks.
  • To customize how JSONSerializer normalizes your id, attributes or relationships, use the extractId, extractAttributes and extractRelationships hooks.

The JSONSerializer normalization process follows these steps:

  1. normalizeResponse
    • entry method to the serializer.
  2. normalizeCreateRecordResponse
    • a normalizeResponse for a specific operation is called.
  3. normalizeSingleResponse|normalizeArrayResponse
    • for methods like createRecord we expect a single record back, while for methods like findAll we expect multiple records back.
  4. normalize
    • normalizeArrayResponse iterates and calls normalize for each of its records while normalizeSingle calls it once. This is the method you most likely want to subclass.
  5. extractId | extractAttributes | extractRelationships
    • normalize delegates to these methods to turn the record payload into the JSON API format.

JSONSerializer

Constructors ​

Constructor ​

ts
new default(owner?): default;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:76

Parameters ​

owner? ​

any

Returns ​

default

Properties ​

store ​

ts
store: default;

Defined in: warp-drive-packages/legacy/declarations/serializer.d.ts:134

mergedProperties ​

ts
static mergedProperties: any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:168

The attrs object can be used to declare a simple mapping between property names on Model records and payload keys in the serialized JSON object representing the record. An object with the property key can also be used to designate the attribute's key on the response payload.

Example

app/models/person.js
js
import Model, { attr } from '@ember-data/model';

export default class PersonModel extends Model {
  @attr('string') firstName;
  @attr('string') lastName;
  @attr('string') occupation;
  @attr('boolean') admin;
}
app/serializers/person.js
js
import { JSONSerializer } from '@warp-drive/legacy/serializer/json';

export default class PersonSerializer extends JSONSerializer {
  attrs = {
    admin: 'is_admin',
    occupation: { key: 'career' }
  }
}

You can also remove attributes and relationships by setting the serialize key to false in your mapping object.

Example

app/serializers/person.js
js
import { JSONSerializer } from '@warp-drive/legacy/serializer/json';

export default class PostSerializer extends JSONSerializer {
  attrs = {
    admin: { serialize: false },
    occupation: { key: 'career' }
  }
}

When serialized:

javascript
{
  "firstName": "Harry",
  "lastName": "Houdini",
  "career": "magician"
}

Note that the admin is now not included in the payload.

Setting serialize to true enforces serialization for hasMany relationships even if it's neither a many-to-many nor many-to-none relationship.

primaryKey ​

ts
static primaryKey: string;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:100

The primaryKey is used when serializing and deserializing data. Ember Data always uses the id property to store the id of the record. The external source may not always follow this convention. In these cases it is useful to override the primaryKey property to match the primaryKey of your external store.

Example

app/serializers/application.js
js
import { JSONSerializer } from '@warp-drive/legacy/serializer/json';

export default class ApplicationSerializer extends JSONSerializer {
  primaryKey = '_id'
}

Default ​

ts
'id'

Methods ​

normalize() ​

ts
normalize(_typeClass, hash): 
  | SingleResourceDocument
  | EmptyResourceDocument;

Defined in: warp-drive-packages/legacy/declarations/serializer.d.ts:256

The normalize method is used to convert a payload received from your external data source into the normalized form store.push() expects. You should override this method, munge the hash and return the normalized payload.

Example:

js
Serializer.extend({
  normalize(modelClass, resourceHash) {
    let data = {
      id:            resourceHash.id,
      type:          modelClass.modelName,
      attributes:    resourceHash
    };
    return { data: data };
  }
})

Parameters ​

_typeClass ​

ModelSchema

hash ​

Record<string, unknown>

Returns ​

| SingleResourceDocument | EmptyResourceDocument

extractAttributes() ​

ts
static extractAttributes(modelClass, resourceHash): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:472

Returns the resource's attributes formatted as a JSON-API "attributes object".

http://jsonapi.org/format/#document-resource-object-attributes

Parameters ​

modelClass ​

any

resourceHash ​

any

Returns ​

any

extractErrors() ​

ts
static extractErrors(
   store, 
   typeClass, 
   payload, 
   id): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:979

extractErrors is used to extract model errors when a call to Model#save fails with an InvalidError. By default Ember Data expects error information to be located on the errors property of the payload object.

This serializer expects this errors object to be an Array similar to the following, compliant with the https://jsonapi.org/format/#errors specification:

js
{
  "errors": [
    {
      "detail": "This username is already taken!",
      "source": {
        "pointer": "data/attributes/username"
      }
    }, {
      "detail": "Doesn't look like a valid email.",
      "source": {
        "pointer": "data/attributes/email"
      }
    }
  ]
}

The key detail provides a textual description of the problem. Alternatively, the key title can be used for the same purpose.

The nested keys source.pointer detail which specific element of the request data was invalid.

Note that JSON-API also allows for object-level errors to be placed in an object with pointer data, signifying that the problem cannot be traced to a specific attribute:

javascript
{
  "errors": [
    {
      "detail": "Some generic non property error message",
      "source": {
        "pointer": "data"
      }
    }
  ]
}

When turn into a Errors object, you can read these errors through the property base:

handlebars
{{#each @model.errors.base as |error|}}
  <div class="error">
    {{error.message}}
  </div>
{{/each}}

Example of alternative implementation, overriding the default behavior to deal with a different format of errors:

app/serializers/post.js
js
import { JSONSerializer } from '@warp-drive/legacy/serializer/json';

export default class PostSerializer extends JSONSerializer {
  extractErrors(store, typeClass, payload, id) {
    if (payload && typeof payload === 'object' && payload._problems) {
      payload = payload._problems;
      this.normalizeErrors(typeClass, payload);
    }
    return payload;
  }
}

Parameters ​

store ​

Store

typeClass ​

Model

payload ​

any

id ​

string | number

Returns ​

any

json The deserialized errors

extractId() ​

ts
static extractId(modelClass, resourceHash): string;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:461

Returns the resource's ID.

Parameters ​

modelClass ​

any

resourceHash ​

any

Returns ​

string

extractMeta() ​

ts
static extractMeta(
   store, 
   modelClass, 
   payload): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:893

extractMeta is used to deserialize any meta information in the adapter payload. By default Ember Data expects meta information to be located on the meta property of the payload object.

Example

app/serializers/post.js
js
import { JSONSerializer } from '@warp-drive/legacy/serializer/json';

export default class PostSerializer extends JSONSerializer {
  extractMeta(store, typeClass, payload) {
    if (payload && payload.hasOwnProperty('_pagination')) {
      let meta = payload._pagination;
      delete payload._pagination;
      return meta;
    }
  }
}

Parameters ​

store ​

Store

modelClass ​

Model

payload ​

any

Returns ​

any

extractPolymorphicRelationship() ​

ts
static extractPolymorphicRelationship(
   relationshipModelName, 
   relationshipHash, 
   relationshipOptions): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:503

Returns a polymorphic relationship formatted as a JSON-API "relationship object".

http://jsonapi.org/format/#document-resource-object-relationships

relationshipOptions is a hash which contains more information about the polymorphic relationship which should be extracted:

  • resourceHash complete hash of the resource the relationship should be extracted from
  • relationshipKey key under which the value for the relationship is extracted from the resourceHash
  • relationshipMeta meta information about the relationship

Parameters ​

relationshipModelName ​

any

relationshipHash ​

any

relationshipOptions ​

any

Returns ​

any

extractRelationship() ​

ts
static extractRelationship(relationshipModelName, relationshipHash): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:483

Returns a relationship formatted as a JSON-API "relationship object".

http://jsonapi.org/format/#document-resource-object-relationships

Parameters ​

relationshipModelName ​

any

relationshipHash ​

any

Returns ​

any

extractRelationships() ​

ts
static extractRelationships(modelClass, resourceHash): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:514

Returns the resource's relationships formatted as a JSON-API "relationships object".

http://jsonapi.org/format/#document-resource-object-relationships

Parameters ​

modelClass ​

any

resourceHash ​

any

Returns ​

any

keyForAttribute() ​

ts
static keyForAttribute(key, method): string;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:1002

keyForAttribute can be used to define rules for how to convert an attribute name in your model to a key in your JSON.

Example

app/serializers/application.js
js
import { JSONSerializer } from '@warp-drive/legacy/serializer/json';
import { underscore } from '<app-name>/utils/string-utils';

export default class ApplicationSerializer extends JSONSerializer {
  keyForAttribute(attr, method) {
    return underscore(attr).toUpperCase();
  }
}

Parameters ​

key ​

string

method ​

string

Returns ​

string

normalized key

ts
static keyForLink(key, kind): string;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:1037

keyForLink can be used to define a custom key when deserializing link properties.

Parameters ​

key ​

string

kind ​

string

belongsTo or hasMany

Returns ​

string

normalized key

keyForRelationship() ​

ts
static keyForRelationship(
   key, 
   typeClass, 
   method): string;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:1027

keyForRelationship can be used to define a custom key when serializing and deserializing relationship properties. By default JSONSerializer does not provide an implementation of this method.

Example

app/serializers/post.js
js
import { JSONSerializer } from '@warp-drive/legacy/serializer/json';
import { underscore } from '<app-name>/utils/string-utils';

export default class PostSerializer extends JSONSerializer {
  keyForRelationship(key, relationship, method) {
    return `rel_${underscore(key)}`;
  }
}

Parameters ​

key ​

string

typeClass ​

string

method ​

string

Returns ​

string

normalized key

modelNameFromPayloadKey() ​

ts
static modelNameFromPayloadKey(key): string;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:522

Dasherizes the model name in the payload

Parameters ​

key ​

string

Returns ​

string

the model's modelName

normalize() ​

ts
static normalize(modelClass, resourceHash): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:452

Normalizes a part of the JSON payload returned by the server. You should override this method, munge the hash and call super if you have generic normalization to do.

It takes the type of the record that is being normalized (as a Model class), the property where the hash was originally found, and the hash to normalize.

You can use this method, for example, to normalize underscored keys to camelized or other general-purpose normalizations.

Example

app/serializers/application.js
js
import { JSONSerializer } from '@warp-drive/legacy/serializer/json';
import { underscore } from '<app-name>/utils/string-utils';
import { get } from '@ember/object';

export default class ApplicationSerializer extends JSONSerializer {
  normalize(typeClass, hash) {
    let fields = typeClass.fields;

    fields.forEach(function(type, field) {
      let payloadField = underscore(field);
      if (field === payloadField) { return; }

      hash[field] = hash[payloadField];
      delete hash[payloadField];
    });

    return super.normalize(...arguments);
  }
}

Parameters ​

modelClass ​

any

resourceHash ​

any

Returns ​

any

normalizeArrayResponse() ​

ts
static normalizeArrayResponse(
   store, 
   primaryModelClass, 
   payload, 
   id, 
   requestType): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:399

normalizeQueryResponse, normalizeFindManyResponse, and normalizeFindHasManyResponse delegate to this method by default.

Parameters ​

store ​

Store

primaryModelClass ​

Model

payload ​

any

id ​

string | number

requestType ​

string

Returns ​

any

JSON-API Document

Since ​

1.13.0

normalizeCreateRecordResponse() ​

ts
static normalizeCreateRecordResponse(
   store, 
   primaryModelClass, 
   payload, 
   id, 
   requestType, ...
   args): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:329

Called by the default normalizeResponse implementation when the type of request is createRecord

Parameters ​

store ​

Store

primaryModelClass ​

Model

payload ​

any

id ​

string | number

requestType ​

string

args ​

...any[]

Returns ​

any

JSON-API Document

Since ​

1.13.0

normalizeDeleteRecordResponse() ​

ts
static normalizeDeleteRecordResponse(
   store, 
   primaryModelClass, 
   payload, 
   id, 
   requestType, ...
   args): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:343

Called by the default normalizeResponse implementation when the type of request is deleteRecord

Parameters ​

store ​

Store

primaryModelClass ​

Model

payload ​

any

id ​

string | number

requestType ​

string

args ​

...any[]

Returns ​

any

JSON-API Document

Since ​

1.13.0

normalizeFindAllResponse() ​

ts
static normalizeFindAllResponse(
   store, 
   primaryModelClass, 
   payload, 
   id, 
   requestType, ...
   args): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:259

Called by the default normalizeResponse implementation when the type of request is findAll

Parameters ​

store ​

Store

primaryModelClass ​

Model

payload ​

any

id ​

string | number

requestType ​

string

args ​

...any[]

Returns ​

any

JSON-API Document

Since ​

1.13.0

normalizeFindBelongsToResponse() ​

ts
static normalizeFindBelongsToResponse(
   store, 
   primaryModelClass, 
   payload, 
   id, 
   requestType, ...
   args): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:273

Called by the default normalizeResponse implementation when the type of request is findBelongsTo

Parameters ​

store ​

Store

primaryModelClass ​

Model

payload ​

any

id ​

string | number

requestType ​

string

args ​

...any[]

Returns ​

any

JSON-API Document

Since ​

1.13.0

normalizeFindHasManyResponse() ​

ts
static normalizeFindHasManyResponse(
   store, 
   primaryModelClass, 
   payload, 
   id, 
   requestType, ...
   args): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:287

Called by the default normalizeResponse implementation when the type of request is findHasMany

Parameters ​

store ​

Store

primaryModelClass ​

Model

payload ​

any

id ​

string | number

requestType ​

string

args ​

...any[]

Returns ​

any

JSON-API Document

Since ​

1.13.0

normalizeFindManyResponse() ​

ts
static normalizeFindManyResponse(
   store, 
   primaryModelClass, 
   payload, 
   id, 
   requestType, ...
   args): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:301

Called by the default normalizeResponse implementation when the type of request is findMany

Parameters ​

store ​

Store

primaryModelClass ​

Model

payload ​

any

id ​

string | number

requestType ​

string

args ​

...any[]

Returns ​

any

JSON-API Document

Since ​

1.13.0

normalizeFindRecordResponse() ​

ts
static normalizeFindRecordResponse(
   store, 
   primaryModelClass, 
   payload, 
   id, 
   requestType, ...
   args): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:231

Called by the default normalizeResponse implementation when the type of request is findRecord

Parameters ​

store ​

Store

primaryModelClass ​

Model

payload ​

any

id ​

string | number

requestType ​

string

args ​

...any[]

Returns ​

any

JSON-API Document

Since ​

1.13.0

normalizeQueryRecordResponse() ​

ts
static normalizeQueryRecordResponse(
   store, 
   primaryModelClass, 
   payload, 
   id, 
   requestType, ...
   args): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:245

Called by the default normalizeResponse implementation when the type of request is queryRecord

Parameters ​

store ​

Store

primaryModelClass ​

Model

payload ​

any

id ​

string | number

requestType ​

string

args ​

...any[]

Returns ​

any

JSON-API Document

Since ​

1.13.0

normalizeQueryResponse() ​

ts
static normalizeQueryResponse(
   store, 
   primaryModelClass, 
   payload, 
   id, 
   requestType, ...
   args): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:315

Called by the default normalizeResponse implementation when the type of request is query

Parameters ​

store ​

Store

primaryModelClass ​

Model

payload ​

any

id ​

string | number

requestType ​

string

args ​

...any[]

Returns ​

any

JSON-API Document

Since ​

1.13.0

normalizeResponse() ​

ts
static normalizeResponse(
   store, 
   primaryModelClass, 
   payload, 
   id, 
   requestType, ...
   args): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:217

The normalizeResponse method is used to normalize a payload from the server to a JSON-API Document.

http://jsonapi.org/format/#document-structure

This method delegates to a more specific normalize method based on the requestType.

To override this method with a custom one, make sure to call return super.normalizeResponse(store, primaryModelClass, payload, id, requestType) with your pre-processed data.

Here's an example of using normalizeResponse manually:

javascript
socket.on('message', function(message) {
  let data = message.data;
  let modelClass = store.modelFor(data.modelName);
  let serializer = store.serializerFor(data.modelName);
  let normalized = serializer.normalizeSingleResponse(store, modelClass, data, data.id);

  store.push(normalized);
});

Parameters ​

store ​

Store

primaryModelClass ​

Model

payload ​

any

id ​

string | number

requestType ​

string

args ​

...any[]

Returns ​

any

JSON-API Document

Since ​

1.13.0

normalizeSaveResponse() ​

ts
static normalizeSaveResponse(
   store, 
   primaryModelClass, 
   payload, 
   id, 
   requestType, ...
   args): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:371

normalizeUpdateRecordResponse, normalizeCreateRecordResponse and normalizeDeleteRecordResponse delegate to this method by default.

Parameters ​

store ​

Store

primaryModelClass ​

Model

payload ​

any

id ​

string | number

requestType ​

string

args ​

...any[]

Returns ​

any

JSON-API Document

Since ​

1.13.0

normalizeSingleResponse() ​

ts
static normalizeSingleResponse(
   store, 
   primaryModelClass, 
   payload, 
   id, 
   requestType): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:385

normalizeQueryResponse and normalizeFindRecordResponse delegate to this method by default.

Parameters ​

store ​

Store

primaryModelClass ​

Model

payload ​

any

id ​

string | number

requestType ​

string

Returns ​

any

JSON-API Document

Since ​

1.13.0

normalizeUpdateRecordResponse() ​

ts
static normalizeUpdateRecordResponse(
   store, 
   primaryModelClass, 
   payload, 
   id, 
   requestType, ...
   args): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:357

Called by the default normalizeResponse implementation when the type of request is updateRecord

Parameters ​

store ​

Store

primaryModelClass ​

Model

payload ​

any

id ​

string | number

requestType ​

string

args ​

...any[]

Returns ​

any

JSON-API Document

Since ​

1.13.0

serialize() ​

ts
static serialize(snapshot, options): any;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:724

Called when a record is saved in order to convert the record into JSON.

By default, it creates a JSON object with a key for each attribute and belongsTo relationship.

For example, consider this model:

app/models/comment.js
js
import Model, { attr, belongsTo } from '@ember-data/model';

export default class CommentModel extends Model {
  @attr title;
  @attr body;

  @belongsTo('user') author;
}

The default serialization would create a JSON object like:

javascript
{
  "title": "Rails is unagi",
  "body": "Rails? Omakase? O_O",
  "author": 12
}

By default, attributes are passed through as-is, unless you specified an attribute type (attr('date')). If you specify a transform, the JavaScript value will be serialized when inserted into the JSON hash.

By default, belongs-to relationships are converted into IDs when inserted into the JSON hash.

IDs ​

serialize takes an options hash with a single option: includeId. If this option is true, serialize will, by default include the ID in the JSON object it builds.

The adapter passes in includeId: true when serializing a record for createRecord, but not for updateRecord.

Customization ​

Your server may expect a different JSON format than the built-in serialization format.

In that case, you can implement serialize yourself and return a JSON hash of your choosing.

app/serializers/post.js
js
import { JSONSerializer } from '@warp-drive/legacy/serializer/json';

export default class PostSerializer extends JSONSerializer {
  serialize(snapshot, options) {
    let json = {
      POST_TTL: snapshot.attr('title'),
      POST_BDY: snapshot.attr('body'),
      POST_CMS: snapshot.hasMany('comments', { ids: true })
    };

    if (options.includeId) {
      json.POST_ID_ = snapshot.id;
    }

    return json;
  }
}

Customizing an App-Wide Serializer ​

If you want to define a serializer for your entire application, you'll probably want to use eachAttribute and eachRelationship on the record.

app/serializers/application.js
js
import { JSONSerializer } from '@warp-drive/legacy/serializer/json';
import { singularize } from '<app-name>/utils/string-utils';

export default class ApplicationSerializer extends JSONSerializer {
  serialize(snapshot, options) {
    let json = {};

    snapshot.eachAttribute((name) => {
      json[serverAttributeName(name)] = snapshot.attr(name);
    });

    snapshot.eachRelationship((name, relationship) => {
      if (relationship.kind === 'hasMany') {
        json[serverHasManyName(name)] = snapshot.hasMany(name, { ids: true });
      }
    });

    if (options.includeId) {
      json.ID_ = snapshot.id;
    }

    return json;
  }
}

function serverAttributeName(attribute) {
  return attribute.underscore().toUpperCase();
}

function serverHasManyName(name) {
  return serverAttributeName(singularize(name)) + "_IDS";
}

This serializer will generate JSON that looks like this:

javascript
{
  "TITLE": "Rails is omakase",
  "BODY": "Yep. Omakase.",
  "COMMENT_IDS": [ "1", "2", "3" ]
}

Tweaking the Default JSON ​

If you just want to do some small tweaks on the default JSON, you can call super.serialize first and make the tweaks on the returned JSON.

app/serializers/post.js
js
import { JSONSerializer } from '@warp-drive/legacy/serializer/json';

export default class PostSerializer extends JSONSerializer {
  serialize(snapshot, options) {
    let json = super.serialize(...arguments);

    json.subject = json.title;
    delete json.title;

    return json;
  }
}

Parameters ​

snapshot ​

Snapshot

options ​

any

Returns ​

any

json

serializeAttribute() ​

ts
static serializeAttribute(
   snapshot, 
   json, 
   key, 
   attribute): void;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:779

serializeAttribute can be used to customize how attr properties are serialized

For example if you wanted to ensure all your attributes were always serialized as properties on an attributes object you could write:

app/serializers/application.js
js
import { JSONSerializer } from '@warp-drive/legacy/serializer/json';

export default class ApplicationSerializer extends JSONSerializer {
  serializeAttribute(snapshot, json, key, attributes) {
    json.attributes = json.attributes || {};
    super.serializeAttribute(snapshot, json.attributes, key, attributes);
  }
}

Parameters ​

snapshot ​

Snapshot

json ​

any

key ​

string

attribute ​

any

Returns ​

void

serializeBelongsTo() ​

ts
static serializeBelongsTo(
   snapshot, 
   json, 
   relationship): void;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:806

serializeBelongsTo can be used to customize how belongsTo properties are serialized.

Example

app/serializers/post.js
js
import { JSONSerializer } from '@warp-drive/legacy/serializer/json';

export default class PostSerializer extends JSONSerializer {
  serializeBelongsTo(snapshot, json, relationship) {
    let key = relationship.name;
    let belongsTo = snapshot.belongsTo(key);

    key = this.keyForRelationship ? this.keyForRelationship(key, "belongsTo", "serialize") : key;

    json[key] = !belongsTo ? null : belongsTo.record.toJSON();
  }
}

Parameters ​

snapshot ​

Snapshot

json ​

any

relationship ​

any

Returns ​

void

serializeHasMany() ​

ts
static serializeHasMany(
   snapshot, 
   json, 
   relationship): void;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:833

serializeHasMany can be used to customize how hasMany properties are serialized.

Example

app/serializers/post.js
js
import { JSONSerializer } from '@warp-drive/legacy/serializer/json';

export default class PostSerializer extends JSONSerializer {
  serializeHasMany(snapshot, json, relationship) {
    let key = relationship.name;
    if (key === 'comments') {
      return;
    } else {
      super.serializeHasMany(...arguments);
    }
  }
}

Parameters ​

snapshot ​

Snapshot

json ​

any

relationship ​

any

Returns ​

void

serializeIntoHash() ​

ts
static serializeIntoHash(
   hash, 
   typeClass, 
   snapshot, 
   options): void;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:753

You can use this method to customize how a serialized record is added to the complete JSON hash to be sent to the server. By default the JSON Serializer does not namespace the payload and just sends the raw serialized JSON object. If your server expects namespaced keys, you should consider using the RESTSerializer. Otherwise you can override this method to customize how the record is added to the hash. The hash property should be modified by reference.

For example, your server may expect underscored root objects.

app/serializers/application.js
js
import RESTSerializer from '@ember-data/serializer/rest';
import { underscoren} from '<app-name>/utils/string-utils';

export default class ApplicationSerializer extends RESTSerializer {
  serializeIntoHash(data, type, snapshot, options) {
    let root = underscore(type.modelName);
    data[root] = this.serialize(snapshot, options);
  }
}

Parameters ​

hash ​

any

typeClass ​

Model

snapshot ​

Snapshot

options ​

any

Returns ​

void

serializePolymorphicType() ​

ts
static serializePolymorphicType(): void;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:866

You can use this method to customize how polymorphic objects are serialized. Objects are considered to be polymorphic if { polymorphic: true } is pass as the second argument to the belongsTo function.

Example

app/serializers/comment.js
js
import { JSONSerializer } from '@warp-drive/legacy/serializer/json';

export default class CommentSerializer extends JSONSerializer {
  serializePolymorphicType(snapshot, json, relationship) {
    let key = relationship.name;
    let belongsTo = snapshot.belongsTo(key);

    key = this.keyForAttribute ? this.keyForAttribute(key, 'serialize') : key;

    if (!belongsTo) {
      json[key + '_type'] = null;
    } else {
      json[key + '_type'] = belongsTo.modelName;
    }
  }
}

Returns ​

void

shouldSerializeHasMany() ​

ts
static shouldSerializeHasMany(
   snapshot, 
   key, 
   relationship): boolean;

Defined in: warp-drive-packages/legacy/declarations/serializer/json.d.ts:571

Check if the given hasMany relationship should be serialized

By default only many-to-many and many-to-none relationships are serialized. This could be configured per relationship by Serializer's attrs object.

Parameters ​

snapshot ​

Snapshot

key ​

string

relationship ​

RelationshipSchema

Returns ​

boolean

true if the hasMany relationship should be serialized

Released under the MIT License.

Copyright © 2025 Ember.js and Contributors