The results of the 2017 Ember Community Survey !

DS.HasManyReference Class addon/-private/system/references/has-many.js:16


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

Show:

Methods

Show:

link

String

The link Ember Data will use to fetch or reload this has-many relationship.

Example

app/models/post.js
1
2
3
export default DS.Model.extend({
  comments: DS.hasMany({ async: true })
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
let post = store.push({
  data: {
    type: 'post',
    id: 1,
    relationships: {
      comments: {
        links: {
          related: '/posts/1/comments'
        }
      }
    }
  }
});

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

commentsRef.link(); // '/posts/1/comments'

Returns:

String
The link Ember Data will use to fetch or reload 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

app/models/post.js
1
2
3
export default DS.Model.extend({
  comments: DS.hasMany({ async: true })
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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 link Ember Data will use to fetch or reload this has-many relationship.

Example

app/models/post.js
1
2
3
export default DS.Model.extend({
  comments: DS.hasMany({ async: true })
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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

app/models/post.js
1
2
3
export default DS.Model.extend({
  comments: DS.hasMany({ async: true })
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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:

DS.ManyArray

reload

Promise

Reloads this has-many relationship.

Example

app/models/post.js
1
2
3
export default DS.Model.extend({
  comments: DS.hasMany({ async: true })
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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

Array

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

Example

app/models/post.js
1
2
3
export default DS.Model.extend({
  comments: DS.hasMany({ async: true })
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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

value

DS.ManyArray

value() sycronously 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

app/models/post.js
1
2
3
export default DS.Model.extend({
  comments: DS.hasMany({ async: true })
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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:

DS.ManyArray