{{person.signature}}
\n```\n\nYou can use `yield` inside a template to\ninclude the **contents** of any block attached to\nthe component. The block will be executed in the\ncontext of the surrounding context or outer controller:\n\n```handlebars\n{{#person-profile person=currentUser}}\nAdmin mode
\n {{! Executed in the controller's context. }}\n{{/person-profile}}\n```\n\n```app/components/person-profile.hbs\nmessage - The message received from the deprecation call.options - An object passed in with the deprecation call containing additional information including:id - An id of the deprecation in the form of package-name.specific-deprecation.until - The Ember version number the feature and deprecation will be removed in.next - A function that calls into the previously registered handler.message - The message received from the warn call. options - An object passed in with the warn call containing additional information including:id - An id of the warning in the form of package-name.specific-warning.next - A function that calls into the previously registered handler.Sorry, nobody is available for this task.
\n{{/each}}\n```", "itemtype": "method", "name": "each", "access": "public", "tagname": "", "class": "Ember.Templates.helpers", "module": "ember" }, { "file": "packages/ember-glimmer/lib/helpers/each-in.ts", "line": 86, "description": "The `{{each-in}}` helper loops over properties on an object.\n\nFor example, given a `user` object that looks like:\n\n```javascript\n{\n \"name\": \"Shelly Sails\",\n \"age\": 42\n}\n```\n\nThis template would display all properties on the `user`\nobject in a list:\n\n```handlebars\n| `readonly` | `required` | `autofocus` |
| `value` | `placeholder` | `disabled` |
| `size` | `tabindex` | `maxlength` |
| `name` | `min` | `max` |
| `pattern` | `accept` | `autocomplete` |
| `autosave` | `formaction` | `formenctype` |
| `formmethod` | `formnovalidate` | `formtarget` |
| `height` | `inputmode` | `multiple` |
| `step` | `width` | `form` |
| `selectionDirection` | `spellcheck` |
{{ValidationError}}
\n {{/if}}\n First name:\n{{/labeled-textfield}}\n```\n\n```app/templates/components/labeled-textfield.hbs\n\n```\n\nResult:\n\n```html\n\n```", "itemtype": "method", "name": "yield", "params": [ { "name": "options", "description": "", "type": "Hash" } ], "return": { "description": "HTML string", "type": "String" }, "access": "public", "tagname": "", "class": "Ember.Templates.helpers", "module": "ember" }, { "file": "packages/ember-glimmer/lib/index.ts", "line": 179, "description": "Execute the `debugger` statement in the current template's context.\n\n```handlebars\n{{debugger}}\n```\n\nWhen using the debugger helper you will have access to a `get` function. This\nfunction retrieves values available in the context of the template.\nFor example, if you're wondering why a value `{{foo}}` isn't rendering as\nexpected within a template, you could place a `{{debugger}}` statement and,\nwhen the `debugger;` breakpoint is hit, you can attempt to retrieve this value:\n\n```\n> get('foo')\n```\n\n`get` is also aware of keywords. So in this situation\n\n```handlebars\n{{#each items as |item|}}\n {{debugger}}\n{{/each}}\n```\n\nYou'll be able to get values from the current item:\n\n```\n> get('item.name')\n```\n\nYou can also access the context of the view to make sure it is the object that\nyou expect:\n\n```\n> context\n```", "itemtype": "method", "name": "debugger", "access": "public", "tagname": "", "class": "Ember.Templates.helpers", "module": "ember" }, { "file": "packages/ember-glimmer/lib/index.ts", "line": 222, "description": "The `partial` helper renders another template without\nchanging the template context:\n\n```handlebars\n{{foo}}\n{{partial \"nav\"}}\n```\n\nThe above example template will render a template named\n\"-nav\", which has the same context as the parent template\nit's rendered into, so if the \"-nav\" template also referenced\n`{{foo}}`, it would print the same thing as the `{{foo}}`\nin the above example.\n\nIf a \"-nav\" template isn't found, the `partial` helper will\nfall back to a template named \"nav\".\n\n### Bound template names\n\nThe parameter supplied to `partial` can also be a path\nto a property containing a template name, e.g.:\n\n```handlebars\n{{partial someTemplateName}}\n```\n\nThe above example will look up the value of `someTemplateName`\non the template context (e.g. a controller) and use that\nvalue as the name of the template to render. If the resolved\nvalue is falsy, nothing will be rendered. If `someTemplateName`\nchanges, the partial will be re-rendered using the new template\nname.", "itemtype": "method", "name": "partial", "params": [ { "name": "partialName", "description": "The name of the template to render minus the leading underscore.", "type": "String" } ], "access": "public", "tagname": "", "class": "Ember.Templates.helpers", "module": "ember" }, { "file": "packages/ember-metal/lib/computed.js", "line": 159, "description": "Call on a computed property to set it into non-cached mode. When in this\nmode the computed property will not automatically cache the return value.\n\nIt also does not automatically fire any change events. You must manually notify\nany changes if you want to observe this property.\n\nDependency keys have no effect on volatile properties as they are for cache\ninvalidation and notification when cached value is invalidated.\n\n```javascript\nimport EmberObject, { computed } from '@ember/object';\n\nlet outsideService = EmberObject.extend({\n value: computed(function() {\n return OutsideService.getValue();\n }).volatile()\n}).create();\n```", "itemtype": "method", "name": "volatile", "return": { "description": "this", "type": "ComputedProperty" }, "chainable": 1, "access": "public", "tagname": "", "class": "ComputedProperty", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/computed.js", "line": 189, "description": "Call on a computed property to set it into read-only mode. When in this\nmode the computed property will throw an error when set.\n\n```javascript\nimport EmberObject, { computed } from '@ember/object';\n\nlet Person = EmberObject.extend({\n guid: computed(function() {\n return 'guid-guid-guid';\n }).readOnly()\n});\n\nlet person = Person.create();\n\nperson.set('guid', 'new-guid'); // will throw an exception\n```", "itemtype": "method", "name": "readOnly", "return": { "description": "this", "type": "ComputedProperty" }, "chainable": 1, "access": "public", "tagname": "", "class": "ComputedProperty", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/computed.js", "line": 218, "description": "Sets the dependent keys on this computed property. Pass any number of\narguments containing key paths that this computed property depends on.\n\n```javascript\nimport EmberObject, { computed } from '@ember/object';\n\nlet President = EmberObject.extend({\n fullName: computed('firstName', 'lastName', function() {\n return this.get('firstName') + ' ' + this.get('lastName');\n\n // Tell Ember that this computed property depends on firstName\n // and lastName\n })\n});\n\nlet president = President.create({\n firstName: 'Barack',\n lastName: 'Obama'\n});\n\npresident.get('fullName'); // 'Barack Obama'\n```", "itemtype": "method", "name": "property", "params": [ { "name": "path", "description": "zero or more property paths", "type": "String", "multiple": true } ], "return": { "description": "this", "type": "ComputedProperty" }, "chainable": 1, "access": "public", "tagname": "", "class": "ComputedProperty", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/computed.js", "line": 270, "description": "In some cases, you may want to annotate computed properties with additional\nmetadata about how they function or what values they operate on. For example,\ncomputed property functions may close over variables that are then no longer\navailable for introspection.\n\nYou can pass a hash of these values to a computed property like this:\n\n```\nimport { computed } from '@ember/object';\nimport Person from 'my-app/utils/person';\n\nperson: computed(function() {\n let personId = this.get('personId');\n return Person.create({ id: personId });\n}).meta({ type: Person })\n```\n\nThe hash that you pass to the `meta()` function will be saved on the\ncomputed property descriptor under the `_meta` key. Ember runtime\nexposes a public API for retrieving these values from classes,\nvia the `metaForProperty()` function.", "itemtype": "method", "name": "meta", "params": [ { "name": "meta", "description": "", "type": "Object" } ], "chainable": 1, "access": "public", "tagname": "", "class": "ComputedProperty", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/computed.js", "line": 441, "description": "This helper returns a new property descriptor that wraps the passed\ncomputed property function. You can use this helper to define properties\nwith mixins or via `defineProperty()`.\n\nIf you pass a function as an argument, it will be used as a getter. A computed\nproperty defined in this way might look like this:\n\n```js\nimport EmberObject, { computed } from '@ember/object';\n\nlet Person = EmberObject.extend({\n init() {\n this._super(...arguments);\n\n this.firstName = 'Betty';\n this.lastName = 'Jones';\n },\n\n fullName: computed('firstName', 'lastName', function() {\n return `${this.get('firstName')} ${this.get('lastName')}`;\n })\n});\n\nlet client = Person.create();\n\nclient.get('fullName'); // 'Betty Jones'\n\nclient.set('lastName', 'Fuller');\nclient.get('fullName'); // 'Betty Fuller'\n```\n\nYou can pass a hash with two functions, `get` and `set`, as an\nargument to provide both a getter and setter:\n\n```js\nimport EmberObject, { computed } from '@ember/object';\n\nlet Person = EmberObject.extend({\n init() {\n this._super(...arguments);\n\n this.firstName = 'Betty';\n this.lastName = 'Jones';\n },\n\n fullName: computed('firstName', 'lastName', {\n get(key) {\n return `${this.get('firstName')} ${this.get('lastName')}`;\n },\n set(key, value) {\n let [firstName, lastName] = value.split(/\\s+/);\n this.setProperties({ firstName, lastName });\n return value;\n }\n })\n});\n\nlet client = Person.create();\nclient.get('firstName'); // 'Betty'\n\nclient.set('fullName', 'Carroll Fuller');\nclient.get('firstName'); // 'Carroll'\n```\n\nThe `set` function should accept two parameters, `key` and `value`. The value\nreturned from `set` will be the new value of the property.\n\n_Note: This is the preferred way to define computed properties when writing third-party\nlibraries that depend on or use Ember, since there is no guarantee that the user\nwill have [prototype Extensions](https://emberjs.com/guides/configuring-ember/disabling-prototype-extensions/) enabled._\n\nThe alternative syntax, with prototype extensions, might look like:\n\n```js\nfullName: function() {\n return this.get('firstName') + ' ' + this.get('lastName');\n}.property('firstName', 'lastName')\n```", "itemtype": "method", "name": "computed", "static": 1, "params": [ { "name": "dependentKeys*", "description": "Optional dependent keys that trigger this computed property.", "type": "String", "optional": true }, { "name": "func", "description": "The computed property function.", "type": "Function" } ], "return": { "description": "property descriptor instance", "type": "ComputedProperty" }, "access": "public", "tagname": "", "class": "@ember/object", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/computed.js", "line": 541, "description": "Returns the cached value for a property, if one exists.\nThis can be useful for peeking at the value of a computed\nproperty that is generated lazily, without accidentally causing\nit to be created.", "itemtype": "method", "name": "cacheFor", "static": 1, "params": [ { "name": "obj", "description": "the object whose property you want to check", "type": "Object" }, { "name": "key", "description": "the name of the property whose cached value you want\n to return", "type": "String" } ], "return": { "description": "the cached value", "type": "Object" }, "access": "public", "tagname": "", "class": "@ember/object/internals", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/deprecate_property.js", "line": 10, "description": "Used internally to allow changing properties in a backwards compatible way, and print a helpful\ndeprecation warning.", "itemtype": "method", "name": "deprecateProperty", "params": [ { "name": "object", "description": "The object to add the deprecated property to.", "type": "Object" }, { "name": "deprecatedKey", "description": "The property to add (and print deprecation warnings upon accessing).", "type": "String" }, { "name": "newKey", "description": "The property that will be aliased.", "type": "String" } ], "access": "private", "tagname": "", "since": "1.7.0", "class": "Descriptor", "module": "ember" }, { "file": "packages/ember-metal/lib/events.js", "line": 28, "description": "Add an event listener", "itemtype": "method", "name": "addListener", "static": 1, "params": [ { "name": "obj", "description": "" }, { "name": "eventName", "description": "", "type": "String" }, { "name": "target", "description": "A target object or a function", "type": "Object|Function" }, { "name": "method", "description": "A function or the name of a function to be called on `target`", "type": "Function|String" }, { "name": "once", "description": "A flag whether a function should only be called once", "type": "Boolean" } ], "access": "public", "tagname": "", "class": "@ember/object/events", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/events.js", "line": 76, "description": "Remove an event listener\n\nArguments should match those passed to `addListener`.", "itemtype": "method", "name": "removeListener", "static": 1, "params": [ { "name": "obj", "description": "" }, { "name": "eventName", "description": "", "type": "String" }, { "name": "target", "description": "A target object or a function", "type": "Object|Function" }, { "name": "method", "description": "A function or the name of a function to be called on `target`", "type": "Function|String" } ], "access": "public", "tagname": "", "class": "@ember/object/events", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/events.js", "line": 103, "description": "Send an event. The execution of suspended listeners\nis skipped, and once listeners are removed. A listener without\na target is executed on the passed object. If an array of actions\nis not passed, the actions stored on the passed object are invoked.", "itemtype": "method", "name": "sendEvent", "static": 1, "params": [ { "name": "obj", "description": "" }, { "name": "eventName", "description": "", "type": "String" }, { "name": "params", "description": "Optional parameters for each listener.", "type": "Array" }, { "name": "actions", "description": "Optional array of actions (listeners).", "type": "Array" }, { "name": "meta", "description": "Optional meta to lookup listeners", "type": "Meta" } ], "return": { "description": "true" }, "access": "public", "tagname": "", "class": "@ember/object/events", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/events.js", "line": 156, "access": "private", "tagname": "", "itemtype": "method", "name": "hasListeners", "static": 1, "params": [ { "name": "obj", "description": "" }, { "name": "eventName", "description": "", "type": "String" } ], "class": "@ember/object/events", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/events.js", "line": 171, "description": "Define a property as a function that should be executed when\na specified event or events are triggered.\n\n\n``` javascript\nimport EmberObject from '@ember/object';\nimport { on } from '@ember/object/evented';\nimport { sendEvent } from '@ember/object/events';\n\nlet Job = EmberObject.extend({\n logCompleted: on('completed', function() {\n console.log('Job completed!');\n })\n});\n\nlet job = Job.create();\n\nsendEvent(job, 'completed'); // Logs 'Job completed!'\n ```", "itemtype": "method", "name": "on", "static": 1, "params": [ { "name": "eventNames", "description": "", "type": "String", "multiple": true }, { "name": "func", "description": "", "type": "Function" } ], "return": { "description": "func" }, "access": "public", "tagname": "", "class": "@ember/object/evented", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/expand_properties.js", "line": 9, "description": "Expands `pattern`, invoking `callback` for each expansion.\n\nThe only pattern supported is brace-expansion, anything else will be passed\nonce to `callback` directly.\n\nExample\n\n```js\nimport { expandProperties } from '@ember/object/computed';\n\nfunction echo(arg){ console.log(arg); }\n\nexpandProperties('foo.bar', echo); //=> 'foo.bar'\nexpandProperties('{foo,bar}', echo); //=> 'foo', 'bar'\nexpandProperties('foo.{bar,baz}', echo); //=> 'foo.bar', 'foo.baz'\nexpandProperties('{foo,bar}.baz', echo); //=> 'foo.baz', 'bar.baz'\nexpandProperties('foo.{bar,baz}.[]', echo) //=> 'foo.bar.[]', 'foo.baz.[]'\nexpandProperties('{foo,bar}.{spam,eggs}', echo) //=> 'foo.spam', 'foo.eggs', 'bar.spam', 'bar.eggs'\nexpandProperties('{foo}.bar.{baz}') //=> 'foo.bar.baz'\n```", "itemtype": "method", "name": "expandProperties", "static": 1, "access": "public", "tagname": "", "params": [ { "name": "pattern", "description": "The property pattern to expand.", "type": "String" }, { "name": "callback", "description": "The callback to invoke. It is invoked once per\nexpansion, and is passed the expansion.", "type": "Function" } ], "class": "@ember/object", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/get_properties.js", "line": 6, "description": "To get multiple properties at once, call `getProperties`\nwith an object followed by a list of strings or an array:\n\n```javascript\nimport { getProperties } from '@ember/object';\n\ngetProperties(record, 'firstName', 'lastName', 'zipCode');\n// { firstName: 'John', lastName: 'Doe', zipCode: '10011' }\n```\n\nis equivalent to:\n\n```javascript\nimport { getProperties } from '@ember/object';\n\ngetProperties(record, ['firstName', 'lastName', 'zipCode']);\n// { firstName: 'John', lastName: 'Doe', zipCode: '10011' }\n```", "itemtype": "method", "name": "getProperties", "static": 1, "params": [ { "name": "obj", "description": "", "type": "Object" }, { "name": "list", "description": "of keys to get", "type": "String...|Array" } ], "return": { "description": "", "type": "Object" }, "access": "public", "tagname": "", "class": "@ember/object", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/instrumentation.js", "line": 89, "description": "Notifies event's subscribers, calls `before` and `after` hooks.", "itemtype": "method", "name": "instrument", "static": 1, "params": [ { "name": "name", "description": "Namespaced event name.", "type": "String", "optional": true }, { "name": "_payload", "description": "", "type": "Object" }, { "name": "callback", "description": "Function that you're instrumenting.", "type": "Function" }, { "name": "binding", "description": "Context that instrument function is called with.", "type": "Object" } ], "access": "private", "tagname": "", "class": "@ember/instrumentation", "module": "@ember/instrumentation" }, { "file": "packages/ember-metal/lib/instrumentation.js", "line": 192, "description": "Subscribes to a particular event or instrumented block of code.", "itemtype": "method", "name": "subscribe", "static": 1, "params": [ { "name": "pattern", "description": "Namespaced event name.", "type": "String", "optional": true }, { "name": "object", "description": "Before and After hooks.", "type": "Object", "optional": true } ], "return": { "description": "", "type": "Subscriber" }, "access": "private", "tagname": "", "class": "@ember/instrumentation", "module": "@ember/instrumentation" }, { "file": "packages/ember-metal/lib/instrumentation.js", "line": 234, "description": "Unsubscribes from a particular event or instrumented block of code.", "itemtype": "method", "name": "unsubscribe", "static": 1, "params": [ { "name": "subscriber", "description": "", "type": "Object", "optional": true } ], "access": "private", "tagname": "", "class": "@ember/instrumentation", "module": "@ember/instrumentation" }, { "file": "packages/ember-metal/lib/instrumentation.js", "line": 257, "description": "Resets `Instrumentation` by flushing list of subscribers.", "itemtype": "method", "name": "reset", "static": 1, "access": "private", "tagname": "", "class": "@ember/instrumentation", "module": "@ember/instrumentation" }, { "file": "packages/ember-metal/lib/is_blank.js", "line": 5, "description": "A value is blank if it is empty or a whitespace string.\n\n```javascript\nimport { isBlank } from '@ember/utils';\n\nisBlank(); // true\nisBlank(null); // true\nisBlank(undefined); // true\nisBlank(''); // true\nisBlank([]); // true\nisBlank('\\n\\t'); // true\nisBlank(' '); // true\nisBlank({}); // false\nisBlank('\\n\\t Hello'); // false\nisBlank('Hello world'); // false\nisBlank([1,2,3]); // false\n```", "itemtype": "method", "name": "isBlank", "static": 1, "params": [ { "name": "obj", "description": "Value to test", "type": "Object" } ], "return": { "description": "", "type": "Boolean" }, "since": "1.5.0", "access": "public", "tagname": "", "class": "@ember/utils", "module": "@ember/utils" }, { "file": "packages/ember-metal/lib/is_empty.js", "line": 6, "description": "Verifies that a value is `null` or `undefined`, an empty string, or an empty\narray.\n\nConstrains the rules on `isNone` by returning true for empty strings and\nempty arrays.\n\nIf the value is an object with a `size` property of type number, it is used\nto check emptiness.\n\n```javascript\nisEmpty(); // true\nisEmpty(null); // true\nisEmpty(undefined); // true\nisEmpty(''); // true\nisEmpty([]); // true\nisEmpty({ size: 0}); // true\nisEmpty({}); // false\nisEmpty('Adam Hawkins'); // false\nisEmpty([0,1,2]); // false\nisEmpty('\\n\\t'); // false\nisEmpty(' '); // false\nisEmpty({ size: 1 }) // false\nisEmpty({ size: () => 0 }) // false\n```", "itemtype": "method", "name": "isEmpty", "static": 1, "params": [ { "name": "obj", "description": "Value to test", "type": "Object" } ], "return": { "description": "", "type": "Boolean" }, "access": "public", "tagname": "", "class": "@ember/utils", "module": "@ember/utils" }, { "file": "packages/ember-metal/lib/is_none.js", "line": 4, "description": "Returns true if the passed value is null or undefined. This avoids errors\nfrom JSLint complaining about use of ==, which can be technically\nconfusing.\n\n```javascript\nisNone(); // true\nisNone(null); // true\nisNone(undefined); // true\nisNone(''); // false\nisNone([]); // false\nisNone(function() {}); // false\n```", "itemtype": "method", "name": "isNone", "static": 1, "params": [ { "name": "obj", "description": "Value to test", "type": "Object" } ], "return": { "description": "", "type": "Boolean" }, "access": "public", "tagname": "", "class": "@ember/utils", "module": "@ember/utils" }, { "file": "packages/ember-metal/lib/is_present.js", "line": 5, "description": "A value is present if it not `isBlank`.\n\n```javascript\nisPresent(); // false\nisPresent(null); // false\nisPresent(undefined); // false\nisPresent(''); // false\nisPresent(' '); // false\nisPresent('\\n\\t'); // false\nisPresent([]); // false\nisPresent({ length: 0 }) // false\nisPresent(false); // true\nisPresent(true); // true\nisPresent('string'); // true\nisPresent(0); // true\nisPresent(function() {}) // true\nisPresent({}); // true\nisPresent(false); // true\nisPresent('\\n\\t Hello'); // true\nisPresent([1,2,3]); // true\n```", "itemtype": "method", "name": "isPresent", "static": 1, "params": [ { "name": "obj", "description": "Value to test", "type": "Object" } ], "return": { "description": "", "type": "Boolean" }, "since": "1.8.0", "access": "public", "tagname": "", "class": "@ember/utils", "module": "@ember/utils" }, { "file": "packages/ember-metal/lib/map.js", "line": 64, "itemtype": "method", "name": "create", "static": 1, "return": { "description": "", "type": "Ember.OrderedSet" }, "access": "private", "tagname": "", "class": "Ember.OrderedSet", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 75, "itemtype": "method", "name": "clear", "access": "private", "tagname": "", "class": "Ember.OrderedSet", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 85, "itemtype": "method", "name": "add", "params": [ { "name": "obj", "description": "" }, { "name": "guid", "description": "(optional, and for internal use)" } ], "return": { "description": "", "type": "Ember.OrderedSet" }, "access": "private", "tagname": "", "class": "Ember.OrderedSet", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 105, "since": "1.8.0", "itemtype": "method", "name": "delete", "params": [ { "name": "obj", "description": "" }, { "name": "_guid", "description": "(optional and for internal use only)" } ], "return": { "description": "", "type": "Boolean" }, "access": "private", "tagname": "", "class": "Ember.OrderedSet", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 131, "itemtype": "method", "name": "isEmpty", "return": { "description": "", "type": "Boolean" }, "access": "private", "tagname": "", "class": "Ember.OrderedSet", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 140, "itemtype": "method", "name": "has", "params": [ { "name": "obj", "description": "" } ], "return": { "description": "", "type": "Boolean" }, "access": "private", "tagname": "", "class": "Ember.OrderedSet", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 155, "itemtype": "method", "name": "forEach", "params": [ { "name": "fn", "description": "", "type": "Function" }, { "name": "self", "description": "" } ], "access": "private", "tagname": "", "class": "Ember.OrderedSet", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 179, "itemtype": "method", "name": "toArray", "return": { "description": "", "type": "Array" }, "access": "private", "tagname": "", "class": "Ember.OrderedSet", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 188, "itemtype": "method", "name": "copy", "return": { "description": "", "type": "Ember.OrderedSet" }, "access": "private", "tagname": "", "class": "Ember.OrderedSet", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 231, "itemtype": "method", "name": "create", "static": 1, "access": "private", "tagname": "", "class": "Ember.Map", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 241, "description": "Retrieve the value associated with a given key.", "itemtype": "method", "name": "get", "params": [ { "name": "key", "description": "", "type": "*" } ], "return": { "description": "the value associated with the key, or `undefined`", "type": "*" }, "access": "private", "tagname": "", "class": "Ember.Map", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 258, "description": "Adds a value to the map. If a value for the given key has already been\nprovided, the new value will replace the old value.", "itemtype": "method", "name": "set", "params": [ { "name": "key", "description": "", "type": "*" }, { "name": "value", "description": "", "type": "*" } ], "return": { "description": "", "type": "Map" }, "access": "private", "tagname": "", "class": "Ember.Map", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 285, "description": "Removes a value from the map for an associated key.", "since": "1.8.0", "itemtype": "method", "name": "delete", "params": [ { "name": "key", "description": "", "type": "*" } ], "return": { "description": "true if an item was removed, false otherwise", "type": "Boolean" }, "access": "private", "tagname": "", "class": "Ember.Map", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 311, "description": "Check whether a key is present.", "itemtype": "method", "name": "has", "params": [ { "name": "key", "description": "", "type": "*" } ], "return": { "description": "true if the item was present, false otherwise", "type": "Boolean" }, "access": "private", "tagname": "", "class": "Ember.Map", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 323, "description": "Iterate over all the keys and values. Calls the function once\nfor each key, passing in value, key, and the map being iterated over,\nin that order.\n\nThe keys are guaranteed to be iterated over in insertion order.", "itemtype": "method", "name": "forEach", "params": [ { "name": "callback", "description": "", "type": "Function" }, { "name": "self", "description": "if passed, the `this` value inside the\n callback. By default, `this` is the map.", "type": "*" } ], "access": "private", "tagname": "", "class": "Ember.Map", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 354, "itemtype": "method", "name": "clear", "access": "private", "tagname": "", "class": "Ember.Map", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 364, "itemtype": "method", "name": "copy", "return": { "description": "", "type": "Map" }, "access": "private", "tagname": "", "class": "Ember.Map", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 388, "itemtype": "method", "name": "create", "static": 1, "params": [ { "name": "options", "description": "", "optional": true, "props": [ { "name": "defaultValue", "description": "", "type": "*", "optional": true } ] } ], "return": { "description": "If options are passed, returns\n `MapWithDefault` otherwise returns `EmberMap`", "type": "MapWithDefault|Map" }, "access": "private", "tagname": "", "class": "Ember.MapWithDefault", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 405, "description": "Retrieve the value associated with a given key.", "itemtype": "method", "name": "get", "params": [ { "name": "key", "description": "", "type": "*" } ], "return": { "description": "the value associated with the key, or the default value", "type": "*" }, "access": "private", "tagname": "", "class": "Ember.MapWithDefault", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/map.js", "line": 425, "itemtype": "method", "name": "copy", "return": { "description": "", "type": "MapWithDefault" }, "access": "private", "tagname": "", "class": "Ember.MapWithDefault", "module": "@ember/map", "namespace": "Ember" }, { "file": "packages/ember-metal/lib/merge.js", "line": 4, "description": "Merge the contents of two objects together into the first object.\n\n```javascript\nimport { merge } from '@ember/polyfills';\n\nmerge({ first: 'Tom' }, { last: 'Dale' }); // { first: 'Tom', last: 'Dale' }\nvar a = { first: 'Yehuda' };\nvar b = { last: 'Katz' };\nmerge(a, b); // a == { first: 'Yehuda', last: 'Katz' }, b == { last: 'Katz' }\n```", "itemtype": "method", "name": "merge", "static": 1, "params": [ { "name": "original", "description": "The object to merge into", "type": "Object" }, { "name": "updates", "description": "The object to copy properties from", "type": "Object" } ], "return": { "description": "", "type": "Object" }, "access": "public", "tagname": "", "class": "@ember/polyfills", "module": "@ember/polyfills" }, { "file": "packages/ember-metal/lib/meta.js", "line": 512, "description": "Tears down the meta on an object so that it can be garbage collected.\nMultiple calls will have no effect.", "itemtype": "method", "name": "deleteMeta", "params": [ { "name": "obj", "description": "the object to destroy", "type": "Object" } ], "return": { "description": "", "type": "Void" }, "access": "private", "tagname": "", "class": "Ember", "module": "ember" }, { "file": "packages/ember-metal/lib/meta.js", "line": 537, "description": "Retrieves the meta hash for an object. If `writable` is true ensures the\nhash is writable for this object as well.\n\nThe meta object contains information about computed property descriptors as\nwell as any watched properties and other information. You generally will\nnot access this information directly but instead work with higher level\nmethods that manipulate this hash indirectly.", "itemtype": "method", "name": "meta", "access": "private", "tagname": "", "params": [ { "name": "obj", "description": "The object to retrieve meta for", "type": "Object" }, { "name": "writable", "description": "Pass `false` if you do not intend to modify\n the meta hash, allowing the method to avoid making an unnecessary copy.", "type": "Boolean", "optional": true, "optdefault": "true" } ], "return": { "description": "the meta hash for an object", "type": "Object" }, "class": "Ember", "module": "ember" }, { "file": "packages/ember-metal/lib/meta.js", "line": 586, "description": "Returns the CP descriptor assocaited with `obj` and `keyName`, if any.", "itemtype": "method", "name": "descriptorFor", "params": [ { "name": "obj", "description": "the object to check", "type": "Object" }, { "name": "keyName", "description": "the key to check", "type": "String" } ], "return": { "description": "", "type": "Descriptor" }, "access": "private", "tagname": "", "class": "Ember", "module": "ember" }, { "file": "packages/ember-metal/lib/meta.js", "line": 625, "description": "Check whether a value is a CP descriptor.", "itemtype": "method", "name": "descriptorFor", "params": [ { "name": "possibleDesc", "description": "the value to check", "type": "Any" } ], "return": { "description": "", "type": "Boolean" }, "access": "private", "tagname": "", "class": "Ember", "module": "ember" }, { "file": "packages/ember-metal/lib/mixin.js", "line": 355, "itemtype": "method", "name": "mixin", "params": [ { "name": "obj", "description": "" }, { "name": "mixins", "description": "", "multiple": true } ], "return": { "description": "obj" }, "access": "private", "tagname": "", "class": "Mixin", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/mixin.js", "line": 482, "itemtype": "method", "name": "create", "static": 1, "params": [ { "name": "arguments", "description": "", "multiple": true } ], "access": "public", "tagname": "", "class": "@ember/object/mixin", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/mixin.js", "line": 511, "itemtype": "method", "name": "reopen", "params": [ { "name": "arguments", "description": "", "multiple": true } ], "access": "private", "tagname": "", "class": "@ember/object/mixin", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/mixin.js", "line": 548, "itemtype": "method", "name": "apply", "params": [ { "name": "obj", "description": "" } ], "return": { "description": "applied object" }, "access": "private", "tagname": "", "class": "@ember/object/mixin", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/mixin.js", "line": 562, "itemtype": "method", "name": "detect", "params": [ { "name": "obj", "description": "" } ], "return": { "description": "", "type": "Boolean" }, "access": "private", "tagname": "", "class": "@ember/object/mixin", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/mixin.js", "line": 649, "description": "Denotes a required property for a mixin", "itemtype": "method", "name": "required", "access": "private", "tagname": "", "class": "Ember", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/mixin.js", "line": 672, "description": "Makes a method available via an additional name.\n\n```app/utils/person.js\nimport EmberObject, {\n aliasMethod\n} from '@ember/object';\n\nexport default EmberObject.extend({\n name() {\n return 'Tomhuda Katzdale';\n },\n moniker: aliasMethod('name')\n});\n```\n\n```javascript\nlet goodGuy = Person.create();\n\ngoodGuy.name(); // 'Tomhuda Katzdale'\ngoodGuy.moniker(); // 'Tomhuda Katzdale'\n```", "itemtype": "method", "name": "aliasMethod", "static": 1, "params": [ { "name": "methodName", "description": "name of the method to alias", "type": "String" } ], "access": "public", "tagname": "", "class": "@ember/object", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/mixin.js", "line": 709, "description": "Specify a method that observes property changes.\n\n```javascript\nimport EmberObject from '@ember/object';\nimport { observer } from '@ember/object';\n\nexport default EmberObject.extend({\n valueObserver: observer('value', function() {\n // Executes whenever the \"value\" property changes\n })\n});\n```\n\nAlso available as `Function.prototype.observes` if prototype extensions are\nenabled.", "itemtype": "method", "name": "observer", "params": [ { "name": "propertyNames", "description": "", "type": "String", "multiple": true }, { "name": "func", "description": "", "type": "Function" } ], "return": { "description": "func" }, "access": "public", "tagname": "", "static": 1, "class": "@ember/object", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/mixin.js", "line": 752, "description": "When observers fire, they are called with the arguments `obj`, `keyName`.\n\nNote, `@each.property` observer is called per each add or replace of an element\nand it's not called with a specific enumeration item.\n\nA `_beforeObserver` fires before a property changes.", "itemtype": "method", "name": "beforeObserver", "params": [ { "name": "propertyNames", "description": "", "type": "String", "multiple": true }, { "name": "func", "description": "", "type": "Function" } ], "return": { "description": "func" }, "deprecated": true, "access": "private", "tagname": "", "class": "Ember", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/observer.js", "line": 24, "itemtype": "method", "name": "addObserver", "static": 1, "params": [ { "name": "obj", "description": "" }, { "name": "_path", "description": "", "type": "String" }, { "name": "target", "description": "", "type": "Object|Function" }, { "name": "method", "description": "", "type": "Function|String", "optional": true } ], "access": "public", "tagname": "", "class": "@ember/object/observers", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/observer.js", "line": 41, "itemtype": "method", "name": "removeObserver", "static": 1, "params": [ { "name": "obj", "description": "" }, { "name": "path", "description": "", "type": "String" }, { "name": "target", "description": "", "type": "Object|Function" }, { "name": "method", "description": "", "type": "Function|String", "optional": true } ], "access": "public", "tagname": "", "class": "@ember/object/observers", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/observer.js", "line": 58, "itemtype": "method", "name": "_addBeforeObserver", "static": 1, "params": [ { "name": "obj", "description": "" }, { "name": "path", "description": "", "type": "String" }, { "name": "target", "description": "", "type": "Object|Function" }, { "name": "method", "description": "", "type": "Function|String", "optional": true } ], "deprecated": true, "access": "private", "tagname": "", "class": "@ember/object/observers", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/observer.js", "line": 76, "itemtype": "method", "name": "removeBeforeObserver", "static": 1, "params": [ { "name": "obj", "description": "" }, { "name": "path", "description": "", "type": "String" }, { "name": "target", "description": "", "type": "Object|Function" }, { "name": "method", "description": "", "type": "Function|String", "optional": true } ], "deprecated": true, "access": "private", "tagname": "", "class": "@ember/object/observers", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/properties.js", "line": 174, "description": "NOTE: This is a low-level method used by other parts of the API. You almost\nnever want to call this method directly. Instead you should use\n`mixin()` to define new properties.\n\nDefines a property on an object. This method works much like the ES5\n`Object.defineProperty()` method except that it can also accept computed\nproperties and other special descriptors.\n\nNormally this method takes only three parameters. However if you pass an\ninstance of `Descriptor` as the third param then you can pass an\noptional value as the fourth parameter. This is often more efficient than\ncreating new descriptor hashes for each property.\n\n## Examples\n\n```javascript\nimport { defineProperty, computed } from '@ember/object';\n\n// ES5 compatible mode\ndefineProperty(contact, 'firstName', {\n writable: true,\n configurable: false,\n enumerable: true,\n value: 'Charles'\n});\n\n// define a simple property\ndefineProperty(contact, 'lastName', undefined, 'Jolley');\n\n// define a computed property\ndefineProperty(contact, 'fullName', computed('firstName', 'lastName', function() {\n return this.firstName+' '+this.lastName;\n}));\n```", "access": "private", "tagname": "", "itemtype": "method", "name": "defineProperty", "params": [ { "name": "obj", "description": "the object to define this property on. This may be a prototype.", "type": "Object" }, { "name": "keyName", "description": "the name of the property", "type": "String" }, { "name": "desc", "description": "an instance of `Descriptor` (typically a\n computed property) or an ES5 descriptor.\n You must provide this or `data` but not both.", "type": "Descriptor", "optional": true }, { "name": "data", "description": "something other than a descriptor, that will\n become the explicit value of this property.", "type": "*", "optional": true } ], "class": "@ember/object", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/property_events.js", "line": 34, "description": "This function is called just before an object property is about to change.\nIt will notify any before observers and prepare caches among other things.\n\nNormally you will not need to call this method directly but if for some\nreason you can't directly watch a property you can invoke this method\nmanually along with `Ember.propertyDidChange()` which you should call just\nafter the property value changes.", "itemtype": "method", "name": "propertyWillChange", "params": [ { "name": "obj", "description": "The object with the property that will change", "type": "Object" }, { "name": "keyName", "description": "The property key (or path) that will change.", "type": "String" } ], "return": { "description": "", "type": "Void" }, "access": "private", "tagname": "", "class": "Ember", "module": "ember" }, { "file": "packages/ember-metal/lib/property_events.js", "line": 68, "description": "This function is called just after an object property has changed.\nIt will notify any observers and clear caches among other things.\n\nNormally you will not need to call this method directly but if for some\nreason you can't directly watch a property you can invoke this method\nmanually along with `Ember.propertyWillChange()` which you should call just\nbefore the property value changes.", "itemtype": "method", "name": "propertyDidChange", "params": [ { "name": "obj", "description": "The object with the property that will change", "type": "Object" }, { "name": "keyName", "description": "The property key (or path) that will change.", "type": "String" }, { "name": "meta", "description": "The objects meta.", "type": "Meta" } ], "return": { "description": "", "type": "Void" }, "access": "private", "tagname": "", "class": "Ember", "module": "ember" }, { "file": "packages/ember-metal/lib/property_events.js", "line": 202, "itemtype": "method", "name": "beginPropertyChanges", "chainable": 1, "access": "private", "tagname": "", "class": "Ember", "module": "ember" }, { "file": "packages/ember-metal/lib/property_events.js", "line": 211, "itemtype": "method", "name": "endPropertyChanges", "access": "private", "tagname": "", "class": "Ember", "module": "ember" }, { "file": "packages/ember-metal/lib/property_events.js", "line": 223, "description": "Make a series of property changes together in an\nexception-safe way.\n\n```javascript\nEmber.changeProperties(function() {\n obj1.set('foo', mayBlowUpWhenSet);\n obj2.set('bar', baz);\n});\n```", "itemtype": "method", "name": "changeProperties", "params": [ { "name": "callback", "description": "", "type": "Function" } ], "access": "private", "tagname": "", "class": "Ember", "module": "ember" }, { "file": "packages/ember-metal/lib/property_get.js", "line": 23, "description": "Gets the value of a property on an object. If the property is computed,\nthe function will be invoked. If the property is not defined but the\nobject implements the `unknownProperty` method then that will be invoked.\n\n```javascript\nimport { get } from '@ember/object';\nget(obj, \"name\");\n```\n\nIf you plan to run on IE8 and older browsers then you should use this\nmethod anytime you want to retrieve a property on an object that you don't\nknow for sure is private. (Properties beginning with an underscore '_'\nare considered private.)\n\nOn all newer browsers, you only need to use this method to retrieve\nproperties if the property might not be defined on the object and you want\nto respect the `unknownProperty` handler. Otherwise you can ignore this\nmethod.\n\nNote that if the object itself is `undefined`, this method will throw\nan error.", "itemtype": "method", "name": "get", "static": 1, "params": [ { "name": "obj", "description": "The object to retrieve from.", "type": "Object" }, { "name": "keyName", "description": "The property key to retrieve", "type": "String" } ], "return": { "description": "the property value or `null`.", "type": "Object" }, "access": "public", "tagname": "", "class": "@ember/object", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/property_get.js", "line": 125, "description": "Retrieves the value of a property from an Object, or a default value in the\ncase that the property returns `undefined`.\n\n```javascript\nimport { getWithDefault } from '@ember/object';\ngetWithDefault(person, 'lastName', 'Doe');\n```", "itemtype": "method", "name": "getWithDefault", "static": 1, "params": [ { "name": "obj", "description": "The object to retrieve from.", "type": "Object" }, { "name": "keyName", "description": "The name of the property to retrieve", "type": "String" }, { "name": "defaultValue", "description": "The value to return if the property value is undefined", "type": "Object" } ], "return": { "description": "The property value or the defaultValue.", "type": "Object" }, "access": "public", "tagname": "", "class": "@ember/object", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/property_set.js", "line": 23, "description": "Sets the value of a property on an object, respecting computed properties\nand notifying observers and other listeners of the change. If the\nproperty is not defined but the object implements the `setUnknownProperty`\nmethod then that will be invoked as well.\n\n```javascript\nimport { set } from '@ember/object';\nset(obj, \"name\", value);\n```", "itemtype": "method", "name": "set", "static": 1, "params": [ { "name": "obj", "description": "The object to modify.", "type": "Object" }, { "name": "keyName", "description": "The property key to set", "type": "String" }, { "name": "value", "description": "The value to set", "type": "Object" } ], "return": { "description": "the passed value.", "type": "Object" }, "access": "public", "tagname": "", "class": "@ember/object", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/property_set.js", "line": 131, "description": "Error-tolerant form of `set`. Will not blow up if any part of the\nchain is `undefined`, `null`, or destroyed.\n\nThis is primarily used when syncing bindings, which may try to update after\nan object has been destroyed.", "itemtype": "method", "name": "trySet", "static": 1, "params": [ { "name": "root", "description": "The object to modify.", "type": "Object" }, { "name": "path", "description": "The property path to set", "type": "String" }, { "name": "value", "description": "The value to set", "type": "Object" } ], "access": "public", "tagname": "", "class": "@ember/object", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/run_loop.js", "line": 38, "description": "Runs the passed target and method inside of a RunLoop, ensuring any\ndeferred actions including bindings and views updates are flushed at the\nend.\n\nNormally you should not need to invoke this method yourself. However if\nyou are implementing raw event handlers when interfacing with other\nlibraries or plugins, you should probably wrap all of your code inside this\ncall.\n\n```javascript\nimport { run } from '@ember/runloop';\n\nrun(function() {\n // code to be executed within a RunLoop\n});\n```", "itemtype": "method", "name": "run", "static": 1, "params": [ { "name": "target", "description": "target of method to call", "type": "Object", "optional": true }, { "name": "method", "description": "Method to invoke.\n May be a function or a string. If you pass a string\n then it will be looked up on the passed target.", "type": "Function|String" }, { "name": "args*", "description": "Any additional arguments you wish to pass to the method.", "type": "Object", "optional": true } ], "return": { "description": "return value from invoking the passed function.", "type": "Object" }, "access": "public", "tagname": "", "class": "@ember/runloop", "module": "@ember/runloop" }, { "file": "packages/ember-metal/lib/run_loop.js", "line": 70, "description": "If no run-loop is present, it creates a new one. If a run loop is\npresent it will queue itself to run on the existing run-loops action\nqueue.\n\nPlease note: This is not for normal usage, and should be used sparingly.\n\nIf invoked when not within a run loop:\n\n```javascript\nimport { join } from '@ember/runloop';\n\njoin(function() {\n // creates a new run-loop\n});\n```\n\nAlternatively, if called within an existing run loop:\n\n```javascript\nimport { run, join } from '@ember/runloop';\n\nrun(function() {\n // creates a new run-loop\n\n join(function() {\n // joins with the existing run-loop, and queues for invocation on\n // the existing run-loops action queue.\n });\n});\n```", "itemtype": "method", "name": "join", "static": 1, "params": [ { "name": "target", "description": "target of method to call", "type": "Object", "optional": true }, { "name": "method", "description": "Method to invoke.\n May be a function or a string. If you pass a string\n then it will be looked up on the passed target.", "type": "Function|String" }, { "name": "args*", "description": "Any additional arguments you wish to pass to the method.", "type": "Object", "optional": true } ], "return": { "description": "Return value from invoking the passed function. Please note,\nwhen called within an existing loop, no return value is possible.", "type": "Object" }, "access": "public", "tagname": "", "class": "@ember/runloop", "module": "@ember/runloop" }, { "file": "packages/ember-metal/lib/run_loop.js", "line": 118, "description": "Allows you to specify which context to call the specified function in while\nadding the execution of that function to the Ember run loop. This ability\nmakes this method a great way to asynchronously integrate third-party libraries\ninto your Ember application.\n\n`bind` takes two main arguments, the desired context and the function to\ninvoke in that context. Any additional arguments will be supplied as arguments\nto the function that is passed in.\n\nLet's use the creation of a TinyMCE component as an example. Currently,\nTinyMCE provides a setup configuration option we can use to do some processing\nafter the TinyMCE instance is initialized but before it is actually rendered.\nWe can use that setup option to do some additional setup for our component.\nThe component itself could look something like the following:\n\n```app/components/rich-text-editor.js\nimport Component from '@ember/component';\nimport { on } from '@ember/object/evented';\nimport { bind } from '@ember/runloop';\n\nexport default Component.extend({\n initializeTinyMCE: on('didInsertElement', function() {\n tinymce.init({\n selector: '#' + this.$().prop('id'),\n setup: bind(this, this.setupEditor)\n });\n }),\n\n didInsertElement() {\n tinymce.init({\n selector: '#' + this.$().prop('id'),\n setup: bind(this, this.setupEditor)\n });\n }\n\n setupEditor(editor) {\n this.set('editor', editor);\n\n editor.on('change', function() {\n console.log('content changed!');\n });\n }\n});\n```\n\nIn this example, we use `bind` to bind the setupEditor method to the\ncontext of the RichTextEditor component and to have the invocation of that\nmethod be safely handled and executed by the Ember run loop.", "itemtype": "method", "name": "bind", "static": 1, "params": [ { "name": "target", "description": "target of method to call", "type": "Object", "optional": true }, { "name": "method", "description": "Method to invoke.\n May be a function or a string. If you pass a string\n then it will be looked up on the passed target.", "type": "Function|String" }, { "name": "args*", "description": "Any additional arguments you wish to pass to the method.", "type": "Object", "optional": true } ], "return": { "description": "returns a new function that will always have a particular context", "type": "Function" }, "since": "1.4.0", "access": "public", "tagname": "", "class": "@ember/runloop", "module": "@ember/runloop" }, { "file": "packages/ember-metal/lib/run_loop.js", "line": 186, "description": "Begins a new RunLoop. Any deferred actions invoked after the begin will\nbe buffered until you invoke a matching call to `run.end()`. This is\na lower-level way to use a RunLoop instead of using `run()`.\n\n```javascript\nimport { begin, end } from '@ember/runloop';\n\nbegin();\n// code to be executed within a RunLoop\nend();\n```", "itemtype": "method", "name": "begin", "static": 1, "return": { "description": "", "type": "Void" }, "access": "public", "tagname": "", "class": "@ember/runloop", "module": "@ember/runloop" }, { "file": "packages/ember-metal/lib/run_loop.js", "line": 209, "description": "Ends a RunLoop. This must be called sometime after you call\n`run.begin()` to flush any deferred actions. This is a lower-level way\nto use a RunLoop instead of using `run()`.\n\n```javascript\nimport { begin, end } from '@ember/runloop';\n\nbegin();\n// code to be executed within a RunLoop\nend();\n```", "itemtype": "method", "name": "end", "static": 1, "return": { "description": "", "type": "Void" }, "access": "public", "tagname": "", "class": "@ember/runloop", "module": "@ember/runloop" }, { "file": "packages/ember-metal/lib/run_loop.js", "line": 232, "description": "Array of named queues. This array determines the order in which queues\nare flushed at the end of the RunLoop. You can define your own queues by\nsimply adding the queue name to this array. Normally you should not need\nto inspect or modify this property.", "itemtype": "property", "name": "queues", "type": "Array", "default": "['actions', 'destroy']", "access": "private", "tagname": "", "class": "@ember/runloop", "module": "@ember/runloop" }, { "file": "packages/ember-metal/lib/run_loop.js", "line": 244, "description": "Adds the passed target/method and any optional arguments to the named\nqueue to be executed at the end of the RunLoop. If you have not already\nstarted a RunLoop when calling this method one will be started for you\nautomatically.\n\nAt the end of a RunLoop, any methods scheduled in this way will be invoked.\nMethods will be invoked in an order matching the named queues defined in\nthe `run.queues` property.\n\n```javascript\nimport { schedule } from '@ember/runloop';\n\nschedule('actions', this, function() {\n // this will be executed in the 'actions' queue, after bindings have synced.\n console.log('scheduled on actions queue');\n});\n\n// Note the functions will be run in order based on the run queues order.\n// Output would be:\n// scheduled on sync queue\n// scheduled on actions queue\n```", "itemtype": "method", "name": "schedule", "static": 1, "params": [ { "name": "queue", "description": "The name of the queue to schedule against. Default queues is 'actions'", "type": "String" }, { "name": "target", "description": "target object to use as the context when invoking a method.", "type": "Object", "optional": true }, { "name": "method", "description": "The method to invoke. If you pass a string it\n will be resolved on the target object at the time the scheduled item is\n invoked allowing you to change the target function.", "type": "String|Function" }, { "name": "arguments*", "description": "Optional arguments to be passed to the queued method.", "type": "Object", "optional": true } ], "return": { "description": "Timer information for use in canceling, see `run.cancel`.", "type": "*" }, "access": "public", "tagname": "", "class": "@ember/runloop", "module": "@ember/runloop" }, { "file": "packages/ember-metal/lib/run_loop.js", "line": 305, "description": "Invokes the passed target/method and optional arguments after a specified\nperiod of time. The last parameter of this method must always be a number\nof milliseconds.\n\nYou should use this method whenever you need to run some action after a\nperiod of time instead of using `setTimeout()`. This method will ensure that\nitems that expire during the same script execution cycle all execute\ntogether, which is often more efficient than using a real setTimeout.\n\n```javascript\nimport { later } from '@ember/runloop';\n\nlater(myContext, function() {\n // code here will execute within a RunLoop in about 500ms with this == myContext\n}, 500);\n```", "itemtype": "method", "name": "later", "static": 1, "params": [ { "name": "target", "description": "target of method to invoke", "type": "Object", "optional": true }, { "name": "method", "description": "The method to invoke.\n If you pass a string it will be resolved on the\n target at the time the method is invoked.", "type": "Function|String" }, { "name": "args*", "description": "Optional arguments to pass to the timeout.", "type": "Object", "optional": true }, { "name": "wait", "description": "Number of milliseconds to wait.", "type": "Number" } ], "return": { "description": "Timer information for use in canceling, see `run.cancel`.", "type": "*" }, "access": "public", "tagname": "", "class": "@ember/runloop", "module": "@ember/runloop" }, { "file": "packages/ember-metal/lib/run_loop.js", "line": 339, "description": "Schedule a function to run one time during the current RunLoop. This is equivalent\nto calling `scheduleOnce` with the \"actions\" queue.", "itemtype": "method", "name": "once", "static": 1, "params": [ { "name": "target", "description": "The target of the method to invoke.", "type": "Object", "optional": true }, { "name": "method", "description": "The method to invoke.\n If you pass a string it will be resolved on the\n target at the time the method is invoked.", "type": "Function|String" }, { "name": "args*", "description": "Optional arguments to pass to the timeout.", "type": "Object", "optional": true } ], "return": { "description": "Timer information for use in canceling, see `run.cancel`.", "type": "Object" }, "access": "public", "tagname": "", "class": "@ember/runloop", "module": "@ember/runloop" }, { "file": "packages/ember-metal/lib/run_loop.js", "line": 364, "description": "Schedules a function to run one time in a given queue of the current RunLoop.\nCalling this method with the same queue/target/method combination will have\nno effect (past the initial call).\n\nNote that although you can pass optional arguments these will not be\nconsidered when looking for duplicates. New arguments will replace previous\ncalls.\n\n```javascript\nimport { run, scheduleOnce } from '@ember/runloop';\n\nfunction sayHi() {\n console.log('hi');\n}\n\nrun(function() {\n scheduleOnce('afterRender', myContext, sayHi);\n scheduleOnce('afterRender', myContext, sayHi);\n // sayHi will only be executed once, in the afterRender queue of the RunLoop\n});\n```\n\nAlso note that for `run.scheduleOnce` to prevent additional calls, you need to\npass the same function instance. The following case works as expected:\n\n```javascript\nfunction log() {\n console.log('Logging only once');\n}\n\nfunction scheduleIt() {\n scheduleOnce('actions', myContext, log);\n}\n\nscheduleIt();\nscheduleIt();\n```\n\nBut this other case will schedule the function multiple times:\n\n```javascript\nimport { scheduleOnce } from '@ember/runloop';\n\nfunction scheduleIt() {\n scheduleOnce('actions', myContext, function() {\n console.log('Closure');\n });\n}\n\nscheduleIt();\nscheduleIt();\n\n// \"Closure\" will print twice, even though we're using `run.scheduleOnce`,\n// because the function we pass to it won't match the\n// previously scheduled operation.\n```\n\nAvailable queues, and their order, can be found at `run.queues`", "itemtype": "method", "name": "scheduleOnce", "static": 1, "params": [ { "name": "queue", "description": "The name of the queue to schedule against. Default queues is 'actions'.", "type": "String", "optional": true }, { "name": "target", "description": "The target of the method to invoke.", "type": "Object", "optional": true }, { "name": "method", "description": "The method to invoke.\n If you pass a string it will be resolved on the\n target at the time the method is invoked.", "type": "Function|String" }, { "name": "args*", "description": "Optional arguments to pass to the timeout.", "type": "Object", "optional": true } ], "return": { "description": "Timer information for use in canceling, see `run.cancel`.", "type": "Object" }, "access": "public", "tagname": "", "class": "@ember/runloop", "module": "@ember/runloop" }, { "file": "packages/ember-metal/lib/run_loop.js", "line": 450, "description": "Schedules an item to run from within a separate run loop, after\ncontrol has been returned to the system. This is equivalent to calling\n`run.later` with a wait time of 1ms.\n\n```javascript\nimport { next } from '@ember/runloop';\n\nnext(myContext, function() {\n // code to be executed in the next run loop,\n // which will be scheduled after the current one\n});\n```\n\nMultiple operations scheduled with `run.next` will coalesce\ninto the same later run loop, along with any other operations\nscheduled by `run.later` that expire right around the same\ntime that `run.next` operations will fire.\n\nNote that there are often alternatives to using `run.next`.\nFor instance, if you'd like to schedule an operation to happen\nafter all DOM element operations have completed within the current\nrun loop, you can make use of the `afterRender` run loop queue (added\nby the `ember-views` package, along with the preceding `render` queue\nwhere all the DOM element operations happen).\n\nExample:\n\n```app/components/my-component.js\nimport Component from '@ember/component';\nimport { scheduleOnce } from '@ember/runloop';\n\nexport Component.extend({\n didInsertElement() {\n this._super(...arguments);\n scheduleOnce('afterRender', this, 'processChildElements');\n },\n\n processChildElements() {\n // ... do something with component's child component\n // elements after they've finished rendering, which\n // can't be done within this component's\n // `didInsertElement` hook because that gets run\n // before the child elements have been added to the DOM.\n }\n});\n```\n\nOne benefit of the above approach compared to using `run.next` is\nthat you will be able to perform DOM/CSS operations before unprocessed\nelements are rendered to the screen, which may prevent flickering or\nother artifacts caused by delaying processing until after rendering.\n\nThe other major benefit to the above approach is that `run.next`\nintroduces an element of non-determinism, which can make things much\nharder to test, due to its reliance on `setTimeout`; it's much harder\nto guarantee the order of scheduled operations when they are scheduled\noutside of the current run loop, i.e. with `run.next`.", "itemtype": "method", "name": "next", "static": 1, "params": [ { "name": "target", "description": "target of method to invoke", "type": "Object", "optional": true }, { "name": "method", "description": "The method to invoke.\n If you pass a string it will be resolved on the\n target at the time the method is invoked.", "type": "Function|String" }, { "name": "args*", "description": "Optional arguments to pass to the timeout.", "type": "Object", "optional": true } ], "return": { "description": "Timer information for use in canceling, see `run.cancel`.", "type": "Object" }, "access": "public", "tagname": "", "class": "@ember/runloop", "module": "@ember/runloop" }, { "file": "packages/ember-metal/lib/run_loop.js", "line": 525, "description": "Cancels a scheduled item. Must be a value returned by `later()`,\n`once()`, `scheduleOnce()`, `next()`, `debounce()`, or\n`throttle()`.\n\n```javascript\nimport {\n next,\n cancel,\n later,\n scheduleOnce,\n once,\n throttle,\n debounce\n} from '@ember/runloop';\n\nlet runNext = next(myContext, function() {\n // will not be executed\n});\n\ncancel(runNext);\n\nlet runLater = later(myContext, function() {\n // will not be executed\n}, 500);\n\ncancel(runLater);\n\nlet runScheduleOnce = scheduleOnce('afterRender', myContext, function() {\n // will not be executed\n});\n\ncancel(runScheduleOnce);\n\nlet runOnce = once(myContext, function() {\n // will not be executed\n});\n\ncancel(runOnce);\n\nlet throttle = throttle(myContext, function() {\n // will not be executed\n}, 1, false);\n\ncancel(throttle);\n\nlet debounce = debounce(myContext, function() {\n // will not be executed\n}, 1);\n\ncancel(debounce);\n\nlet debounceImmediate = debounce(myContext, function() {\n // will be executed since we passed in true (immediate)\n}, 100, true);\n\n// the 100ms delay until this method can be called again will be canceled\ncancel(debounceImmediate);\n```", "itemtype": "method", "name": "cancel", "static": 1, "params": [ { "name": "timer", "description": "Timer object to cancel", "type": "Object" } ], "return": { "description": "true if canceled or false/undefined if it wasn't found", "type": "Boolean" }, "access": "public", "tagname": "", "class": "@ember/runloop", "module": "@ember/runloop" }, { "file": "packages/ember-metal/lib/run_loop.js", "line": 596, "description": "Delay calling the target method until the debounce period has elapsed\nwith no additional debounce calls. If `debounce` is called again before\nthe specified time has elapsed, the timer is reset and the entire period\nmust pass again before the target method is called.\n\nThis method should be used when an event may be called multiple times\nbut the action should only be called once when the event is done firing.\nA common example is for scroll events where you only want updates to\nhappen once scrolling has ceased.\n\n```javascript\nimport { debounce } from '@ember/runloop';\n\nfunction whoRan() {\n console.log(this.name + ' ran.');\n}\n\nlet myContext = { name: 'debounce' };\n\ndebounce(myContext, whoRan, 150);\n\n// less than 150ms passes\ndebounce(myContext, whoRan, 150);\n\n// 150ms passes\n// whoRan is invoked with context myContext\n// console logs 'debounce ran.' one time.\n```\n\nImmediate allows you to run the function immediately, but debounce\nother calls for this function until the wait time has elapsed. If\n`debounce` is called again before the specified time has elapsed,\nthe timer is reset and the entire period must pass again before\nthe method can be called again.\n\n```javascript\nimport { debounce } from '@ember/runloop';\n\nfunction whoRan() {\n console.log(this.name + ' ran.');\n}\n\nlet myContext = { name: 'debounce' };\n\ndebounce(myContext, whoRan, 150, true);\n\n// console logs 'debounce ran.' one time immediately.\n// 100ms passes\ndebounce(myContext, whoRan, 150, true);\n\n// 150ms passes and nothing else is logged to the console and\n// the debouncee is no longer being watched\ndebounce(myContext, whoRan, 150, true);\n\n// console logs 'debounce ran.' one time immediately.\n// 150ms passes and nothing else is logged to the console and\n// the debouncee is no longer being watched\n```", "itemtype": "method", "name": "debounce", "static": 1, "params": [ { "name": "target", "description": "target of method to invoke", "type": "Object", "optional": true }, { "name": "method", "description": "The method to invoke.\n May be a function or a string. If you pass a string\n then it will be looked up on the passed target.", "type": "Function|String" }, { "name": "args*", "description": "Optional arguments to pass to the timeout.", "type": "Object", "optional": true }, { "name": "wait", "description": "Number of milliseconds to wait.", "type": "Number" }, { "name": "immediate", "description": "Trigger the function on the leading instead\n of the trailing edge of the wait interval. Defaults to false.", "type": "Boolean" } ], "return": { "description": "Timer information for use in canceling, see `run.cancel`.", "type": "Array" }, "access": "public", "tagname": "", "class": "@ember/runloop", "module": "@ember/runloop" }, { "file": "packages/ember-metal/lib/run_loop.js", "line": 674, "description": "Ensure that the target method is never called more frequently than\nthe specified spacing period. The target method is called immediately.\n\n```javascript\nimport { throttle } from '@ember/runloop';\n\nfunction whoRan() {\n console.log(this.name + ' ran.');\n}\n\nlet myContext = { name: 'throttle' };\n\nthrottle(myContext, whoRan, 150);\n// whoRan is invoked with context myContext\n// console logs 'throttle ran.'\n\n// 50ms passes\nthrottle(myContext, whoRan, 150);\n\n// 50ms passes\nthrottle(myContext, whoRan, 150);\n\n// 150ms passes\nthrottle(myContext, whoRan, 150);\n// whoRan is invoked with context myContext\n// console logs 'throttle ran.'\n```", "itemtype": "method", "name": "throttle", "static": 1, "params": [ { "name": "target", "description": "target of method to invoke", "type": "Object", "optional": true }, { "name": "method", "description": "The method to invoke.\n May be a function or a string. If you pass a string\n then it will be looked up on the passed target.", "type": "Function|String" }, { "name": "args*", "description": "Optional arguments to pass to the timeout.", "type": "Object", "optional": true }, { "name": "spacing", "description": "Number of milliseconds to space out requests.", "type": "Number" }, { "name": "immediate", "description": "Trigger the function on the leading instead\n of the trailing edge of the wait interval. Defaults to true.", "type": "Boolean" } ], "return": { "description": "Timer information for use in canceling, see `run.cancel`.", "type": "Array" }, "access": "public", "tagname": "", "class": "@ember/runloop", "module": "@ember/runloop" }, { "file": "packages/ember-metal/lib/run_loop.js", "line": 721, "description": "Add a new named queue after the specified queue.\n\nThe queue to add will only be added once.", "itemtype": "method", "name": "_addQueue", "params": [ { "name": "name", "description": "the name of the queue to add.", "type": "String" }, { "name": "after", "description": "the name of the queue to add after.", "type": "String" } ], "access": "private", "tagname": "", "class": "@ember/runloop", "module": "@ember/runloop" }, { "file": "packages/ember-metal/lib/set_properties.js", "line": 6, "description": "Set a list of properties on an object. These properties are set inside\na single `beginPropertyChanges` and `endPropertyChanges` batch, so\nobservers will be buffered.\n\n```javascript\nimport EmberObject from '@ember/object';\nlet anObject = EmberObject.create();\n\nanObject.setProperties({\n firstName: 'Stanley',\n lastName: 'Stuart',\n age: 21\n});\n```", "itemtype": "method", "name": "setProperties", "static": 1, "params": [ { "name": "obj", "description": "" }, { "name": "properties", "description": "", "type": "Object" } ], "return": { "description": "properties" }, "access": "public", "tagname": "", "class": "@ember/object", "module": "@ember/object" }, { "file": "packages/ember-metal/lib/watching.js", "line": 19, "description": "Starts watching a property on an object. Whenever the property changes,\ninvokes `Ember.notifyPropertyChange`. This is the primitive used by observers\nand dependent keys; usually you will never call this method directly but instead\nuse higher level methods like `addObserver()`.", "access": "private", "tagname": "", "itemtype": "method", "name": "watch", "params": [ { "name": "obj", "description": "" }, { "name": "_keyPath", "description": "", "type": "String" } ], "class": "Ember", "module": "ember" }, { "file": "packages/ember-routing/lib/ext/controller.js", "line": 12, "description": "Defines which query parameters the controller accepts.\nIf you give the names `['category','page']` it will bind\nthe values of these query parameters to the variables\n`this.category` and `this.page`.\nBy default, Ember coerces query parameter values using `toggleProperty`.\nThis behavior may lead to unexpected results.\nTo explicitly configure a query parameter property so it coerces as expected, you must define a type property:\n```javascript\n queryParams: [{\n category: {\n type: 'boolean'\n }\n }]\n```", "itemtype": "property", "name": "queryParams", "access": "public", "tagname": "", "class": "ControllerMixin", "module": "ember" }, { "file": "packages/ember-routing/lib/ext/controller.js", "line": 32, "description": "This property is updated to various different callback functions depending on\nthe current \"state\" of the backing route. It is used by\n`Controller.prototype._qpChanged`.\n\nThe methods backing each state can be found in the `Route.prototype._qp` computed\nproperty return value (the `.states` property). The current values are listed here for\nthe sanity of future travelers:\n\n* `inactive` - This state is used when this controller instance is not part of the active\n route hierarchy. Set in `Route.prototype._reset` (a `router.js` microlib hook) and\n `Route.prototype.actions.finalizeQueryParamChange`.\n* `active` - This state is used when this controller instance is part of the active\n route hierarchy. Set in `Route.prototype.actions.finalizeQueryParamChange`.\n* `allowOverrides` - This state is used in `Route.prototype.setup` (`route.js` microlib hook).", "itemtype": "method", "name": "_qpDelegate", "access": "private", "tagname": "", "class": "ControllerMixin", "module": "ember" }, { "file": "packages/ember-routing/lib/ext/controller.js", "line": 53, "description": "During `Route#setup` observers are created to invoke this method\nwhen any of the query params declared in `Controller#queryParams` property\nare changed.\n\n\nWhen invoked this method uses the currently active query param update delegate\n(see `Controller.prototype._qpDelegate` for details) and invokes it with\nthe QP key/value being changed.", "itemtype": "method", "name": "_qpChanged", "access": "private", "tagname": "", "class": "ControllerMixin", "module": "ember" }, { "file": "packages/ember-routing/lib/ext/controller.js", "line": 74, "description": "Transition the application into another route. The route may\nbe either a single route or route path:\n\n```javascript\naController.transitionToRoute('blogPosts');\naController.transitionToRoute('blogPosts.recentEntries');\n```\n\nOptionally supply a model for the route in question. The model\nwill be serialized into the URL using the `serialize` hook of\nthe route:\n\n```javascript\naController.transitionToRoute('blogPost', aPost);\n```\n\nIf a literal is passed (such as a number or a string), it will\nbe treated as an identifier instead. In this case, the `model`\nhook of the route will be triggered:\n\n```javascript\naController.transitionToRoute('blogPost', 1);\n```\n\nMultiple models will be applied last to first recursively up the\nroute tree.\n\n```app/router.js\nRouter.map(function() {\n this.route('blogPost', { path: ':blogPostId' }, function() {\n this.route('blogComment', { path: ':blogCommentId', resetNamespace: true });\n });\n});\n```\n\n```javascript\naController.transitionToRoute('blogComment', aPost, aComment);\naController.transitionToRoute('blogComment', 1, 13);\n```\n\nIt is also possible to pass a URL (a string that starts with a\n`/`). This is intended for testing and debugging purposes and\nshould rarely be used in production code.\n\n```javascript\naController.transitionToRoute('/');\naController.transitionToRoute('/blog/post/1/comment/13');\naController.transitionToRoute('/blog/posts?sort=title');\n```\n\nAn options hash with a `queryParams` property may be provided as\nthe final argument to add query parameters to the destination URL.\n\n```javascript\naController.transitionToRoute('blogPost', 1, {\n queryParams: { showComments: 'true' }\n});\n\n// if you just want to transition the query parameters without changing the route\naController.transitionToRoute({ queryParams: { sort: 'date' } });\n```\n\nSee also [replaceRoute](/api/ember/release/classes/Ember.ControllerMixin/methods/replaceRoute?anchor=replaceRoute).", "params": [ { "name": "name", "description": "the name of the route or a URL", "type": "String" }, { "name": "models", "description": "the model(s) or identifier(s) to be used\n while transitioning to the route.", "type": "...Object" }, { "name": "options", "description": "optional hash with a queryParams property\n containing a mapping of query parameters", "type": "Object", "optional": true } ], "itemtype": "method", "name": "transitionToRoute", "access": "public", "tagname": "", "class": "ControllerMixin", "module": "ember" }, { "file": "packages/ember-routing/lib/ext/controller.js", "line": 155, "description": "Transition into another route while replacing the current URL, if possible.\nThis will replace the current history entry instead of adding a new one.\nBeside that, it is identical to `transitionToRoute` in all other respects.\n\n```javascript\naController.replaceRoute('blogPosts');\naController.replaceRoute('blogPosts.recentEntries');\n```\n\nOptionally supply a model for the route in question. The model\nwill be serialized into the URL using the `serialize` hook of\nthe route:\n\n```javascript\naController.replaceRoute('blogPost', aPost);\n```\n\nIf a literal is passed (such as a number or a string), it will\nbe treated as an identifier instead. In this case, the `model`\nhook of the route will be triggered:\n\n```javascript\naController.replaceRoute('blogPost', 1);\n```\n\nMultiple models will be applied last to first recursively up the\nroute tree.\n\n```app/router.js\nRouter.map(function() {\n this.route('blogPost', { path: ':blogPostId' }, function() {\n this.route('blogComment', { path: ':blogCommentId', resetNamespace: true });\n });\n});\n```\n\n```\naController.replaceRoute('blogComment', aPost, aComment);\naController.replaceRoute('blogComment', 1, 13);\n```\n\nIt is also possible to pass a URL (a string that starts with a\n`/`). This is intended for testing and debugging purposes and\nshould rarely be used in production code.\n\n```javascript\naController.replaceRoute('/');\naController.replaceRoute('/blog/post/1/comment/13');\n```", "params": [ { "name": "name", "description": "the name of the route or a URL", "type": "String" }, { "name": "models", "description": "the model(s) or identifier(s) to be used\nwhile transitioning to the route.", "type": "...Object" } ], "itemtype": "method", "name": "replaceRoute", "access": "public", "tagname": "", "class": "ControllerMixin", "module": "ember" }, { "file": "packages/ember-routing/lib/location/api.js", "line": 68, "description": "This is deprecated in favor of using the container to lookup the location\nimplementation as desired.\n\nFor example:\n\n```javascript\n// Given a location registered as follows:\ncontainer.register('location:history-test', HistoryTestLocation);\n\n// You could create a new instance via:\ncontainer.lookup('location:history-test');\n```", "itemtype": "method", "name": "create", "params": [ { "name": "options", "description": "", "type": "Object" } ], "return": { "description": "an instance of an implementation of the `location` API", "type": "Object" }, "deprecated": true, "deprecationMessage": "Use the container to lookup the location implementation that you\n need.", "access": "private", "tagname": "", "class": "Location", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/api.js", "line": 102, "description": "Returns the current `location.hash` by parsing location.href since browsers\ninconsistently URL-decode `location.hash`.\n\nhttps://bugzilla.mozilla.org/show_bug.cgi?id=483304", "access": "private", "tagname": "", "itemtype": "method", "name": "getHash", "since": "1.4.0", "class": "Location", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/auto_location.js", "line": 66, "access": "private", "tagname": "The browser's `location` object. This is typically equivalent to\n`window.location`, but may be overridden for testing.", "itemtype": "property", "name": "location", "default": "environment.location", "class": "AutoLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/auto_location.js", "line": 77, "access": "private", "tagname": "The browser's `history` object. This is typically equivalent to\n`window.history`, but may be overridden for testing.", "since": "1.5.1", "itemtype": "property", "name": "history", "default": "environment.history", "class": "AutoLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/auto_location.js", "line": 89, "access": "private", "tagname": "The user agent's global variable. In browsers, this will be `window`.", "since": "1.11", "itemtype": "property", "name": "global", "default": "window", "class": "AutoLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/auto_location.js", "line": 100, "access": "private", "tagname": "The browser's `userAgent`. This is typically equivalent to\n`navigator.userAgent`, but may be overridden for testing.", "since": "1.5.1", "itemtype": "property", "name": "userAgent", "default": "environment.history", "class": "AutoLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/auto_location.js", "line": 112, "access": "private", "tagname": "This property is used by the router to know whether to cancel the routing\nsetup process, which is needed while we redirect the browser.", "since": "1.5.1", "itemtype": "property", "name": "cancelRouterSetup", "default": "false", "class": "AutoLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/auto_location.js", "line": 124, "access": "private", "tagname": "Will be pre-pended to path upon state change.", "since": "1.5.1", "itemtype": "property", "name": "rootURL", "default": "'/'", "class": "AutoLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/auto_location.js", "line": 135, "description": "Called by the router to instruct the location to do any feature detection\nnecessary. In the case of AutoLocation, we detect whether to use history\nor hash concrete implementations.", "access": "private", "tagname": "", "class": "AutoLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/auto_location.js", "line": 259, "access": "private", "tagname": "Returns the current path as it should appear for HistoryLocation supported\nbrowsers. This may very well differ from the real current path (e.g. if it\nstarts off as a hashed URL)", "class": "AutoLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/auto_location.js", "line": 303, "access": "private", "tagname": "Returns the current path as it should appear for HashLocation supported\nbrowsers. This may very well differ from the real current path.", "itemtype": "method", "name": "_getHashPath", "class": "AutoLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/hash_location.js", "line": 51, "access": "private", "tagname": "Returns normalized location.hash", "since": "1.5.1", "itemtype": "method", "name": "getHash", "class": "HashLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/hash_location.js", "line": 61, "description": "Returns the normalized URL, constructed from `location.hash`.\n\ne.g. `#/foo` => `/foo` as well as `#/foo#bar` => `/foo#bar`.\n\nBy convention, hashed paths must begin with a forward slash, otherwise they\nare not treated as a path so we can distinguish intent.", "access": "private", "tagname": "", "itemtype": "method", "name": "getURL", "class": "HashLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/hash_location.js", "line": 91, "description": "Set the `location.hash` and remembers what was set. This prevents\n`onUpdateURL` callbacks from triggering when the hash was set by\n`HashLocation`.", "access": "private", "tagname": "", "itemtype": "method", "name": "setURL", "params": [ { "name": "path", "description": "", "type": "String" } ], "class": "HashLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/hash_location.js", "line": 105, "description": "Uses location.replace to update the url without a page reload\nor history modification.", "access": "private", "tagname": "", "itemtype": "method", "name": "replaceURL", "params": [ { "name": "path", "description": "", "type": "String" } ], "class": "HashLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/hash_location.js", "line": 118, "description": "Register a callback to be invoked when the hash changes. These\ncallbacks will execute when the user presses the back or forward\nbutton, but not after `setURL` is invoked.", "access": "private", "tagname": "", "itemtype": "method", "name": "onUpdateURL", "params": [ { "name": "callback", "description": "", "type": "Function" } ], "class": "HashLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/hash_location.js", "line": 142, "description": "Given a URL, formats it to be placed into the page as part\nof an element's `href` attribute.\n\nThis is used, for example, when using the {{action}} helper\nto generate a URL based on an event.", "access": "private", "tagname": "", "itemtype": "method", "name": "formatURL", "params": [ { "name": "url", "description": "", "type": "String" } ], "class": "HashLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/hash_location.js", "line": 157, "description": "Cleans up the HashLocation event listener.", "access": "private", "tagname": "", "itemtype": "method", "name": "willDestroy", "class": "HashLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/history_location.js", "line": 73, "description": "Used to set state on first call to setURL", "access": "private", "tagname": "", "itemtype": "method", "name": "initState", "class": "HistoryLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/history_location.js", "line": 97, "description": "Will be pre-pended to path upon state change", "itemtype": "property", "name": "rootURL", "default": "'/'", "access": "private", "tagname": "", "class": "HistoryLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/history_location.js", "line": 106, "description": "Returns the current `location.pathname` without `rootURL` or `baseURL`", "access": "private", "tagname": "", "itemtype": "method", "name": "getURL", "return": { "description": "url", "type": "String" }, "class": "HistoryLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/history_location.js", "line": 136, "description": "Uses `history.pushState` to update the url without a page reload.", "access": "private", "tagname": "", "itemtype": "method", "name": "setURL", "params": [ { "name": "path", "description": "", "type": "String" } ], "class": "HistoryLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/history_location.js", "line": 152, "description": "Uses `history.replaceState` to update the url without a page reload\nor history modification.", "access": "private", "tagname": "", "itemtype": "method", "name": "replaceURL", "params": [ { "name": "path", "description": "", "type": "String" } ], "class": "HistoryLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/history_location.js", "line": 169, "description": "Get the current `history.state`. Checks for if a polyfill is\nrequired and if so fetches this._historyState. The state returned\nfrom getState may be null if an iframe has changed a window's\nhistory.\n\nThe object returned will contain a `path` for the given state as well\nas a unique state `id`. The state index will allow the app to distinguish\nbetween two states with similar paths but should be unique from one another.", "access": "private", "tagname": "", "itemtype": "method", "name": "getState", "return": { "description": "state", "type": "Object" }, "class": "HistoryLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/history_location.js", "line": 191, "description": "Pushes a new state.", "access": "private", "tagname": "", "itemtype": "method", "name": "pushState", "params": [ { "name": "path", "description": "", "type": "String" } ], "class": "HistoryLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/history_location.js", "line": 209, "description": "Replaces the current state.", "access": "private", "tagname": "", "itemtype": "method", "name": "replaceState", "params": [ { "name": "path", "description": "", "type": "String" } ], "class": "HistoryLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/history_location.js", "line": 227, "description": "Register a callback to be invoked whenever the browser\nhistory changes, including using forward and back buttons.", "access": "private", "tagname": "", "itemtype": "method", "name": "onUpdateURL", "params": [ { "name": "callback", "description": "", "type": "Function" } ], "class": "HistoryLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/history_location.js", "line": 250, "description": "Used when using `{{action}}` helper. The url is always appended to the rootURL.", "access": "private", "tagname": "", "itemtype": "method", "name": "formatURL", "params": [ { "name": "url", "description": "", "type": "String" } ], "return": { "description": "formatted url", "type": "String" }, "class": "HistoryLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/history_location.js", "line": 275, "description": "Cleans up the HistoryLocation event listener.", "access": "private", "tagname": "", "itemtype": "method", "name": "willDestroy", "class": "HistoryLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/history_location.js", "line": 285, "access": "private", "tagname": "Returns normalized location.hash", "itemtype": "method", "name": "getHash", "class": "HistoryLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/none_location.js", "line": 39, "description": "Will be pre-pended to path.", "access": "private", "tagname": "", "itemtype": "property", "name": "rootURL", "default": "'/'", "class": "NoneLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/none_location.js", "line": 48, "description": "Returns the current path without `rootURL`.", "access": "private", "tagname": "", "itemtype": "method", "name": "getURL", "return": { "description": "path", "type": "String" }, "class": "NoneLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/none_location.js", "line": 66, "description": "Set the path and remembers what was set. Using this method\nto change the path will not invoke the `updateURL` callback.", "access": "private", "tagname": "", "itemtype": "method", "name": "setURL", "params": [ { "name": "path", "description": "", "type": "String" } ], "class": "NoneLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/none_location.js", "line": 78, "description": "Register a callback to be invoked when the path changes. These\ncallbacks will execute when the user presses the back or forward\nbutton, but not after `setURL` is invoked.", "access": "private", "tagname": "", "itemtype": "method", "name": "onUpdateURL", "params": [ { "name": "callback", "description": "", "type": "Function" } ], "class": "NoneLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/none_location.js", "line": 91, "description": "Sets the path and calls the `updateURL` callback.", "access": "private", "tagname": "", "itemtype": "method", "name": "handleURL", "params": [ { "name": "url", "description": "", "type": "String" } ], "class": "NoneLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/none_location.js", "line": 103, "description": "Given a URL, formats it to be placed into the page as part\nof an element's `href` attribute.\n\nThis is used, for example, when using the {{action}} helper\nto generate a URL based on an event.", "access": "private", "tagname": "", "itemtype": "method", "name": "formatURL", "params": [ { "name": "url", "description": "", "type": "String" } ], "return": { "description": "url", "type": "String" }, "class": "NoneLocation", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/util.js", "line": 1, "access": "private", "tagname": "Returns the current `location.pathname`, normalized for IE inconsistencies.", "class": "RouterService", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/util.js", "line": 16, "access": "private", "tagname": "Returns the current `location.search`.", "class": "RouterService", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/util.js", "line": 25, "access": "private", "tagname": "Returns the current `location.hash` by parsing location.href since browsers\ninconsistently URL-decode `location.hash`.\n\nShould be passed the browser's `location` object as the first argument.\n\nhttps://bugzilla.mozilla.org/show_bug.cgi?id=483304", "class": "RouterService", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/location/util.js", "line": 105, "description": "Replaces the current location, making sure we explicitly include the origin\nto prevent redirecting to a different origin.", "access": "private", "tagname": "", "class": "RouterService", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/services/router.js", "line": 25, "description": "Name of the current route.\n\nThis property represent the logical name of the route,\nwhich is comma separated.\nFor the following router:\n\n```app/router.js\nRouter.map(function() {\n this.route('about);\n this.route('blog', function () {\n this.route('post', { path: ':post_id' });\n });\n});\n```\n\nIt will return:\n\n* `index` when you visit `/`\n* `about` when you visit `/about`\n* `blog.index` when you visit `/blog`\n* `blog.post` when you visit `/blog/some-post-id`", "itemtype": "property", "name": "currentRouteName", "type": "String", "access": "public", "tagname": "", "class": "RouterService", "module": "ember" }, { "file": "packages/ember-routing/lib/services/router.js", "line": 54, "description": "Current URL for the application.\n\n This property represent the URL path for this route.\n For the following router:\n\n```app/router.js\nRouter.map(function() {\n this.route('about);\n this.route('blog', function () {\n this.route('post', { path: ':post_id' });\n });\n});\n```\n\nIt will return:\n\n* `/` when you visit `/`\n* `/about` when you visit `/about`\n* `/blog/index` when you visit `/blog`\n* `/blog/post` when you visit `/blog/some-post-id`", "itemtype": "property", "name": "currentURL", "type": "String", "access": "public", "tagname": "", "class": "RouterService", "module": "ember" }, { "file": "packages/ember-routing/lib/services/router.js", "line": 82, "description": "The `location` property determines the type of URL's that your\napplication will use.\nThe following location types are currently available:\n* `auto`\n* `hash`\n* `history`\n* `none`", "itemtype": "property", "name": "location", "default": "'hash'", "see": [ "{Location}" ], "access": "public", "tagname": "", "class": "RouterService", "module": "ember" }, { "file": "packages/ember-routing/lib/services/router.js", "line": 98, "description": "The `rootURL` property represents the URL of the root of\nthe application, '/' by default.\nThis prefix is assumed on all routes defined on this app.\n\nIF you change the `rootURL` in your environment configuration\nlike so:\n\n```config/environment.js\n'use strict';\n\nmodule.exports = function(environment) {\n let ENV = {\n modulePrefix: 'router-service',\n environment,\n rootURL: '/my-root',\n …\n }\n]\n```\n\nThis property will return `/my-root`.", "itemtype": "property", "name": "rootURL", "default": "'/'", "access": "public", "tagname": "", "class": "RouterService", "module": "ember" }, { "file": "packages/ember-routing/lib/services/router.js", "line": 128, "description": "Transition the application into another route. The route may\nbe either a single route or route path:\n\nSee [transitionTo](/api/ember/release/classes/Route/methods/transitionTo?anchor=transitionTo) for more info.", "itemtype": "method", "name": "transitionTo", "category": [ "ember-routing-router-service" ], "params": [ { "name": "routeNameOrUrl", "description": "the name of the route or a URL", "type": "String" }, { "name": "models", "description": "the model(s) or identifier(s) to be used while\n transitioning to the route.", "type": "...Object" }, { "name": "options", "description": "optional hash with a queryParams property\n containing a mapping of query parameters", "type": "Object", "optional": true } ], "return": { "description": "the transition object associated with this\n attempted transition", "type": "Transition" }, "access": "public", "tagname": "", "class": "RouterService", "module": "ember" }, { "file": "packages/ember-routing/lib/services/router.js", "line": 158, "description": "Transition into another route while replacing the current URL, if possible.\nThe route may be either a single route or route path:\n\nSee [replaceWith](/api/ember/release/classes/Route/methods/replaceWith?anchor=replaceWith) for more info.", "itemtype": "method", "name": "replaceWith", "category": [ "ember-routing-router-service" ], "params": [ { "name": "routeNameOrUrl", "description": "the name of the route or a URL", "type": "String" }, { "name": "models", "description": "the model(s) or identifier(s) to be used while\n transitioning to the route.", "type": "...Object" }, { "name": "options", "description": "optional hash with a queryParams property\n containing a mapping of query parameters", "type": "Object", "optional": true } ], "return": { "description": "the transition object associated with this\n attempted transition", "type": "Transition" }, "access": "public", "tagname": "", "class": "RouterService", "module": "ember" }, { "file": "packages/ember-routing/lib/services/router.js", "line": 179, "description": "Generate a URL based on the supplied route name.", "itemtype": "method", "name": "urlFor", "category": [ "ember-routing-router-service" ], "params": [ { "name": "routeName", "description": "the name of the route", "type": "String" }, { "name": "models", "description": "the model(s) or identifier(s) to be used while\n transitioning to the route.", "type": "...Object" }, { "name": "options", "description": "optional hash with a queryParams property\n containing a mapping of query parameters", "type": "Object", "optional": true } ], "return": { "description": "the string representing the generated URL", "type": "String" }, "access": "public", "tagname": "", "class": "RouterService", "module": "ember" }, { "file": "packages/ember-routing/lib/services/router.js", "line": 196, "description": "Determines whether a route is active.", "itemtype": "method", "name": "isActive", "category": [ "ember-routing-router-service" ], "params": [ { "name": "routeName", "description": "the name of the route", "type": "String" }, { "name": "models", "description": "the model(s) or identifier(s) to be used while\n transitioning to the route.", "type": "...Object" }, { "name": "options", "description": "optional hash with a queryParams property\n containing a mapping of query parameters", "type": "Object", "optional": true } ], "return": { "description": "true if the provided routeName/models/queryParams are active", "type": "Boolean" }, "access": "public", "tagname": "", "class": "RouterService", "module": "ember" }, { "file": "packages/ember-routing/lib/system/controller_for.js", "line": 5, "description": "Finds a controller instance.", "itemtype": "method", "name": "controllerFor", "access": "private", "tagname": "", "class": "Ember", "module": "ember" }, { "file": "packages/ember-routing/lib/system/generate_controller.js", "line": 8, "description": "Generates a controller factory", "itemtype": "method", "name": "generateControllerFactory", "access": "private", "tagname": "", "class": "Ember", "module": "ember" }, { "file": "packages/ember-routing/lib/system/generate_controller.js", "line": 32, "description": "Generates and instantiates a controller extending from `controller:basic`\nif present, or `Controller` if not.", "itemtype": "method", "name": "generateController", "access": "private", "tagname": "", "since": "1.3.0", "class": "Ember", "module": "ember" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 75, "description": "Configuration hash for this route's queryParams. The possible\nconfiguration options and their defaults are as follows\n(assuming a query param whose controller property is `page`):\n\n```javascript\nqueryParams: {\n page: {\n // By default, controller query param properties don't\n // cause a full transition when they are changed, but\n // rather only cause the URL to update. Setting\n // `refreshModel` to true will cause an \"in-place\"\n // transition to occur, whereby the model hooks for\n // this route (and any child routes) will re-fire, allowing\n // you to reload models (e.g., from the server) using the\n // updated query param values.\n refreshModel: false,\n\n // By default, changes to controller query param properties\n // cause the URL to update via `pushState`, which means an\n // item will be added to the browser's history, allowing\n // you to use the back button to restore the app to the\n // previous state before the query param property was changed.\n // Setting `replace` to true will use `replaceState` (or its\n // hash location equivalent), which causes no browser history\n // item to be added. This options name and default value are\n // the same as the `link-to` helper's `replace` option.\n replace: false,\n\n // By default, the query param URL key is the same name as\n // the controller property name. Use `as` to specify a\n // different URL key.\n as: 'page'\n }\n}\n```", "itemtype": "property", "name": "queryParams", "type": "Object", "since": "1.6.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 120, "description": "The name of the route, dot-delimited.\n\nFor example, a route found at `app/routes/posts/post.js` will have\na `routeName` of `posts.post`.", "itemtype": "property", "name": "routeName", "type": "String", "since": "1.0.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 133, "description": "Sets the name for this route, including a fully resolved name for routes\ninside engines.", "access": "private", "tagname": "", "itemtype": "method", "name": "_setRouteName", "params": [ { "name": "name", "description": "", "type": "String" } ], "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 146, "access": "private", "tagname": "", "itemtype": "property", "name": "_qp", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 268, "access": "private", "tagname": "", "itemtype": "property", "name": "_names", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 275, "access": "private", "tagname": "", "itemtype": "method", "name": "_stashNames", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 304, "access": "private", "tagname": "", "itemtype": "property", "name": "_activeQPChanged", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 313, "access": "private", "tagname": "", "itemtype": "method", "name": "_updatingQPChanged", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 323, "description": "Returns a hash containing the parameters of an ancestor route.\n\nExample\n\n```app/router.js\n// ...\n\nRouter.map(function() {\n this.route('member', { path: ':name' }, function() {\n this.route('interest', { path: ':interest' });\n });\n});\n```\n\n```app/routes/member.js\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n queryParams: {\n memberQp: { refreshModel: true }\n }\n});\n```\n\n```app/routes/member/interest.js\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n queryParams: {\n interestQp: { refreshModel: true }\n },\n\n model() {\n return this.paramsFor('member');\n }\n});\n```\n\nIf we visit `/turing/maths?memberQp=member&interestQp=interest` the model for\nthe `member.interest` route is hash with:\n\n* `name`: `turing`\n* `memberQp`: `member`", "itemtype": "method", "name": "paramsFor", "params": [ { "name": "name", "description": "", "type": "String" } ], "return": { "description": "hash containing the parameters of the route `name`", "type": "Object" }, "since": "1.4.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 395, "description": "Serializes the query parameter key", "itemtype": "method", "name": "serializeQueryParamKey", "params": [ { "name": "controllerPropertyName", "description": "", "type": "String" } ], "access": "private", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 406, "description": "Serializes value of the query parameter based on defaultValueType", "itemtype": "method", "name": "serializeQueryParam", "params": [ { "name": "value", "description": "", "type": "Object" }, { "name": "urlKey", "description": "", "type": "String" }, { "name": "defaultValueType", "description": "", "type": "String" } ], "access": "private", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 422, "description": "Deserializes value of the query parameter based on defaultValueType", "itemtype": "method", "name": "deserializeQueryParam", "params": [ { "name": "value", "description": "", "type": "Object" }, { "name": "urlKey", "description": "", "type": "String" }, { "name": "defaultValueType", "description": "", "type": "String" } ], "access": "private", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 438, "access": "private", "tagname": "", "itemtype": "property", "name": "_optionsForQueryParam", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 447, "description": "A hook you can use to reset controller values either when the model\nchanges or the route is exiting.\n\n```app/routes/articles.js\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n resetController(controller, isExiting, transition) {\n if (isExiting && transition.targetName !== 'error') {\n controller.set('page', 1);\n }\n }\n});\n```", "itemtype": "method", "name": "resetController", "params": [ { "name": "controller", "description": "instance", "type": "Controller" }, { "name": "isExiting", "description": "", "type": "Boolean" }, { "name": "transition", "description": "", "type": "Object" } ], "since": "1.7.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 472, "access": "private", "tagname": "", "itemtype": "method", "name": "exit", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 483, "access": "private", "tagname": "", "itemtype": "method", "name": "_reset", "since": "1.7.0", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 496, "access": "private", "tagname": "", "itemtype": "method", "name": "enter", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 507, "description": "The name of the template to use by default when rendering this routes\ntemplate.\n\n```app/routes/posts/list.js\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n templateName: 'posts/list'\n});\n```\n\n```app/routes/posts/index.js\nimport PostsList from '../posts/list';\n\nexport default PostsList.extend();\n```\n\n```app/routes/posts/archived.js\nimport PostsList from '../posts/list';\n\nexport default PostsList.extend();\n```", "itemtype": "property", "name": "templateName", "type": "String", "default": "null", "since": "1.4.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 539, "description": "The name of the controller to associate with this route.\n\nBy default, Ember will lookup a route's controller that matches the name\nof the route (i.e. `App.PostController` for `App.PostRoute`). However,\nif you would like to define a specific controller to use, you can do so\nusing this property.\n\nThis is useful in many ways, as the controller specified will be:\n\n* passed to the `setupController` method.\n* used as the controller for the template being rendered by the route.\n* returned from a call to `controllerFor` for the route.", "itemtype": "property", "name": "controllerName", "type": "String", "default": "null", "since": "1.4.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 561, "description": "The `willTransition` action is fired at the beginning of any\nattempted transition with a `Transition` object as the sole\nargument. This action can be used for aborting, redirecting,\nor decorating the transition from the currently active routes.\n\nA good example is preventing navigation when a form is\nhalf-filled out:\n\n```app/routes/contact-form.js\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n actions: {\n willTransition(transition) {\n if (this.controller.get('userHasEnteredData')) {\n this.controller.displayNavigationConfirm();\n transition.abort();\n }\n }\n }\n});\n```\n\nYou can also redirect elsewhere by calling\n`this.transitionTo('elsewhere')` from within `willTransition`.\nNote that `willTransition` will not be fired for the\nredirecting `transitionTo`, since `willTransition` doesn't\nfire when there is already a transition underway. If you want\nsubsequent `willTransition` actions to fire for the redirecting\ntransition, you must first explicitly call\n`transition.abort()`.\n\nTo allow the `willTransition` event to continue bubbling to the parent\nroute, use `return true;`. When the `willTransition` method has a\nreturn value of `true` then the parent route's `willTransition` method\nwill be fired, enabling \"bubbling\" behavior for the event.", "itemtype": "event", "name": "willTransition", "params": [ { "name": "transition", "description": "", "type": "Transition" } ], "since": "1.0.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 605, "description": "The `didTransition` action is fired after a transition has\nsuccessfully been completed. This occurs after the normal model\nhooks (`beforeModel`, `model`, `afterModel`, `setupController`)\nhave resolved. The `didTransition` action has no arguments,\nhowever, it can be useful for tracking page views or resetting\nstate on the controller.\n\n```app/routes/login.js\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n actions: {\n didTransition() {\n this.controller.get('errors.base').clear();\n return true; // Bubble the didTransition event\n }\n }\n});\n```", "itemtype": "event", "name": "didTransition", "since": "1.2.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 631, "description": "The `loading` action is fired on the route when a route's `model`\nhook returns a promise that is not already resolved. The current\n`Transition` object is the first parameter and the route that\ntriggered the loading event is the second parameter.\n\n```app/routes/application.js\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n actions: {\n loading(transition, route) {\n let controller = this.controllerFor('foo');\n controller.set('currentlyLoading', true);\n\n transition.finally(function() {\n controller.set('currentlyLoading', false);\n });\n }\n }\n});\n```", "itemtype": "event", "name": "loading", "params": [ { "name": "transition", "description": "", "type": "Transition" }, { "name": "route", "description": "The route that triggered the loading event", "type": "Route" } ], "since": "1.2.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 661, "description": "When attempting to transition into a route, any of the hooks\nmay return a promise that rejects, at which point an `error`\naction will be fired on the partially-entered routes, allowing\nfor per-route error handling logic, or shared error handling\nlogic defined on a parent route.\n\nHere is an example of an error handler that will be invoked\nfor rejected promises from the various hooks on the route,\nas well as any unhandled errors from child routes:\n\n```app/routes/admin.js\nimport { reject } from 'rsvp';\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n beforeModel() {\n return reject('bad things!');\n },\n\n actions: {\n error(error, transition) {\n // Assuming we got here due to the error in `beforeModel`,\n // we can expect that error === \"bad things!\",\n // but a promise model rejecting would also\n // call this hook, as would any errors encountered\n // in `afterModel`.\n\n // The `error` hook is also provided the failed\n // `transition`, which can be stored and later\n // `.retry()`d if desired.\n\n this.transitionTo('login');\n }\n }\n});\n```\n\n`error` actions that bubble up all the way to `ApplicationRoute`\nwill fire a default error handler that logs the error. You can\nspecify your own global default error handler by overriding the\n`error` handler on `ApplicationRoute`:\n\n```app/routes/application.js\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n actions: {\n error(error, transition) {\n this.controllerFor('banner').displayError(error.message);\n }\n }\n});\n```", "itemtype": "event", "name": "error", "params": [ { "name": "error", "description": "", "type": "Error" }, { "name": "transition", "description": "", "type": "Transition" } ], "since": "1.0.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 722, "description": "This event is triggered when the router enters the route. It is\nnot executed when the model for the route changes.\n\n```app/routes/application.js\nimport { on } from '@ember/object/evented';\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n collectAnalytics: on('activate', function(){\n collectAnalytics();\n })\n});\n```", "itemtype": "event", "name": "activate", "since": "1.9.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 742, "description": "This event is triggered when the router completely exits this\nroute. It is not executed when the model for the route changes.\n\n```app/routes/index.js\nimport { on } from '@ember/object/evented';\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n trackPageLeaveAnalytics: on('deactivate', function(){\n trackPageLeaveAnalytics();\n })\n});\n```", "itemtype": "event", "name": "deactivate", "since": "1.9.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 762, "description": "The controller associated with this route.\n\nExample\n\n```app/routes/form.js\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n actions: {\n willTransition(transition) {\n if (this.controller.get('userHasEnteredData') &&\n !confirm('Are you sure you want to abandon progress?')) {\n transition.abort();\n } else {\n // Bubble the `willTransition` action so that\n // parent routes can decide whether or not to abort.\n return true;\n }\n }\n }\n});\n```", "itemtype": "property", "name": "controller", "type": "Controller", "since": "1.6.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 794, "description": "This action is called when one or more query params have changed. Bubbles.", "itemtype": "method", "name": "queryParamsDidChange", "params": [ { "name": "changed", "description": "Keys are names of query params that have changed.", "type": "Object" }, { "name": "totalPresent", "description": "Keys are names of query params that are currently set.", "type": "Object" }, { "name": "removed", "description": "Keys are names of query params that have been removed.", "type": "Object" } ], "return": { "description": "", "type": "Boolean" }, "access": "private", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 907, "description": "This hook is executed when the router completely exits this route. It is\nnot executed when the model for the route changes.", "itemtype": "method", "name": "deactivate", "since": "1.0.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 917, "description": "This hook is executed when the router enters the route. It is not executed\nwhen the model for the route changes.", "itemtype": "method", "name": "activate", "since": "1.0.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 927, "description": "Transition the application into another route. The route may\nbe either a single route or route path:\n\n```javascript\nthis.transitionTo('blogPosts');\nthis.transitionTo('blogPosts.recentEntries');\n```\n\nOptionally supply a model for the route in question. The model\nwill be serialized into the URL using the `serialize` hook of\nthe route:\n\n```javascript\nthis.transitionTo('blogPost', aPost);\n```\n\nIf a literal is passed (such as a number or a string), it will\nbe treated as an identifier instead. In this case, the `model`\nhook of the route will be triggered:\n\n```javascript\nthis.transitionTo('blogPost', 1);\n```\n\nMultiple models will be applied last to first recursively up the\nroute tree.\n\n```app/routes.js\n// ...\n\nRouter.map(function() {\n this.route('blogPost', { path:':blogPostId' }, function() {\n this.route('blogComment', { path: ':blogCommentId' });\n });\n});\n\nexport default Router;\n```\n\n```javascript\nthis.transitionTo('blogComment', aPost, aComment);\nthis.transitionTo('blogComment', 1, 13);\n```\n\nIt is also possible to pass a URL (a string that starts with a\n`/`). This is intended for testing and debugging purposes and\nshould rarely be used in production code.\n\n```javascript\nthis.transitionTo('/');\nthis.transitionTo('/blog/post/1/comment/13');\nthis.transitionTo('/blog/posts?sort=title');\n```\n\nAn options hash with a `queryParams` property may be provided as\nthe final argument to add query parameters to the destination URL.\n\n```javascript\nthis.transitionTo('blogPost', 1, {\n queryParams: { showComments: 'true' }\n});\n\n// if you just want to transition the query parameters without changing the route\nthis.transitionTo({ queryParams: { sort: 'date' } });\n```\n\nSee also [replaceWith](#method_replaceWith).\n\nSimple Transition Example\n\n```app/routes.js\n// ...\n\nRouter.map(function() {\n this.route('index');\n this.route('secret');\n this.route('fourOhFour', { path: '*:' });\n});\n\nexport default Router;\n```\n\n```app/routes/index.js\nimport Route from '@ember/routing/route';\n\nexport Route.extend({\n actions: {\n moveToSecret(context) {\n if (authorized()) {\n this.transitionTo('secret', context);\n } else {\n this.transitionTo('fourOhFour');\n }\n }\n }\n});\n```\n\nTransition to a nested route\n\n```app/router.js\n// ...\n\nRouter.map(function() {\n this.route('articles', { path: '/articles' }, function() {\n this.route('new');\n });\n});\n\nexport default Router;\n```\n\n```app/routes/index.js\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n actions: {\n transitionToNewArticle() {\n this.transitionTo('articles.new');\n }\n }\n});\n```\n\nMultiple Models Example\n\n```app/router.js\n// ...\n\nRouter.map(function() {\n this.route('index');\n\n this.route('breakfast', { path: ':breakfastId' }, function() {\n this.route('cereal', { path: ':cerealId' });\n });\n});\n\nexport default Router;\n```\n\n```app/routes/index.js\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n actions: {\n moveToChocolateCereal() {\n let cereal = { cerealId: 'ChocolateYumminess' };\n let breakfast = { breakfastId: 'CerealAndMilk' };\n\n this.transitionTo('breakfast.cereal', breakfast, cereal);\n }\n }\n});\n```\n\nNested Route with Query String Example\n\n```app/routes.js\n// ...\n\nRouter.map(function() {\n this.route('fruits', function() {\n this.route('apples');\n });\n});\n\nexport default Router;\n```\n\n```app/routes/index.js\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n actions: {\n transitionToApples() {\n this.transitionTo('fruits.apples', { queryParams: { color: 'red' } });\n }\n }\n});\n```", "itemtype": "method", "name": "transitionTo", "params": [ { "name": "name", "description": "the name of the route or a URL", "type": "String" }, { "name": "models", "description": "the model(s) or identifier(s) to be used while\n transitioning to the route.", "type": "...Object" }, { "name": "options", "description": "optional hash with a queryParams property\n containing a mapping of query parameters", "type": "Object", "optional": true } ], "return": { "description": "the transition object associated with this\n attempted transition", "type": "Transition" }, "since": "1.0.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 1124, "description": "Perform a synchronous transition into another route without attempting\nto resolve promises, update the URL, or abort any currently active\nasynchronous transitions (i.e. regular transitions caused by\n`transitionTo` or URL changes).\n\nThis method is handy for performing intermediate transitions on the\nway to a final destination route, and is called internally by the\ndefault implementations of the `error` and `loading` handlers.", "itemtype": "method", "name": "intermediateTransitionTo", "params": [ { "name": "name", "description": "the name of the route", "type": "String" }, { "name": "models", "description": "the model(s) to be used while transitioning\nto the route.", "type": "...Object" } ], "since": "1.2.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 1145, "description": "Refresh the model on this route and any child routes, firing the\n`beforeModel`, `model`, and `afterModel` hooks in a similar fashion\nto how routes are entered when transitioning in from other route.\nThe current route params (e.g. `article_id`) will be passed in\nto the respective model hooks, and if a different model is returned,\n`setupController` and associated route hooks will re-fire as well.\n\nAn example usage of this method is re-querying the server for the\nlatest information using the same parameters as when the route\nwas first entered.\n\nNote that this will cause `model` hooks to fire even on routes\nthat were provided a model object when the route was initially\nentered.", "itemtype": "method", "name": "refresh", "return": { "description": "the transition object associated with this\n attempted transition", "type": "Transition" }, "since": "1.4.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 1171, "description": "Transition into another route while replacing the current URL, if possible.\nThis will replace the current history entry instead of adding a new one.\nBeside that, it is identical to `transitionTo` in all other respects. See\n'transitionTo' for additional information regarding multiple models.\n\nExample\n\n```app/router.js\n// ...\n\nRouter.map(function() {\n this.route('index');\n this.route('secret');\n});\n\nexport default Router;\n```\n\n```app/routes/secret.js\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n afterModel() {\n if (!authorized()){\n this.replaceWith('index');\n }\n }\n});\n```", "itemtype": "method", "name": "replaceWith", "params": [ { "name": "name", "description": "the name of the route or a URL", "type": "String" }, { "name": "models", "description": "the model(s) or identifier(s) to be used while\n transitioning to the route.", "type": "...Object" }, { "name": "options", "description": "optional hash with a queryParams property\n containing a mapping of query parameters", "type": "Object", "optional": true } ], "return": { "description": "the transition object associated with this\n attempted transition", "type": "Transition" }, "since": "1.0.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 1217, "description": "Sends an action to the router, which will delegate it to the currently\nactive route hierarchy per the bubbling rules explained under `actions`.\n\nExample\n\n```app/router.js\n// ...\n\nRouter.map(function() {\n this.route('index');\n});\n\nexport default Router;\n```\n\n```app/routes/application.js\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n actions: {\n track(arg) {\n console.log(arg, 'was clicked');\n }\n }\n});\n```\n\n```app/routes/index.js\nimport Route from '@ember/routing/route';\n\nexport default Route.extend({\n actions: {\n trackIfDebug(arg) {\n if (debug) {\n this.send('track', arg);\n }\n }\n }\n});\n```", "itemtype": "method", "name": "send", "params": [ { "name": "name", "description": "the name of the action to trigger", "type": "String" }, { "name": "args", "description": "", "type": "...*" } ], "since": "1.0.0", "access": "public", "tagname": "", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 1277, "description": "This hook is the entry point for router.js", "access": "private", "tagname": "", "itemtype": "method", "name": "setup", "class": "Route", "module": "@ember/routing" }, { "file": "packages/ember-routing/lib/system/route.js", "line": 1351, "description": "This hook is the first of the route entry validation hooks\ncalled when an attempt is made to transition into a route\nor one of its children. It is called before `model` and\n`afterModel`, and is appropriate for cases when:\n\n1) A decision can be made to redirect elsewhere without\n needing to resolve the model first.\n2) Any async operations need to occur first before the\n model is attempted to be resolved.\n\nThis hook is provided the current `transition` attempt\nas a parameter, which can be used to `.abort()` the transition,\nsave it for a later `.retry()`, or retrieve values set\non it from a previous hook. You can also just call\n`this.transitionTo` to another route to implicitly\nabort the `transition`.\n\nYou can return a promise from this hook to pause the\ntransition until the promise resolves (or rejects). This could\nbe useful, for instance, for retrieving async code from\nthe server that is required to enter a route.", "itemtype": "method", "name": "beforeModel", "params": [ { "name": "transition", "description": "", "type": "Transition" } ], "return": { "description": "if the value returned from this hook is\n a promise, the transition will pause until the transition\n resolves. Otherwise, non-promise return values are not\n utilized in any way.", "type": "Any | Promise