DS.Errors Class
Holds validation errors for a given record, organized by attribute names.
Every DS.Model
has an errors
property that is an instance of
DS.Errors
. This can be used to display validation error
messages returned from the server when a record.save()
rejects.
For Example, if you had a User
model that looked like this:
import DS from 'ember-data';
export default DS.Model.extend({
username: DS.attr('string'),
email: DS.attr('string')
});
And you attempted to save a record that did not validate on the backend:
let user = store.createRecord('user', {
username: 'tomster',
email: 'invalidEmail'
});
user.save();
Your backend would be expected to return an error response that described the problem, so that error messages can be generated on the app.
API responses will be translated into instances of DS.Errors
differently,
depending on the specific combination of adapter and serializer used. You
may want to check the documentation or the source code of the libraries
that you are using, to know how they expect errors to be communicated.
Errors can be displayed to the user by accessing their property name to get an array of all the error objects for that property. Each error object is a JavaScript object with two keys:
message
A string containing the error message from the backendattribute
The name of the property associated with this error message
<label>Username: {{input value=username}} </label>
{{#each model.errors.username as |error|}}
<div class="error">
{{error.message}}
</div>
{{/each}}
<label>Email: {{input value=email}} </label>
{{#each model.errors.email as |error|}}
<div class="error">
{{error.message}}
</div>
{{/each}}
You can also access the special messages
property on the error
object to get an array of all the error strings.
{{#each model.errors.messages as |message|}}
<div class="error">
{{message}}
</div>
{{/each}}
Item Index
Methods
- _add
- _clear
- _findOrCreateMessages
- _registerHandlers
- _remove
- add deprecated
- clear deprecated
- errorsFor
- has
- remove deprecated
- unknownProperty
Properties
Methods
_add
()
private
Adds error messages to a given attribute without sending event.
_clear
()
private
Removes all error messages. to the record.
_findOrCreateMessages
()
private
_registerHandlers
()
private
Register with target handler
_remove
()
private
Removes all error messages from the given attribute without sending event.
add
-
attribute
-
messages
Adds error messages to a given attribute and sends
becameInvalid
event to the record.
Example:
if (!user.get('username') {
user.get('errors').add('username', 'This field is required');
}
Parameters:
-
attribute
String -
messages
(Array | String)
clear
()
deprecated
Removes all error messages and sends becameValid
event
to the record.
Example:
import Route from '@ember/routing/route';
export default Route.extend({
actions: {
retrySave: function(user) {
user.get('errors').clear();
user.save();
}
}
});
errorsFor
-
attribute
Returns errors for a given attribute
let user = store.createRecord('user', {
username: 'tomster',
email: 'invalidEmail'
});
user.save().catch(function(){
user.get('errors').errorsFor('email'); // returns:
// [{attribute: "email", message: "Doesn't look like a valid email."}]
});
Parameters:
-
attribute
String
Returns:
has
-
attribute
Checks if there are error messages for the given attribute.
import Route from '@ember/routing/route';
export default Route.extend({
actions: {
save: function(user) {
if (user.get('errors').has('email')) {
return alert('Please update your email before attempting to save.');
}
user.save();
}
}
});
Parameters:
-
attribute
String
Returns:
true if there some errors on given attribute
remove
-
attribute
Removes all error messages from the given attribute and sends
becameValid
event to the record if there no more errors left.
Example:
import DS from 'ember-data';
export default DS.Model.extend({
email: DS.attr('string'),
twoFactorAuth: DS.attr('boolean'),
phone: DS.attr('string')
});
import Route from '@ember/routing/route';
export default Route.extend({
actions: {
save: function(user) {
if (!user.get('twoFactorAuth')) {
user.get('errors').remove('phone');
}
user.save();
}
}
});
Parameters:
-
attribute
String
unknownProperty
()
private
Properties
content
Array
private
errorsByAttributeName
MapWithDefault
private
isEmpty
Boolean
length
Number
Total number of errors.
messages
Array
An array containing all of the error messages for this record. This is useful for displaying all errors to the user.
{{#each model.errors.messages as |message|}}
<div class="error">
{{message}}
</div>
{{/each}}