Class Router

addObserver (key, target, method) Ember.Observable public

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

key

String

The key to observe

target

Object

The target object to invoke

method

String|Function

The method to invoke

returns

Ember.Observable

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.

Observer Methods

Observer methods have the following signature:

import Component from '@ember/component';

export default Component.extend({
  init() {
    this._super(...arguments);
    this.addObserver('foo', this, 'fooDidChange');
  },

  fooDidChange(sender, key, value, rev) {
    // your code
  }
});

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.

Usually you will not need the value 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

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

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.

decrementProperty (keyName, decrement) Number public

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

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 EmberObject public

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

returns

EmberObject

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.

didTransition public

Defined in packages/ember-routing/lib/system/router.js:224

Available since v1.2.0

Handles updating the paths and notifying any listeners of the URL change.

Triggers the router level didTransition hook.

For example, to notify google analytics when the route changes, you could use this hook. (Note: requires also including GA scripts, etc.)

let Router = Ember.Router.extend({
  location: config.locationType,

  didTransition: function() {
    this._super(...arguments);

    return ga('send', 'pageview', {
      'page': this.get('url'),
      'title': this.get('url')
    });
  }
});

get (keyName) Object public

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

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: Ember.computed('firstName', 'lastName', function() {
  return this.get('firstName') + ' ' + this.get('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

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

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

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

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');

has (name) Boolean public

Inherited from Evented packages/ember-runtime/lib/mixins/evented.js:145

name

String

The name of the event

returns

Boolean

does the object have a subscription for event

Checks to see if object has any subscriptions for named event.

incrementProperty (keyName, increment) Number public

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

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

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

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

Example:

const Person = Ember.Object.extend({
  init() {
    alert(`Name is ${this.get('name')}`);
  }
});

let steve = Person.create({
  name: 'Steve'
});

// alerts 'Name is Steve'.

NOTE: If you do override init for a framework class like Ember.View, be sure to call this._super(...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.

map (callback) public

Defined in packages/ember-routing/lib/system/router.js:1341

callback

The Router.map function allows you to define mappings from URLs to routes in your application. These mappings are defined within the supplied callback function using this.route.

The first parameter is the name of the route which is used by default as the path name as well.

The second parameter is the optional options hash. Available options are:

• path: allows you to provide your own path as well as mark dynamic segments.
• resetNamespace: false by default; when nesting routes, ember will combine the route names to form the fully-qualified route name, which is used with {{link-to}} or manually transitioning to routes. Setting resetNamespace: true will cause the route not to inherit from its parent route's names. This is handy for preventing extremely long route names. Keep in mind that the actual URL path behavior is still retained.

The third parameter is a function, which can be used to nest routes. Nested routes, by default, will have the parent route tree's route name and path prepended to it's own.

Router.map(function(){
  this.route('post', { path: '/post/:post_id' }, function() {
    this.route('edit');
    this.route('comments', { resetNamespace: true }, function() {
      this.route('new');
    });
  });
});

For more detailed documentation and examples please see the guides.

notifyPropertyChange (keyName) Observable public

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

keyName

String

The property key to be notified about.

returns

Observable

Convenience method to call propertyWillChange and propertyDidChange in succession.

off (name, target, method) public

Inherited from Evented packages/ember-runtime/lib/mixins/evented.js:130

name

String

The name of the event

target

Object

The target of the subscription

method

Function

The function of the subscription

returns

this

Cancels subscription for given name, target, and method.

on (name, target, method) public

Inherited from Evented packages/ember-runtime/lib/mixins/evented.js:55

name

String

The name of the event

target

Object

The "this" binding for the callback

method

Function

The callback to execute

returns

this

Subscribes to a named event with given function.

person.on('didLoad', function() {
  // fired once the person has loaded
});

An optional target can be passed in as the 2nd argument that will be set as the "this" for the callback. This is a good way to give your function access to the object triggering the event. When the target parameter is used the callback becomes the third argument.

one (name, target, method) public

Inherited from Evented packages/ember-runtime/lib/mixins/evented.js:81

name

String

The name of the event

target

Object

The "this" binding for the callback

method

Function

The callback to execute

returns

this

Subscribes a function to a named event and then cancels the subscription after the first time the event is triggered. It is good to use one when you only care about the first time an event has taken place.

This function takes an optional 2nd argument that will become the "this" value for the callback. If this argument is passed then the 3rd argument becomes the function.

removeObserver (key, target, method) Ember.Observable public

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

key

String

The key to observe

target

Object

The target object to invoke

method

String|Function

The method to invoke

returns

Ember.Observable

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.

set (keyName, value) Object public

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

keyName

String

The property to set

value

Object

The value to set or `null`.

returns

Object

The passed value

Sets the provided key or path to the value.

record.set("key", 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.

setProperties (hash) Object public

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

hash

Object

the hash of keys and values to set

returns

Object

The passed in hash

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

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

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.

const Person = Ember.Object.extend()
person = Person.create()
person.toString() //=> "<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:

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

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

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

toggleProperty (keyName) Boolean public

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

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');

transitionTo (name, models, options) Transition public

Defined in packages/ember-routing/lib/system/router.js:357

name

String

the name of the route or a URL

models

...Object

the model(s) or identifier(s) to be used while transitioning to the route.

options

Object

optional hash with a queryParams property containing a mapping of query parameters

returns

Transition

the transition object associated with this attempted transition

Transition the application into another route. The route may be either a single route or route path:

See Route.transitionTo for more info.

trigger (name, args) public

Inherited from Evented packages/ember-runtime/lib/mixins/evented.js:107

name

String

The name of the event

args

Object...

Optional arguments to pass on

Triggers a named event for the object. Any additional arguments will be passed as parameters to the functions that are subscribed to the event.

person.on('didEat', function(food) {
  console.log('person ate some ' + food);
});

person.trigger('didEat', 'broccoli');

// outputs: person ate some broccoli

willDestroy public

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

Override to implement teardown.

willTransition public

Defined in packages/ember-routing/lib/system/router.js:324

Available since v1.11.0

Handles notifying any listeners of an impending URL change.

Triggers the router level willTransition hook.