home
  • Blog
  • Home
  • Projects
    • Ember
    • EmberData
    • Ember CLI
1.13
  • Packages
    • ember
    • ember-application
    • ember-debug
    • ember-extension-support
    • ember-htmlbars
    • ember-metal
    • ember-routing
    • ember-routing-htmlbars
    • ember-routing-views
    • ember-runtime
    • ember-templates
    • ember-testing
    • ember-views
  • Namespaces
    • Ember
    • Ember.FEATURES
    • Ember.String
    • Ember.computed
    • Ember.inject
    • Ember.run
  • Classes
    • Ember.Application
    • Ember.Array
    • Ember.ArrayProxy
    • Ember.Binding
    • Ember.Checkbox
    • Ember.Component
    • Ember.ComputedProperty
    • Ember.ContainerDebugAdapter
    • Ember.Controller
    • Ember.ControllerMixin
    • Ember.CoreObject
    • Ember.DataAdapter
    • Ember.DefaultResolver
    • Ember.Error
    • Ember.Evented
    • Ember.Helper
    • Ember.InstrumentationSupport
    • Ember.Logger
    • Ember.Mixin
    • Ember.MutableArray
    • Ember.MutableEnumerable
    • Ember.Namespace
    • Ember.NativeArray
    • Ember.Object
    • Ember.Observable
    • Ember.PromiseProxyMixin
    • Ember.Route
    • Ember.Router
    • Ember.Service
    • Ember.Test
    • Ember.Test.Adapter
    • Ember.Test.QUnitAdapter
    • Ember.TextArea
    • Ember.TextField
    • Ember.VisibilitySupport
    • RSVP.EventTarget
    • RSVP.Promise

Class Ember.DefaultResolver public


Extends: Ember.Object
Defined in: packages/ember-application/lib/system/resolver.js:39
Module: ember

The DefaultResolver defines the default lookup rules to resolve container lookups before consulting the container for registered items:

  • templates are looked up on Ember.TEMPLATES
  • other names are looked up on the application after converting the name. For example, controller:post looks up App.PostController by default.
  • there are some nuances (see examples below)

How Resolving Works

The container calls this object's resolve method with the fullName argument.

It first parses the fullName into an object using parseName.

Then it checks for the presence of a type-specific instance method of the form resolve[Type] and calls it if it exists. For example if it was resolving 'template:post', it would call the resolveTemplate method.

Its last resort is to call the resolveOther method.

The methods of this object are designed to be easy to override in a subclass. For example, you could enhance how a template is resolved like so:

App = Ember.Application.create({
  Resolver: Ember.DefaultResolver.extend({
    resolveTemplate: function(parsedName) {
      var resolvedTemplate = this._super(parsedName);
      if (resolvedTemplate) { return resolvedTemplate; }
      return Ember.TEMPLATES['not_found'];
    }
  })
});

Some examples of how names are resolved:

'template:post'           //=> Ember.TEMPLATES['post']
'template:posts/byline'   //=> Ember.TEMPLATES['posts/byline']
'template:posts.byline'   //=> Ember.TEMPLATES['posts/byline']
'template:blogPost'       //=> Ember.TEMPLATES['blogPost']
                          //   OR
                          //   Ember.TEMPLATES['blog_post']
'controller:post'         //=> App.PostController
'controller:posts.index'  //=> App.PostsIndexController
'controller:blog/post'    //=> Blog.PostController
'controller:basic'        //=> Ember.Controller
'route:post'              //=> App.PostRoute
'route:posts.index'       //=> App.PostsIndexRoute
'route:blog/post'         //=> Blog.PostRoute
'route:basic'             //=> Ember.Route
'view:post'               //=> App.PostView
'view:posts.index'        //=> App.PostsIndexView
'view:blog/post'          //=> Blog.PostView
'view:basic'              //=> Ember.View
'foo:post'                //=> App.PostFoo
'model:post'              //=> App.Post


Methods

addObserver (key, target, method) public

Module: ember

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:347

key
String

The key to observer

target
Object

The target object to invoke

method
String|Function

The method to invoke.

Adds an observer on a property.

This is the core method used to register an observer for a property.

Once you call this method, any time the key's value is set, your observer will be notified. Note that the observers are triggered any time the value is set, regardless of whether it has actually changed. Your observer should be prepared to handle that.

You can also pass an optional context parameter to this method. The context will be passed to your observer method whenever it is triggered. Note that if you add the same target/method pair on a key multiple times with different context parameters, your observer will only be called once with the last context you passed.

Observer Methods

Observer methods you pass should generally have the following signature if you do not pass a context parameter:

fooDidChange: function(sender, key, value, rev) { };

The sender is the object that changed. The key is the property that changes. The value property is currently reserved and unused. The rev is the last property revision of the object when it changed, which you can use to detect if the key value has really changed or not.

If you pass a context parameter, the context will be passed before the revision like so:

fooDidChange: function(sender, key, value, context, rev) { };

Usually you will not need the value, context or revision parameters at the end. In this case, it is common to write observer methods that take only a sender and key value as parameters or, if you aren't interested in any of these values, to write an observer that has no parameters at all.

cacheFor (keyName) : Object public

Module: ember

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:507

keyName
String
returns
Object

The cached value of the computed property, if any

Returns the cached value of a computed property, if it exists. This allows you to inspect the value of a computed property without accidentally invoking it if it is intended to be generated lazily.

create (arguments) public

Module: ember

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:603

arguments

Creates an instance of a class. Accepts either no arguments, or an object containing values to initialize the newly instantiated object with.

App.Person = Ember.Object.extend({
  helloWorld: function() {
    alert("Hi, my name is " + this.get('name'));
  }
});

var tom = App.Person.create({
  name: 'Tom Dale'
});

tom.helloWorld(); // alerts "Hi, my name is Tom Dale".

create will call the init function if defined during Ember.AnyObject.extend

If no arguments are passed to create, it will not set values to the new instance during initialization:

var noName = App.Person.create();
noName.helloWorld(); // alerts undefined

NOTE: For performance reasons, you cannot declare methods or computed properties during create. You should instead declare methods and computed properties when using extend.

decrementProperty (keyName, decrement) : Number public

Module: ember

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:468

keyName
String

The name of the property to decrement

decrement
Number

The amount to decrement by. Defaults to 1

returns
Number

The new property value

Set the value of a property to the current value minus some amount.

player.decrementProperty('lives');
orc.decrementProperty('health', 5);

destroy : Ember.Object public

Module: ember

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:366

returns
Ember.Object

receiver

Destroys an object by setting the isDestroyed flag and removing its metadata, which effectively destroys observers and bindings.

If you try to set a property on a destroyed object, an exception will be raised.

Note that destruction is scheduled for the end of the run loop and does not happen immediately. It will set an isDestroying flag immediately.

extend (mixins, arguments) public

Module: ember

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:481

mixins
Mixin

One or more Mixin classes

arguments
Object

Object containing values to use within the new class

Creates a new subclass.

App.Person = Ember.Object.extend({
  say: function(thing) {
    alert(thing);
   }
});

This defines a new subclass of Ember.Object: App.Person. It contains one method: say().

You can also create a subclass from any existing class by calling its extend() method. For example, you might want to create a subclass of Ember's built-in Ember.View class:

App.PersonView = Ember.View.extend({
  tagName: 'li',
  classNameBindings: ['isAdministrator']
});

When defining a subclass, you can override methods but still access the implementation of your parent class by calling the special _super() method:

App.Person = Ember.Object.extend({
  say: function(thing) {
    var name = this.get('name');
    alert(name + ' says: ' + thing);
  }
});

App.Soldier = App.Person.extend({
  say: function(thing) {
    this._super(thing + ", sir!");
  },
  march: function(numberOfHours) {
    alert(this.get('name') + ' marches for ' + numberOfHours + ' hours.')
  }
});

var yehuda = App.Soldier.create({
  name: "Yehuda Katz"
});

yehuda.say("Yes");  // alerts "Yehuda Katz says: Yes, sir!"

The create() on line #17 creates an instance of the App.Soldier class. The extend() on line #8 creates a subclass of App.Person. Any instance of the App.Person class will not have the march() method.

You can also pass Mixin classes to add additional properties to the subclass.

App.Person = Ember.Object.extend({
  say: function(thing) {
    alert(this.get('name') + ' says: ' + thing);
  }
});

App.SingingMixin = Mixin.create({
  sing: function(thing){
    alert(this.get('name') + ' sings: la la la ' + thing);
  }
});

App.BroadwayStar = App.Person.extend(App.SingingMixin, {
  dance: function() {
    alert(this.get('name') + ' dances: tap tap tap tap ');
  }
});

The App.BroadwayStar class contains three methods: say(), sing(), and dance().

get (keyName) : Object public

Module: ember

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:99

keyName
String

The property to retrieve

returns
Object

The property value or undefined.

Retrieves the value of a property from the object.

This method is usually similar to using object[keyName] or object.keyName, however it supports both computed properties and the unknownProperty handler.

Because get unifies the syntax for accessing all these kinds of properties, it can make many refactorings easier, such as replacing a simple property with a computed property, or vice versa.

Computed Properties

Computed properties are methods defined with the property modifier declared at the end, such as:

fullName: function() {
  return this.get('firstName') + ' ' + this.get('lastName');
}.property('firstName', 'lastName')

When you call get on a computed property, the function will be called and the return value will be returned instead of the function itself.

Unknown Properties

Likewise, if you try to call get on a property whose value is undefined, the unknownProperty() method will be called on the object. If this method returns any value other than undefined, it will be returned instead. This allows you to implement "virtual" properties that are not defined upfront.

getProperties (list) : Object public

Module: ember

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:142

list
String...|Array

of keys to get

returns
Object

To get the values of multiple properties at once, call getProperties with a list of strings or an array:

record.getProperties('firstName', 'lastName', 'zipCode');
// { firstName: 'John', lastName: 'Doe', zipCode: '10011' }

is equivalent to:

record.getProperties(['firstName', 'lastName', 'zipCode']);
// { firstName: 'John', lastName: 'Doe', zipCode: '10011' }

getWithDefault (keyName, defaultValue) : Object public

Module: ember

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:429

keyName
String

The name of the property to retrieve

defaultValue
Object

The value to return if the property value is undefined

returns
Object

The property value or the defaultValue.

Retrieves the value of a property, or a default value in the case that the property returns undefined.

person.getWithDefault('lastName', 'Doe');

incrementProperty (keyName, increment) : Number public

Module: ember

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:447

keyName
String

The name of the property to increment

increment
Number

The amount to increment by. Defaults to 1

returns
Number

The new property value

Set the value of a property to the current value plus some amount.

person.incrementProperty('age');
team.incrementProperty('score', 2);

init public

Module: ember

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:238

An overridable method called when objects are instantiated. By default, does nothing unless it is overridden during class definition.

Example:

App.Person = Ember.Object.extend({
  init: function() {
    alert('Name is ' + this.get('name'));
  }
});

var steve = App.Person.create({
  name: "Steve"
});

// alerts 'Name is Steve'.

NOTE: If you do override init for a framework class like Ember.View or Ember.ArrayController, be sure to call this._super.apply(this, arguments) in your init declaration! If you don't, Ember may not have an opportunity to do important setup work, and you'll see strange behavior in your application.

lookupDescription (fullName) public

Module: ember

Defined in packages/ember-application/lib/system/resolver.js:242

fullName
String

the lookup string

Returns a human-readable description for a fullName. Used by the Application namespace in assertions to describe the precise name of the class that Ember is looking for, rather than container keys.

notifyPropertyChange (keyName) : Ember.Observable public

Module: ember

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:327

keyName
String

The property key to be notified about.

returns
Ember.Observable

Convenience method to call propertyWillChange and propertyDidChange in succession.

parseName (fullName) public

Module: ember

Defined in packages/ember-application/lib/system/resolver.js:188

fullName
String

the lookup string

Convert the string name of the form 'type:name' to a Javascript object with the parsed aspects of the name broken out.

removeObserver (key, target, method) public

Module: ember

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:399

key
String

The key to observer

target
Object

The target object to invoke

method
String|Function

The method to invoke.

Remove an observer you have previously registered on this object. Pass the same key, target, and method you passed to addObserver() and your target will no longer receive notifications.

reopen public

Module: ember

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:649

Augments a constructor's prototype with additional properties and functions:

MyObject = Ember.Object.extend({
  name: 'an object'
});

o = MyObject.create();
o.get('name'); // 'an object'

MyObject.reopen({
  say: function(msg){
    console.log(msg);
  }
})

o2 = MyObject.create();
o2.say("hello"); // logs "hello"

o.say("goodbye"); // logs "goodbye"

To add functions and properties to the constructor itself, see reopenClass

reopenClass public

Module: ember

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:685

Augments a constructor's own properties and functions:

MyObject = Ember.Object.extend({
  name: 'an object'
});

MyObject.reopenClass({
  canBuild: false
});

MyObject.canBuild; // false
o = MyObject.create();

In other words, this creates static properties and functions for the class. These are only available on the class and not on any instance of that class.

App.Person = Ember.Object.extend({
  name : "",
  sayHello : function() {
    alert("Hello. My name is " + this.get('name'));
  }
});

App.Person.reopenClass({
  species : "Homo sapiens",
  createPerson: function(newPersonsName){
    return App.Person.create({
      name:newPersonsName
    });
  }
});

var tom = App.Person.create({
  name : "Tom Dale"
});
var yehuda = App.Person.createPerson("Yehuda Katz");

tom.sayHello(); // "Hello. My name is Tom Dale"
yehuda.sayHello(); // "Hello. My name is Yehuda Katz"
alert(App.Person.species); // "Homo sapiens"

Note that species and createPerson are not valid on the tom and yehuda variables. They are only valid on App.Person.

To add functions and properties to instances of a constructor by extending the constructor's prototype see reopen

resolve (fullName) : Object public

Module: ember

Defined in packages/ember-application/lib/system/resolver.js:156

fullName
String

the lookup string

returns
Object

the resolved factory

This method is called via the container's resolver method. It parses the provided fullName and then looks up and returns the appropriate template or class.

resolveController (parsedName) public

Module: ember

Defined in packages/ember-application/lib/system/resolver.js:326

parsedName
Object

a parseName object with the parsed fullName lookup string

Lookup the controller using resolveOther

resolveHelper (parsedName) public

Module: ember

Defined in packages/ember-application/lib/system/resolver.js:368

parsedName
Object

a parseName object with the parsed fullName lookup string

Look up the specified object (from parsedName) on the appropriate namespace (usually on the Application)

resolveModel (parsedName) public

Module: ember

Defined in packages/ember-application/lib/system/resolver.js:353

parsedName
Object

a parseName object with the parsed fullName lookup string

Lookup the model on the Application namespace

resolveOther (parsedName) public

Module: ember

Defined in packages/ember-application/lib/system/resolver.js:381

parsedName
Object

a parseName object with the parsed fullName lookup string

Look up the specified object (from parsedName) on the appropriate namespace (usually on the Application)

resolveRoute (parsedName) public

Module: ember

Defined in packages/ember-application/lib/system/resolver.js:339

parsedName
Object

a parseName object with the parsed fullName lookup string

Lookup the route using resolveOther

resolveTemplate (parsedName) public

Module: ember

Defined in packages/ember-application/lib/system/resolver.js:290

parsedName
Object

a parseName object with the parsed fullName lookup string

Look up the template in Ember.TEMPLATES

resolveView (parsedName) public

Module: ember

Defined in packages/ember-application/lib/system/resolver.js:312

parsedName
Object

a parseName object with the parsed fullName lookup string

Lookup the view using resolveOther

set (keyName, value) : Ember.Observable public

Module: ember

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:167

keyName
String

The property to set

value
Object

The value to set or null.

returns
Ember.Observable

Sets the provided key or path to the value.

This method is generally very similar to calling object[key] = value or object.key = value, except that it provides support for computed properties, the setUnknownProperty() method and property observers.

Computed Properties

If you try to set a value on a key that has a computed property handler defined (see the get() method for an example), then set() will call that method, passing both the value and key instead of simply changing the value itself. This is useful for those times when you need to implement a property that is composed of one or more member properties.

Unknown Properties

If you try to set a value on a key that is undefined in the target object, then the setUnknownProperty() handler will be called instead. This gives you an opportunity to implement complex "virtual" properties that are not predefined on the object. If setUnknownProperty() returns undefined, then set() will simply set the value on the object.

Property Observers

In addition to changing the property, set() will also register a property change with the object. Unless you have placed this call inside of a beginPropertyChanges() and endPropertyChanges(), any "local" observers (i.e. observer methods declared on the same object), will be called immediately. Any "remote" observers (i.e. observer methods declared on another object) will be placed in a queue and called at a later time in a coalesced manner.

Chaining

In addition to property changes, set() returns the value of the object itself so you can do chaining like this:

record.set('firstName', 'Charles').set('lastName', 'Jolley');

setProperties (hash) : Ember.Observable public

Module: ember

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:222

hash
Object

the hash of keys and values to set

returns
Ember.Observable

Sets a list of properties at once. These properties are set inside a single beginPropertyChanges and endPropertyChanges batch, so observers will be buffered.

record.setProperties({ firstName: 'Charles', lastName: 'Jolley' });

toString : String public

Module: ember

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:416

returns
String

string representation

Returns a string representation which attempts to provide more information than Javascript's toString typically does, in a generic way for all Ember objects.

App.Person = Em.Object.extend()
person = App.Person.create()
person.toString() //=> "<App.Person:ember1024>"

If the object's class is not defined on an Ember namespace, it will indicate it is a subclass of the registered superclass:

Student = App.Person.extend()
student = Student.create()
student.toString() //=> "<(subclass of App.Person):ember1025>"

If the method toStringExtension is defined, its return value will be included in the output.

App.Teacher = App.Person.extend({
  toStringExtension: function() {
    return this.get('fullName');
  }
});
teacher = App.Teacher.create()
teacher.toString(); //=> "<App.Teacher:ember1026:Tom Dale>"

toggleProperty (keyName) : Boolean public

Module: ember

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:489

keyName
String

The name of the property to toggle

returns
Boolean

The new property value

Set the value of a boolean property to the opposite of its current value.

starship.toggleProperty('warpDriveEngaged');

useRouterNaming (parsedName) public

Module: ember

Defined in packages/ember-application/lib/system/resolver.js:274

parsedName
Object

a parseName object with the parsed fullName lookup string

Given a parseName object (output from parseName), apply the conventions expected by Ember.Router

willDestroy public

Module: ember

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:389

Override to implement teardown.

Properties

concatenatedProperties public

Module: ember

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:273

Defines the properties that will be concatenated from the superclass (instead of overridden).

By default, when you extend an Ember class a property defined in the subclass overrides a property with the same name that is defined in the superclass. However, there are some cases where it is preferable to build up a property's value by combining the superclass' property value with the subclass' value. An example of this in use within Ember is the classNames property of Ember.View.

Here is some sample code showing the difference between a concatenated property and a normal one:

App.BarView = Ember.View.extend({
  someNonConcatenatedProperty: ['bar'],
  classNames: ['bar']
});

App.FooBarView = App.BarView.extend({
  someNonConcatenatedProperty: ['foo'],
  classNames: ['foo']
});

var fooBarView = App.FooBarView.create();
fooBarView.get('someNonConcatenatedProperty'); // ['foo']
fooBarView.get('classNames'); // ['ember-view', 'bar', 'foo']

This behavior extends to object creation as well. Continuing the above example:

var view = App.FooBarView.create({
  someNonConcatenatedProperty: ['baz'],
  classNames: ['baz']
})
view.get('someNonConcatenatedProperty'); // ['baz']
view.get('classNames'); // ['ember-view', 'bar', 'foo', 'baz']

Adding a single property that is not an array will just add it in the array:

var view = App.FooBarView.create({
  classNames: 'baz'
})
view.get('classNames'); // ['ember-view', 'bar', 'foo', 'baz']

Using the concatenatedProperties property, we can tell Ember to mix the content of the properties.

In Ember.View the classNameBindings and attributeBindings properties are also concatenated, in addition to classNames.

This feature is available for you to use throughout the Ember object model, although typical app developers are likely to use it infrequently. Since it changes expectations about behavior of properties, you should properly document its usage in each individual concatenated property (to not mislead your users to think they can override the property in a subclass).

isDestroyed public

Module: ember

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:342

Destroyed object property flag.

if this property is true the observers and bindings were already removed by the effect of calling the destroy() method.

isDestroying public

Module: ember

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:354

Destruction scheduled flag. The destroy() method has been called.

The object stays intact until the end of the run loop at which point the isDestroyed flag is set.

namespace public

Module: ember

Defined in packages/ember-application/lib/system/resolver.js:112

This will be set to the Application instance when it is created.

On this page


Methods

  • addObserver
  • cacheFor
  • create
  • decrementProperty
  • destroy
  • extend
  • get
  • getProperties
  • getWithDefault
  • incrementProperty
  • init
  • lookupDescription
  • notifyPropertyChange
  • parseName
  • removeObserver
  • reopen
  • reopenClass
  • resolve
  • resolveController
  • resolveHelper
  • resolveModel
  • resolveOther
  • resolveRoute
  • resolveTemplate
  • resolveView
  • set
  • setProperties
  • toString
  • toggleProperty
  • useRouterNaming
  • willDestroy

Properties

  • concatenatedProperties
  • isDestroyed
  • isDestroying
  • namespace
Team Sponsors Security Legal Branding Community Guidelines
Twitter GitHub Discord Mastodon

If you want help you can contact us by email, open an issue, or get realtime help by joining the Ember Discord.

© Copyright 2025 - Tilde Inc.
Ember.js is free, open source and always will be.


Ember is generously supported by
blue Created with Sketch.