Class RecordReference
publicA RecordReference
is a low-level API that allows users and
addon authors to perform meta-operations on a record.
id String public
Defined in ../packages/store/src/-private/legacy-model-support/record-reference.ts:53
- returns
- String
The id of the record.
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'
identifier String public
Defined in ../packages/store/src/-private/legacy-model-support/record-reference.ts:76
- returns
- String
The identifier of the record.
The identifier
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.identifier(); // '1'
load Promise<record> public
Defined in ../packages/store/src/-private/legacy-model-support/record-reference.ts:186
- returns
- Promise<record>
the record for this RecordReference
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(...)
push (objectOrPromise) public
Defined in ../packages/store/src/-private/legacy-model-support/record-reference.ts:119
- objectOrPromise
a JSON:API ResourceDocument or a promise resolving to one
- returns
a promise for the value (record or relationship)
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",
type: "user",
attributes: {
username: "@user"
}
}
}).then(function(user) {
userRef.value() === user;
});
reload Promise<record> public
Defined in ../packages/store/src/-private/legacy-model-support/record-reference.ts:211
- returns
- Promise<record>
the record for this RecordReference
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(...)
remoteType String public
Defined in ../packages/store/src/-private/legacy-model-support/record-reference.ts:98
- returns
- String
'identity'
How the reference will be looked up when it is loaded. Currently
this always returns identity
to signify that a record will be
loaded by its type
and id
.
Example
const userRef = store.getReference('user', 1);
userRef.remoteType(); // 'identity'
value Model public
Defined in ../packages/store/src/-private/legacy-model-support/record-reference.ts:165
- returns
- Model
the record for this RecordReference
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