module@warp-drive/legacy/serializer @legacy

Class Serializer

Defined in: warp-drive-packages/legacy/src/serializer.ts:184

⚠️ CAUTION you likely want the docs for MinimumSerializerInterface as extending this abstract class is unnecessary.

Serializer is an abstract base class that you may override in your application to customize it for your backend. The minimum set of methods that you should implement is:

• normalizeResponse()
• serialize()

And you can optionally override the following methods:

• normalize()

For an example implementation, see the included JSONSerializer.

Extends

• EmberObject

Constructors

Constructor

new Serializer(owner?: Owner): Serializer;

Parameters

owner?

Owner

Returns

Serializer

Inherited from

EmberObject.constructor

Methods

normalize()

normalize(_typeClass: ModelSchema, hash: Record<string, unknown>): 
  | EmptyResourceDocument
  | SingleResourceDocument;

Defined in: warp-drive-packages/legacy/src/serializer.ts:308

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:

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

Parameters

_typeClass

ModelSchema

the model class the hash is being normalized for

hash

Record<string, unknown>

the raw payload hash to normalize

Returns

| EmptyResourceDocument | SingleResourceDocument

the normalized resource document

Properties

store

store: Store$1;

Defined in: warp-drive-packages/legacy/src/serializer.ts:204

The store property is the application's store that contains all records. It can be used to look up serializers for other model types that may be nested inside the payload response.

Example:

Serializer.extend({
  extractRelationship(relationshipModelName, relationshipHash) {
    let modelClass = this.store.modelFor(relationshipModelName);
    let relationshipSerializer = this.store.serializerFor(relationshipModelName);
    return relationshipSerializer.normalize(modelClass, relationshipHash);
  }
});