DS.RecordReference

DS.RecordReference Class

Defined in: addon/-private/system/references/record.js:4

Module: ember-data

An RecordReference is a low level API that allows users and addon author to perform meta-operations on a record.

idString

Defined in addon/-private/system/references/record.js:21

The id of the record that this reference refers to.

Together, the type and id properties form a composite key for the identity map.

Example

let userRef = store.getReference('user', 1);

userRef.id(); // '1'

Returns:

String
The id of the record.

loadPromise

Defined in addon/-private/system/references/record.js:118

Triggers a fetch for the backing entity based on its remoteType (see remoteType definitions per reference type).

Example

let userRef = store.getReference('user', 1);

// load user (via store.find)
userRef.load().then(...)

Returns:

Promise
the record for this RecordReference

push (UNKNOWN)

Defined in addon/-private/system/references/record.js:62

This API allows you to provide a reference with new data. The simplest usage of this API is similar to store.push: you provide a normalized hash of data and the object represented by the reference will update.

If you pass a promise to push, Ember Data will not ask the adapter for the data if another attempt to fetch it is made in the interim. When the promise resolves, the underlying object is updated with the new data, and the promise returned by this function is resolved with that object.

For example, recordReference.push(promise) will be resolved with a record.

Example

 let userRef = store.getReference('user', 1);

 // provide data for reference
 userRef.push({ data: { id: 1, username: "@user" }}).then(function(user) {
   userRef.value() === user;
 });

Parameters:

UNKNOWN Promise|Object

Returns:

Promise a promise for the value (record or relationship)

reloadPromise

Defined in addon/-private/system/references/record.js:138

Reloads the record if it is already loaded. If the record is not loaded it will load the record via store.findRecord

Example

let userRef = store.getReference('user', 1);

// or trigger a reload
userRef.reload().then(...)

Returns:

Promise
the record for this RecordReference

remoteTypeString

Defined in addon/-private/system/references/record.js:42

How the reference will be looked up when it is loaded: Currently this always return identity to signifying that a record will be loaded by the type and id.

Example

const userRef = store.getReference('user', 1);

userRef.remoteType(); // 'identity'

Returns:

String
'identity'

valueDS.Model

Defined in addon/-private/system/references/record.js:98

If the entity referred to by the reference is already loaded, it is present as reference.value. Otherwise the value returned by this function is null.

Example

 let userRef = store.getReference('user', 1);

 userRef.value(); // user

Returns:

DS.Model
the record for this RecordReference

© 2017 Yehuda Katz, Tom Dale and Ember.js contributors
Licensed under the MIT License.
https://emberjs.com/api/data/classes/DS.RecordReference.html

在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号

意见反馈
返回顶部