API Docs for:
Show:

DS.HasManyReference Class

A HasManyReference is a low level API that allows users and addon author to perform meta-operations on a has-many relationship.

Item Index

Methods

ids

() Array

ids() returns an array of the record ids in this relationship.

Example

export default DS.Model.extend({
  comments: DS.hasMany({ async: true })
});
let post = store.push({
  data: {
    type: 'post',
    id: 1,
    relationships: {
      comments: {
        data: [{ type: 'comment', id: 1 }]
      }
    }
  }
});

let commentsRef = post.hasMany('comments');

commentsRef.ids(); // ['1']

Returns:

Array:

The ids in this has-many relationship

load

() Promise

Loads the relationship if it is not already loaded. If the relationship is already loaded this method does not trigger a new load.

Example

export default DS.Model.extend({
  comments: DS.hasMany({ async: true })
});
let post = store.push({
  data: {
    type: 'post',
    id: 1,
    relationships: {
      comments: {
        data: [{ type: 'comment', id: 1 }]
      }
    }
  }
});

let commentsRef = post.hasMany('comments');

commentsRef.load().then(function(comments) {
  //...
});

Returns:

Promise:

a promise that resolves with the ManyArray in this has-many relationship.

meta

() Object

The meta data for the has-many relationship.

Example

export default DS.Model.extend({
  comments: DS.hasMany({ async: true })
});
let post = store.push({
  data: {
    type: 'post',
    id: 1,
    relationships: {
      comments: {
        links: {
          related: {
            href: '/posts/1/comments',
            meta: {
              count: 10
            }
          }
        }
      }
    }
  }
});

let commentsRef = post.hasMany('comments');

commentsRef.meta(); // { count: 10 }

Returns:

Object:

The meta information for the has-many relationship.

push

(
  • objectOrPromise
)
DS.ManyArray

push can be used to update the data in the relationship and Ember Data will treat the new data as the canonical value of this relationship on the backend.

Example

export default DS.Model.extend({
  comments: DS.hasMany({ async: true })
});
let post = store.push({
  data: {
    type: 'post',
    id: 1,
    relationships: {
      comments: {
        data: [{ type: 'comment', id: 1 }]
      }
    }
  }
});

let commentsRef = post.hasMany('comments');

commentsRef.ids(); // ['1']

commentsRef.push([
  [{ type: 'comment', id: 2 }],
  [{ type: 'comment', id: 3 }],
])

commentsRef.ids(); // ['2', '3']

Parameters:

  • objectOrPromise Array | Promise

    a promise that resolves to a JSONAPI document object describing the new value of this relationship.

Returns:

reload

() Promise

Reloads this has-many relationship.

Example

export default DS.Model.extend({
  comments: DS.hasMany({ async: true })
});
let post = store.push({
  data: {
    type: 'post',
    id: 1,
    relationships: {
      comments: {
        data: [{ type: 'comment', id: 1 }]
      }
    }
  }
});

let commentsRef = post.hasMany('comments');

commentsRef.reload().then(function(comments) {
  //...
});

Returns:

Promise:

a promise that resolves with the ManyArray in this has-many relationship.

remoteType

() String

This returns a string that represents how the reference will be looked up when it is loaded. If the relationship has a link it will use the "link" otherwise it defaults to "id".

Example

export default DS.Model.extend({
  comments: DS.hasMany({ async: true })
});
let post = store.push({
  data: {
    type: 'post',
    id: 1,
    relationships: {
      comments: {
        data: [{ type: 'comment', id: 1 }]
      }
    }
  }
});

let commentsRef = post.hasMany('comments');

// get the identifier of the reference
if (commentsRef.remoteType() === "ids") {
  let ids = commentsRef.ids();
} else if (commentsRef.remoteType() === "link") {
  let link = commentsRef.link();
}

Returns:

String:

The name of the remote type. This should either be "link" or "ids"

value

() DS.ManyArray

value() synchronously returns the current value of the has-many relationship. Unlike record.get('relationshipName'), calling value() on a reference does not trigger a fetch if the async relationship is not yet loaded. If the relationship is not loaded it will always return null.

Example

export default DS.Model.extend({
  comments: DS.hasMany({ async: true })
});
let post = store.push({
  data: {
    type: 'post',
    id: 1,
    relationships: {
      comments: {
        data: [{ type: 'comment', id: 1 }]
      }
    }
  }
});

let commentsRef = post.hasMany('comments');

post.get('comments').then(function(comments) {
  commentsRef.value() === comments
})

Returns: