Skip to content

Commit

Permalink
add docs for ember v5.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@jaredgalanis
jaredgalanis committed Dec 18, 2023
1 parent 94f307f commit 140b697
Show file tree
Hide file tree
Showing 162 changed files with 64,326 additions and 0 deletions.
89 changes: 89 additions & 0 deletions json-docs/ember/5.5.0/classes/ember-5.5.0-%40ember%2Fapplication.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
{
"data": {
"id": "ember-5.5.0-@ember/application",
"type": "class",
"attributes": {
"name": "@ember/application",
"shortname": "@ember/application",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "@ember/application",
"namespace": "",
"methods": [
{
"file": "packages/@ember/application/lib/lazy_load.ts",
"line": 14,
"description": "<html><head></head><body><p>Detects when a specific package of Ember (e.g. 'Application')\nhas fully loaded and is available for extension.</p>\n<p>The provided <code>callback</code> will be called with the <code>name</code> passed\nresolved from a string into the object:</p>\n<div class=\"highlight javascript\">\n <div class=\"ribbon\"></div>\n <div class=\"scroller\">\n <table class=\"CodeRay\">\n <tbody>\n <tr>\n <td class=\"line-numbers\"><pre>1\n2\n3\n4\n5\n</pre></td>\n <td class=\"code\"><pre><span class=\"keyword\">import</span> { onLoad } <span class=\"keyword\">from</span> <span class=\"string\">'@ember/application'</span>;\n\n<span class=\"title function_\">onLoad</span>(<span class=\"string\">'Ember.Application'</span> <span class=\"keyword\">function</span>(<span class=\"params\">hbars</span>) {\n hbars.<span class=\"title function_\">registerHelper</span>(...);\n});</pre></td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>\n \n</body></html>",
"itemtype": "method",
"name": "onLoad",
"static": 1,
"params": [
{
"name": "name",
"description": "name of hook",
"type": "String"
},
{
"name": "callback",
"description": "callback to be called",
"type": "Function"
}
],
"access": "private",
"tagname": "",
"class": "@ember/application",
"module": "@ember/application"
},
{
"file": "packages/@ember/application/lib/lazy_load.ts",
"line": 47,
"description": "<html><head></head><body><p>Called when an Ember.js package (e.g Application) has finished\nloading. Triggers any callbacks registered for this event.</p>\n</body></html>",
"itemtype": "method",
"name": "runLoadHooks",
"static": 1,
"params": [
{
"name": "name",
"description": "name of hook",
"type": "String"
},
{
"name": "object",
"description": "object to pass to callbacks",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "@ember/application",
"module": "@ember/application"
}
],
"events": [],
"properties": []
},
"relationships": {
"parent-class": {
"data": null
},
"descendants": {
"data": []
},
"module": {
"data": {
"id": "ember-5.5.0-@ember/application",
"type": "module"
}
},
"project-version": {
"data": {
"id": "ember-5.5.0",
"type": "project-version"
}
}
}
}
}
189 changes: 189 additions & 0 deletions json-docs/ember/5.5.0/classes/ember-5.5.0-%40ember%2Farray.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
{
"data": {
"id": "ember-5.5.0-@ember/array",
"type": "class",
"attributes": {
"name": "@ember/array",
"shortname": "@ember/array",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember",
"namespace": "",
"methods": [
{
"file": "packages/@ember/array/lib/make-array.ts",
"line": 5,
"description": "<html><head></head><body><p>Forces the passed object to be part of an array. If the object is already\nan array, it will return the object. Otherwise, it will add the object to\nan array. If object is <code>null</code> or <code>undefined</code>, it will return an empty array.</p>\n<div class=\"highlight javascript\">\n <div class=\"ribbon\"></div>\n <div class=\"scroller\">\n <table class=\"CodeRay\">\n <tbody>\n <tr>\n <td class=\"line-numbers\"><pre>1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n</pre></td>\n <td class=\"code\"><pre><span class=\"keyword\">import</span> { makeArray } <span class=\"keyword\">from</span> <span class=\"string\">'@ember/array'</span>;\n<span class=\"keyword\">import</span> <span class=\"title class_\">ArrayProxy</span> <span class=\"keyword\">from</span> <span class=\"string\">'@ember/array/proxy'</span>;\n\n<span class=\"title function_\">makeArray</span>(); <span class=\"comment\">// []</span>\n<span class=\"title function_\">makeArray</span>(<span class=\"literal\">null</span>); <span class=\"comment\">// []</span>\n<span class=\"title function_\">makeArray</span>(<span class=\"literal\">undefined</span>); <span class=\"comment\">// []</span>\n<span class=\"title function_\">makeArray</span>(<span class=\"string\">'lindsay'</span>); <span class=\"comment\">// ['lindsay']</span>\n<span class=\"title function_\">makeArray</span>([<span class=\"number\">1</span>, <span class=\"number\">2</span>, <span class=\"number\">42</span>]); <span class=\"comment\">// [1, 2, 42]</span>\n\n<span class=\"keyword\">let</span> proxy = <span class=\"title class_\">ArrayProxy</span>.<span class=\"title function_\">create</span>({ <span class=\"attr\">content</span>: [] });\n\n<span class=\"title function_\">makeArray</span>(proxy) === proxy; <span class=\"comment\">// false</span></pre></td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>\n \n</body></html>",
"itemtype": "method",
"name": "makeArray",
"static": 1,
"params": [
{
"name": "obj",
"description": "the object",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Array"
},
"access": "private",
"tagname": "",
"class": "@ember/array",
"module": "@ember/array"
},
{
"file": "packages/@ember/array/index.ts",
"line": 140,
"description": "<html><head></head><body><p>Returns true if the passed object is an array or Array-like.</p>\n<p>Objects are considered Array-like if any of the following are true:</p>\n<ul>\n<li>the object is a native Array</li>\n<li>the object has an objectAt property</li>\n<li>the object is an Object, and has a length property</li>\n</ul>\n<p>Unlike <code>typeOf</code> this method returns true even if the passed object is\nnot formally an array but appears to be array-like (i.e. implements <code>Array</code>)</p>\n<div class=\"highlight javascript\">\n <div class=\"ribbon\"></div>\n <div class=\"scroller\">\n <table class=\"CodeRay\">\n <tbody>\n <tr>\n <td class=\"line-numbers\"><pre>1\n2\n3\n4\n5\n6\n</pre></td>\n <td class=\"code\"><pre><span class=\"keyword\">import</span> { isArray } <span class=\"keyword\">from</span> <span class=\"string\">'@ember/array'</span>;\n<span class=\"keyword\">import</span> ArrayProxy <span class=\"keyword\">from</span> <span class=\"string\">'@ember/array/proxy'</span>;\n\nisArray(); // <span class=\"keyword\">false</span>\nisArray([]); // <span class=\"keyword\">true</span>\nisArray(ArrayProxy.<span class=\"keyword\">create</span>({ content: [] })); // <span class=\"keyword\">true</span></pre></td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>\n \n</body></html>",
"itemtype": "method",
"name": "isArray",
"static": 1,
"params": [
{
"name": "obj",
"description": "The object to test",
"type": "Object"
}
],
"return": {
"description": "true if the passed object is an array or Array-like",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"class": "@ember/array",
"module": "@ember/array"
},
{
"file": "packages/@ember/array/index.ts",
"line": 1859,
"description": "<html><head></head><body><p>Creates an <code>Ember.NativeArray</code> from an Array-like object.\nDoes not modify the original object's contents. <code>A()</code> is not needed if\n<code>EmberENV.EXTEND_PROTOTYPES</code> is <code>true</code> (the default value). However,\nit is recommended that you use <code>A()</code> when creating addons for\nember or when you can not guarantee that <code>EmberENV.EXTEND_PROTOTYPES</code>\nwill be <code>true</code>.</p>\n<p>Example</p>\n<div class=\"highlight javascript\">\n <div class=\"ribbon\"></div>\n <div class=\"scroller\">\n <table class=\"CodeRay\">\n <thead>\n <tr>\n <td colspan=\"2\">component.js</td>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td class=\"line-numbers\"><pre>1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n</pre></td>\n <td class=\"code\"><pre><span class=\"keyword\">import</span> Component from <span class=\"string\">'@ember/component'</span>;\n<span class=\"keyword\">import</span> { A } from <span class=\"string\">'@ember/array'</span>;\n\nexport default Component.extend({\n tagName: <span class=\"string\">'ul'</span>,\n classNames: [<span class=\"string\">'pagination'</span>],\n\n <span class=\"keyword\">init</span>() {\n <span class=\"keyword\">this</span>._super(...arguments);\n\n <span class=\"keyword\">if</span> (!<span class=\"keyword\">this</span>.<span class=\"keyword\">get</span>(<span class=\"string\">'content'</span>)) {\n <span class=\"keyword\">this</span>.<span class=\"keyword\">set</span>(<span class=\"string\">'content'</span>, A());\n <span class=\"keyword\">this</span>.<span class=\"keyword\">set</span>(<span class=\"string\">'otherContent'</span>, A([<span class=\"number\">1</span>,<span class=\"number\">2</span>,<span class=\"number\">3</span>]));\n }\n }\n});</pre></td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>\n \n</body></html>",
"itemtype": "method",
"name": "A",
"static": 1,
"return": {
"description": "",
"type": "Ember.NativeArray"
},
"access": "public",
"tagname": "",
"class": "@ember/array",
"module": "@ember/array"
},
{
"file": "packages/@ember/array/index.ts",
"line": 1978,
"description": "<html><head></head><body><p>Remove all occurrences of an object in the array.</p>\n<div class=\"highlight javascript\">\n <div class=\"ribbon\"></div>\n <div class=\"scroller\">\n <table class=\"CodeRay\">\n <tbody>\n <tr>\n <td class=\"line-numbers\"><pre>1\n2\n3\n4\n5\n</pre></td>\n <td class=\"code\"><pre>let cities = [<span class=\"string\">'Chicago'</span>, <span class=\"string\">'Berlin'</span>, <span class=\"string\">'Lima'</span>, <span class=\"string\">'Chicago'</span>];\n\ncities.removeObject(<span class=\"string\">'Chicago'</span>); // [<span class=\"string\">'Berlin'</span>, <span class=\"string\">'Lima'</span>]\ncities.removeObject(<span class=\"string\">'Lima'</span>); // [<span class=\"string\">'Berlin'</span>]\ncities.removeObject(<span class=\"string\">'Tokyo'</span>) // [<span class=\"string\">'Berlin'</span>]</pre></td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>\n \n</body></html>",
"itemtype": "method",
"name": "removeObject",
"params": [
{
"name": "obj",
"description": "object to remove",
"type": "*"
}
],
"return": {
"description": "receiver",
"type": "EmberArray"
},
"access": "public",
"tagname": "",
"class": "@ember/array",
"module": "ember"
},
{
"file": "packages/@ember/array/index.ts",
"line": 1999,
"description": "<html><head></head><body><p>Push the object onto the end of the array if it is not already\npresent in the array.</p>\n<div class=\"highlight javascript\">\n <div class=\"ribbon\"></div>\n <div class=\"scroller\">\n <table class=\"CodeRay\">\n <tbody>\n <tr>\n <td class=\"line-numbers\"><pre>1\n2\n3\n4\n</pre></td>\n <td class=\"code\"><pre>let cities = [<span class=\"string\">'Chicago'</span>, <span class=\"string\">'Berlin'</span>];\n\ncities.addObject(<span class=\"string\">'Lima'</span>); // [<span class=\"string\">'Chicago'</span>, <span class=\"string\">'Berlin'</span>, <span class=\"string\">'Lima'</span>]\ncities.addObject(<span class=\"string\">'Berlin'</span>); // [<span class=\"string\">'Chicago'</span>, <span class=\"string\">'Berlin'</span>, <span class=\"string\">'Lima'</span>]</pre></td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>\n \n</body></html>",
"itemtype": "method",
"name": "addObject",
"params": [
{
"name": "obj",
"description": "object to add, if not already present",
"type": "*"
}
],
"return": {
"description": "receiver",
"type": "EmberArray"
},
"access": "public",
"tagname": "",
"class": "@ember/array",
"module": "ember"
},
{
"file": "packages/@ember/array/index.ts",
"line": 2020,
"description": "<html><head></head><body><p>Sets the value on the named property for each member. This is more\nergonomic than using other methods defined on this helper. If the object\nimplements Observable, the value will be changed to <code>set(),</code> otherwise\nit will be set directly. <code>null</code> objects are skipped.</p>\n<div class=\"highlight javascript\">\n <div class=\"ribbon\"></div>\n <div class=\"scroller\">\n <table class=\"CodeRay\">\n <tbody>\n <tr>\n <td class=\"line-numbers\"><pre>1\n2\n3\n4\n</pre></td>\n <td class=\"code\"><pre><span class=\"keyword\">let</span> people = [<span class=\"built_in\">{name</span>: <span class=\"string\">'Joe'</span>}, <span class=\"built_in\">{name</span>: <span class=\"string\">'Matt'</span>}];\n\npeople.setEach(<span class=\"string\">'zipCode'</span>, <span class=\"string\">'10011'</span>);\n// [<span class=\"built_in\">{name</span>: <span class=\"string\">'Joe'</span>, zipCode: <span class=\"string\">'10011'</span>}, <span class=\"built_in\">{name</span>: <span class=\"string\">'Matt'</span>, zipCode: <span class=\"string\">'10011'</span>}];</pre></td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>\n \n</body></html>",
"itemtype": "method",
"name": "setEach",
"params": [
{
"name": "key",
"description": "The key to set",
"type": "String"
},
{
"name": "value",
"description": "The object to set",
"type": "Object"
}
],
"return": {
"description": "receiver",
"type": "Object"
},
"access": "public",
"tagname": "",
"class": "@ember/array",
"module": "ember"
}
],
"events": [],
"properties": [
{
"file": "packages/@ember/array/index.ts",
"line": 2040,
"description": "<html><head></head><body><p>This is the handler for the special array content property. If you get\nthis property, it will return this. If you set this property to a new\narray, it will replace the current content.</p>\n<div class=\"highlight javascript\">\n <div class=\"ribbon\"></div>\n <div class=\"scroller\">\n <table class=\"CodeRay\">\n <tbody>\n <tr>\n <td class=\"line-numbers\"><pre>1\n2\n3\n4\n5\n6\n</pre></td>\n <td class=\"code\"><pre>let peopleToMoon = [<span class=\"string\">'Armstrong'</span>, <span class=\"string\">'Aldrin'</span>];\n\npeopleToMoon.get(<span class=\"string\">'[]'</span>); // [<span class=\"string\">'Armstrong'</span>, <span class=\"string\">'Aldrin'</span>]\n\npeopleToMoon.set(<span class=\"string\">'[]'</span>, [<span class=\"string\">'Collins'</span>]); // [<span class=\"string\">'Collins'</span>]\npeopleToMoon.get(<span class=\"string\">'[]'</span>); // [<span class=\"string\">'Collins'</span>]</pre></td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>\n \n</body></html>",
"itemtype": "property",
"name": "[]",
"return": {
"description": "this"
},
"access": "public",
"tagname": "",
"class": "@ember/array",
"module": "ember"
}
]
},
"relationships": {
"parent-class": {
"data": null
},
"descendants": {
"data": []
},
"module": {
"data": {
"id": "ember-5.5.0-ember",
"type": "module"
}
},
"project-version": {
"data": {
"id": "ember-5.5.0",
"type": "project-version"
}
}
}
}
}
Loading

0 comments on commit 140b697

Please sign in to comment.