Class Ember.Application

advanceReadiness public

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

Call advanceReadiness after any asynchronous setup logic has completed. Each call to deferReadiness must be matched by a call to advanceReadiness or the application will never become ready and routing will not begin.

buildRegistry (namespace) Ember.Registry public

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

namespace

Ember.Application

the application for which to build the registry

returns

Ember.Registry

the built registry

This creates a registry with the default Ember naming conventions.

It also configures the registry:

• registered views are created every time they are looked up (they are not singletons)
• registered templates are not factories; the registered value is returned directly.
• the router receives the application as its namespace property
• all controllers receive the router as their target and controllers properties
• all controllers receive the application as their namespace property
• the application view receives the application controller as its controller property
• the application view receives the application template as its defaultTemplate property

deferReadiness public

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

Use this to defer readiness until some condition is true.

Example:

1
2
3
4
5
6
7
8
9

var App = Ember.Application.create();

App.deferReadiness();

// Ember.$ is a reference to the jQuery object/function
Ember.$.getJSON('/auth-token', function(token) {
  App.token = token;
  App.advanceReadiness();
});

This allows you to perform asynchronous setup logic and defer booting your application until the setup has finished.

However, if the setup requires a loading UI, it might be better to use the router for this purpose.

hasRegistration (fullName) Boolean public

Inherited from RegistryProxyMixin packages/ember-runtime/lib/mixins/registry_proxy.js:110

fullName

String

returns

Boolean

Check if a factory is registered.

inject (factoryNameOrType, property, injectionName) public

Inherited from RegistryProxyMixin packages/ember-runtime/lib/mixins/registry_proxy.js:203

factoryNameOrType

String

property

String

injectionName

String

Define a dependency injection onto a specific factory or all factories of a type.

When Ember instantiates a controller, view, or other framework component it can attach a dependency to that component. This is often used to provide services to a set of framework components.

An example of providing a session object to all controllers:

1
2
3
4
5
6
7
8
9
10
11
12
13

var App = Ember.Application.create();
var Session = Ember.Object.extend({ isAuthenticated: false });

// A factory must be registered before it can be injected
App.register('session:main', Session);

// Inject 'session:main' onto all factories of the type 'controller'
// with the name 'session'
App.inject('controller', 'session', 'session:main');

App.IndexController = Ember.Controller.extend({
  isLoggedIn: Ember.computed.alias('session.isAuthenticated')
});

Injections can also be performed on specific factories.

1
2
3

App.inject(<full_name or type>, <property name>, <full_name>)
App.inject('route', 'source', 'source:main')
App.inject('route:application', 'email', 'model:email')

It is important to note that injections can only be performed on classes that are instantiated by Ember itself. Instantiating a class directly (via create or new) bypasses the dependency injection system.

Note: Ember-Data instantiates its models in a unique manner, and consequently injections onto models (or all models) will not work as expected. Injections on models can be enabled by setting Ember.MODEL_FACTORY_INJECTIONS to true.

register (fullName, factory, options) public

Inherited from RegistryProxyMixin packages/ember-runtime/lib/mixins/registry_proxy.js:29

fullName

String

type:name (e.g., 'model:user')

factory

Function

(e.g., App.Person)

options

Object

(optional) disable instantiation or singleton usage

Registers a factory that can be used for dependency injection (with inject) or for service lookup. Each factory is registered with a full name including two parts: type:name.

A simple example:

1
2
3
4

var App = Ember.Application.create();

App.Orange = Ember.Object.extend();
App.register('fruit:favorite', App.Orange);

Ember will resolve factories from the App namespace automatically. For example App.CarsController will be discovered and returned if an application requests controller:cars.

An example of registering a controller with a non-standard name:

1
2
3
4
5
6
7
8
9
10

var App = Ember.Application.create();
var Session = Ember.Controller.extend();

App.register('controller:session', Session);

// The Session controller can now be treated like a normal controller,
// despite its non-standard name.
App.ApplicationController = Ember.Controller.extend({
  needs: ['session']
});

Registered factories are instantiated by having create called on them. Additionally they are singletons, each time they are looked up they return the same instance.

Some examples modifying that default behavior:

1
2
3
4
5
6
7
8
9
10
11

var App = Ember.Application.create();

App.Person = Ember.Object.extend();
App.Orange = Ember.Object.extend();
App.Email = Ember.Object.extend();
App.session = Ember.Object.create();

App.register('model:user', App.Person, { singleton: false });
App.register('fruit:favorite', App.Orange);
App.register('communication:main', App.Email, { singleton: false });
App.register('session', App.session, { instantiate: false });

registerOption (fullName, optionName, options) public

Inherited from RegistryProxyMixin packages/ember-runtime/lib/mixins/registry_proxy.js:120

fullName

String

optionName

String

options

Object

Register an option for a particular factory.

registerOptions (fullName, options) public

Inherited from RegistryProxyMixin packages/ember-runtime/lib/mixins/registry_proxy.js:142

fullName

String

options

Object

Register options for a particular factory.

registerOptionsForType (type, options) public

Inherited from RegistryProxyMixin packages/ember-runtime/lib/mixins/registry_proxy.js:162

type

String

options

Object

Allow registering options for all factories of a type.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

var App = Ember.Application.create();
var appInstance = App.buildInstance();

// if all of type `connection` must not be singletons
appInstance.optionsForType('connection', { singleton: false });

appInstance.register('connection:twitter', TwitterConnection);
appInstance.register('connection:facebook', FacebookConnection);

var twitter = appInstance.lookup('connection:twitter');
var twitter2 = appInstance.lookup('connection:twitter');

twitter === twitter2; // => false

var facebook = appInstance.lookup('connection:facebook');
var facebook2 = appInstance.lookup('connection:facebook');

facebook === facebook2; // => false

registeredOption (fullName, optionName) Object public

Inherited from RegistryProxyMixin packages/ember-runtime/lib/mixins/registry_proxy.js:131

fullName

String

optionName

String

returns

Object

options

Return a specific registered option for a particular factory.

registeredOptions (fullName) Object public

Inherited from RegistryProxyMixin packages/ember-runtime/lib/mixins/registry_proxy.js:152

fullName

String

returns

Object

options

Return registered options for a particular factory.

registeredOptionsForType (type) Object public

Inherited from RegistryProxyMixin packages/ember-runtime/lib/mixins/registry_proxy.js:193

type

String

returns

Object

options

Return the registered options for all factories of a type.

reset public

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

Reset the application. This is typically used only in tests. It cleans up the application in the following order:

1. Deactivate existing routes
2. Destroy all objects in the container
3. Create a new application container
4. Re-route to the existing url

Typical Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

var App;

run(function() {
  App = Ember.Application.create();
});

module('acceptance test', {
  setup: function() {
    App.reset();
  }
});

test('first test', function() {
  // App is freshly reset
});

test('second test', function() {
  // App is again freshly reset
});

Advanced Example:

Occasionally you may want to prevent the app from initializing during setup. This could enable extra configuration, or enable asserting prior to the app becoming ready.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

var App;

run(function() {
  App = Ember.Application.create();
});

module('acceptance test', {
  setup: function() {
    run(function() {
      App.reset();
      App.deferReadiness();
    });
  }
});

test('first test', function() {
  ok(true, 'something before app is initialized');

  run(function() {
    App.advanceReadiness();
  });

  ok(true, 'something after app is initialized');
});

resolveRegistration (fullName) Function public

Inherited from RegistryProxyMixin packages/ember-runtime/lib/mixins/registry_proxy.js:19

fullName

String

returns

Function

fullName's factory

Given a fullName return the corresponding factory.

unregister (fullName) public

Inherited from RegistryProxyMixin packages/ember-runtime/lib/mixins/registry_proxy.js:90

fullName

String

Unregister a factory.

1
2
3
4
5
6
7
8

var App = Ember.Application.create();
var User = Ember.Object.extend();
App.register('model:user', User);

App.resolveRegistration('model:user').create() instanceof User //=> true

App.unregister('model:user')
App.resolveRegistration('model:user') === undefined //=> true

visit (url, options) Promise<Ember.ApplicationInstance, Error> public

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

url

String

The initial URL to navigate to

options

Ember.ApplicationInstance.BootOptions

returns

Promise<Ember.ApplicationInstance, Error>

Boot a new instance of Ember.ApplicationInstance for the current application and navigate it to the given url. Returns a Promise that resolves with the instance when the initial routing and rendering is complete, or rejects with any error that occured during the boot process.

When autoboot is disabled, calling visit would first cause the application to boot, which runs the application initializers.

This method also takes a hash of boot-time configuration options for customizing the instance's behavior. See the documentation on Ember.ApplicationInstance.BootOptions for details.

Ember.ApplicationInstance.BootOptions is an interface class that exists purely to document the available options; you do not need to construct it manually. Simply pass a regular JavaScript object containing of the desired options:

1

MyApp.visit("/", { location: "none", rootElement: "#container" });

Supported Scenarios

While the BootOptions class exposes a large number of knobs, not all combinations of them are valid; certain incompatible combinations might result in unexpected behavior.

For example, booting the instance in the full browser environment while specifying a foriegn document object (e.g. { isBrowser: true, document: iframe.contentDocument }) does not work correctly today, largely due to Ember's jQuery dependency.

Currently, there are three officially supported scenarios/configurations. Usages outside of these scenarios are not guaranteed to work, but please feel free to file bug reports documenting your experience and any issues you encountered to help expand support.

Browser Applications (Manual Boot)

The setup is largely similar to how Ember works out-of-the-box. Normally, Ember will boot a default instance for your Application on "DOM ready". However, you can customize this behavior by disabling autoboot.

For example, this allows you to render a miniture demo of your application into a specific area on your marketing website:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

import MyApp from 'my-app';

$(function() {
  let App = MyApp.create({ autoboot: false });

  let options = {
    // Override the router's location adapter to prevent it from updating
    // the URL in the address bar
    location: 'none',

    // Override the default `rootElement` on the app to render into a
    // specific `div` on the page
    rootElement: '#demo'
  };

  // Start the app at the special demo URL
  App.visit('/demo', options);
});

Or perhaps you might want to boot two instances of your app on the same page for a split-screen multiplayer experience:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

import MyApp from 'my-app';

$(function() {
  let App = MyApp.create({ autoboot: false });

  let sessionId = MyApp.generateSessionID();

  let player1 = App.visit(`/matches/join?name=Player+1&session=${sessionId}`, { rootElement: '#left', location: 'none' });
  let player2 = App.visit(`/matches/join?name=Player+2&session=${sessionId}`, { rootElement: '#right', location: 'none' });

  Promise.all([player1, player2]).then(() => {
    // Both apps have completed the initial render
    $('#loading').fadeOut();
  });
});

Do note that each app instance maintains their own registry/container, so they will run in complete isolation by default.

Server-Side Rendering (also known as FastBoot)

This setup allows you to run your Ember app in a server environment using Node.js and render its content into static HTML for SEO purposes.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

const HTMLSerializer = new SimpleDOM.HTMLSerializer(SimpleDOM.voidMap);

function renderURL(url) {
  let dom = new SimpleDOM.Document();
  let rootElement = dom.body;
  let options = { isBrowser: false, document: dom, rootElement: rootElement };

  return MyApp.visit(options).then(instance => {
    try {
      return HTMLSerializer.serialize(rootElement.firstChild);
    } finally {
      instance.destroy();
    }
  });
}

In this scenario, because Ember does not have access to a global document object in the Node.js environment, you must provide one explicitly. In practice, in the non-browser environment, the stand-in document object only need to implement a limited subset of the full DOM API. The SimpleDOM library is known to work.

Since there is no access to jQuery in the non-browser environment, you must also specify a DOM Element object in the same document for the rootElement option (as opposed to a selector string like "body").

See the documentation on the isBrowser, document and rootElement properties on Ember.ApplicationInstance.BootOptions for details.

Server-Side Resource Discovery

This setup allows you to run the routing layer of your Ember app in a server environment using Node.js and completely disable rendering. This allows you to simulate and discover the resources (i.e. AJAX requests) needed to fufill a given request and eagerly "push" these resources to the client.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

import BrowserNetworkService from 'app/services/network/browser';
import NodeNetworkService from 'app/services/network/node';

// Inject a (hypothetical) service for abstracting all AJAX calls and use
// the appropiate implementaion on the client/server. This also allows the
// server to log all the AJAX calls made during a particular request and use
// that for resource-discovery purpose.

export function initialize(application) {
  if (window) { // browser
    application.register('service:network', BrowserNetworkService);
  } else { // node
    application.register('service:network', NodeNetworkService);
  }

  application.inject('route', 'network', 'service:network');
};

export default {
  name: 'network-service',
  initialize: initialize
};

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

import Ember from 'ember';

// An example of how the (hypothetical) service is used in routes.

export default Ember.Route.extend({
  model(params) {
    return this.network.fetch(`/api/posts/${params.post_id}.json`);
  },

  afterModel(post) {
    if (post.isExternalContent) {
      return this.network.fetch(`/api/external/?url=${post.externalURL}`);
    } else {
      return post;
    }
  }
});

1
2
3
4
5
6
7
8

// Finally, put all the pieces together

function discoverResourcesFor(url) {
  return MyApp.visit(url, { isBrowser: false, shouldRender: false }).then(instance => {
    let networkService = instance.lookup('service:network');
    return networkService.requests; // => { "/api/posts/123.json": "..." }
  });
}