API Docs for: 5.3.3+58cd284b
Show:

Snapshot Class

Snapshot is not directly instantiable. Instances are provided to a consuming application's adapters and serializers for certain requests.

Snapshots are only available when using @ember-data/legacy-compat for legacy compatibility with adapters and serializers.

Methods

attr

(
  • keyName
)
Object public

Returns the value of an attribute.

Example

// store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });
postSnapshot.attr('author'); // => 'Tomster'
postSnapshot.attr('title'); // => 'Ember.js rocks'

Note: Values are loaded eagerly and cached when the snapshot is created.

Parameters:

  • keyName String

Returns:

Object:

The attribute value or undefined

attributes

() Object public

Returns all attributes and their corresponding values.

Example

// store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });
postSnapshot.attributes(); // => { author: 'Tomster', title: 'Ember.js rocks' }

Returns:

Object:

All attributes of the current snapshot

belongsTo

(
  • keyName
  • [options]
)
(Snapshot | String | Null | Undefined) public

Returns the current value of a belongsTo relationship.

belongsTo takes an optional hash of options as a second parameter, currently supported options are:

  • id: set to true if you only want the ID of the related record to be returned.

Example

// store.push('post', { id: 1, title: 'Hello World' });
// store.createRecord('comment', { body: 'Lorem ipsum', post: post });
commentSnapshot.belongsTo('post'); // => Snapshot
commentSnapshot.belongsTo('post', { id: true }); // => '1'

// store.push('comment', { id: 1, body: 'Lorem ipsum' });
commentSnapshot.belongsTo('post'); // => undefined

Calling belongsTo will return a new Snapshot as long as there's any known data for the relationship available, such as an ID. If the relationship is known but unset, belongsTo will return null. If the contents of the relationship is unknown belongsTo will return undefined.

Note: Relationships are loaded lazily and cached upon first access.

Parameters:

  • keyName String
  • [options] Object optional

Returns:

(Snapshot | String | Null | Undefined):

A snapshot or ID of a known relationship or null if the relationship is known but unset. undefined will be returned if the contents of the relationship is unknown.

changedAttributes

() Object public

Returns all changed attributes and their old and new values.

Example

// store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });
postModel.set('title', 'Ember.js rocks!');
postSnapshot.changedAttributes(); // => { title: ['Ember.js rocks', 'Ember.js rocks!'] }

Returns:

Object:

All changed attributes of the current snapshot

constructor

(
  • options
  • identifier
  • _store
)
private

Parameters:

  • options Object
  • identifier Object
  • _store Object

eachAttribute

(
  • callback
  • [binding]
)
public

Iterates through all the attributes of the model, calling the passed function on each attribute.

Example

snapshot.eachAttribute(function(name, meta) {
  // ...
});

Parameters:

  • callback Function

    the callback to execute

  • [binding] Object optional

    the value to which the callback's this should be bound

eachRelationship

(
  • callback
  • [binding]
)
public

Iterates through all the relationships of the model, calling the passed function on each relationship.

Example

snapshot.eachRelationship(function(name, relationship) {
  // ...
});

Parameters:

  • callback Function

    the callback to execute

  • [binding] Object optional

    the value to which the callback's this should be bound

hasMany

(
  • keyName
  • [options]
)
(Array | Undefined) public

Returns the current value of a hasMany relationship.

hasMany takes an optional hash of options as a second parameter, currently supported options are:

  • ids: set to true if you only want the IDs of the related records to be returned.

Example

// store.push('post', { id: 1, title: 'Hello World', comments: [2, 3] });
postSnapshot.hasMany('comments'); // => [Snapshot, Snapshot]
postSnapshot.hasMany('comments', { ids: true }); // => ['2', '3']

// store.push('post', { id: 1, title: 'Hello World' });
postSnapshot.hasMany('comments'); // => undefined

Note: Relationships are loaded lazily and cached upon first access.

Parameters:

  • keyName String
  • [options] Object optional

Returns:

(Array | Undefined):

An array of snapshots or IDs of a known relationship or an empty array if the relationship is known but unset. undefined will be returned if the contents of the relationship is unknown.

serialize

(
  • options
)
Object public

Serializes the snapshot using the serializer for the model.

Example

import Adapter from '@ember-data/adapter';

export default Adapter.extend({
  createRecord(store, type, snapshot) {
    let data = snapshot.serialize({ includeId: true });
    let url = /${type.modelName};

    return fetch(url, {
      method: 'POST',
      body: data,
    }).then((response) => response.json())
  }
});

Parameters:

  • options Object

Returns:

Object:

an object whose values are primitive JSON values only

Properties

adapterOptions

Object public

A hash of adapter options

id

String public

The id of the snapshot's underlying record

Example

// store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });
postSnapshot.id; // => '1'

identifier

StableRecordIdentifier public

The unique RecordIdentifier associated with this Snapshot.

include

String | Array public

If include was passed to the options hash for the request, the value would be available here.

modelName

String public

The name of the type of the underlying record for this snapshot, as a string.

record

Model public

The underlying record for this snapshot. Can be used to access methods and properties defined on the record.

Example

let json = snapshot.record.toJSON();