Skip to content

Commit

Permalink
add missing entries for Ember up to 4.12
Browse files Browse the repository at this point in the history
  • Loading branch information
@mansona
mansona committed Sep 29, 2023
1 parent 69d3e0e commit 52436a2
Show file tree
Hide file tree
Showing 823 changed files with 283,131 additions and 828 deletions.
138 changes: 138 additions & 0 deletions json-docs/ember/4.0.1/classes/ember-4.0.1-@ember/application-1881ae8645.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
{
"data": {
"id": "ember-4.0.1-@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/-internals/owner/index.ts",
"line": 41,
"description": "<html><head></head><body><p>Framework objects in an Ember application (components, services, routes, etc.)\nare created via a factory and dependency injection system. Each of these\nobjects is the responsibility of an &quot;owner&quot;, which handled its\ninstantiation and manages its lifetime.</p>\n<p><code>getOwner</code> fetches the owner object responsible for an instance. This can\nbe used to lookup or resolve other class instances, or register new factories\ninto the owner.</p>\n<p>For example, this component dynamically looks up a service based on the\n<code>audioType</code> passed as an argument:</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\">audio.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\n17\n18\n19\n20\n</pre></td>\n <td class=\"code\"><pre><span class=\"keyword\">import</span> <span class=\"type\">Component</span> from &apos;<span class=\"meta\">@glimmer</span>/component&apos;;\n<span class=\"keyword\">import</span> { action } from &apos;<span class=\"meta\">@ember</span>/<span class=\"class\"><span class=\"keyword\">object</span>&apos;</span>;\n<span class=\"keyword\">import</span> { getOwner } from &apos;<span class=\"meta\">@ember</span>/application&apos;;\n\n<span class=\"comment\">// Usage:</span>\n<span class=\"comment\">//</span>\n<span class=\"comment\">// &lt;PlayAudio @audioType={{@model.audioType}} @audioFile={{@model.file}}/&gt;</span>\n<span class=\"comment\">//</span>\n<span class=\"keyword\">export</span> <span class=\"keyword\">default</span> <span class=\"class\"><span class=\"keyword\">class</span> <span class=\"keyword\">extends</span> <span class=\"title\">Component</span> </span>{\n get audioService() {\n let owner = getOwner(<span class=\"keyword\">this</span>);\n <span class=\"keyword\">return</span> owner.lookup(`service:${<span class=\"keyword\">this</span>.args.audioType}`);\n }\n\n <span class=\"meta\">@action</span>\n onPlay() {\n let player = <span class=\"keyword\">this</span>.audioService;\n player.play(<span class=\"keyword\">this</span>.args.audioFile);\n }\n}</pre></td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>\n \n</body></html>",
"itemtype": "method",
"name": "getOwner",
"static": 1,
"params": [
{
"name": "object",
"description": "An object with an owner.",
"type": "Object"
}
],
"return": {
"description": "An owner object.",
"type": "Object"
},
"since": "2.3.0",
"access": "public",
"tagname": "",
"class": "@ember/application",
"module": "@ember/application"
},
{
"file": "packages/@ember/-internals/owner/index.ts",
"line": 89,
"description": "<html><head></head><body><p><code>setOwner</code> forces a new owner on a given object instance. This is primarily\nuseful in some testing cases.</p>\n</body></html>",
"itemtype": "method",
"name": "setOwner",
"static": 1,
"params": [
{
"name": "object",
"description": "An object instance.",
"type": "Object"
},
{
"name": "object",
"description": "The new owner object of the object instance.",
"type": "Object"
}
],
"since": "2.3.0",
"access": "public",
"tagname": "",
"class": "@ember/application",
"module": "@ember/application"
},
{
"file": "packages/@ember/application/lib/lazy_load.js",
"line": 14,
"description": "<html><head></head><body><p>Detects when a specific package of Ember (e.g. &apos;Application&apos;)\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\">&apos;@ember/application&apos;</span>;\n\n<span class=\"title function_\">onLoad</span>(<span class=\"string\">&apos;Ember.Application&apos;</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.js",
"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-4.0.1-@ember/application",
"type": "module"
}
},
"project-version": {
"data": {
"id": "ember-4.0.1",
"type": "project-version"
}
}
}
}
}
61 changes: 61 additions & 0 deletions json-docs/ember/4.0.1/classes/ember-4.0.1-@ember/component/helper-362e20c502.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
{
"data": {
"id": "ember-4.0.1-@ember/component/helper",
"type": "class",
"attributes": {
"name": "@ember/component/helper",
"shortname": "@ember/component/helper",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "@ember/component",
"namespace": "",
"methods": [
{
"file": "packages/@ember/-internals/glimmer/lib/helper.ts",
"line": 231,
"description": "<html><head></head><body><p>In many cases it is not necessary to use the full <code>Helper</code> class.\nThe <code>helper</code> method create pure-function helpers without instances.\nFor 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\">currency.js</td>\n </tr>\n </thead>\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> { helper } <span class=\"keyword\">from</span> <span class=\"string\">&apos;@ember/component/helper&apos;</span>;\n\n<span class=\"keyword\">export</span> <span class=\"keyword\">default</span> <span class=\"title function_\">helper</span>(<span class=\"keyword\">function</span>(<span class=\"params\">[cents], {currency}</span>) {\n <span class=\"keyword\">return</span> <span class=\"string\">`<span class=\"subst\">${currency}</span><span class=\"subst\">${cents * <span class=\"number\">0.01</span>}</span>`</span>;\n});</pre></td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>\n \n</body></html>",
"static": 1,
"params": [
{
"name": "helper",
"description": "The helper function",
"type": "Function"
}
],
"itemtype": "method",
"name": "helper",
"access": "public",
"tagname": "",
"since": "1.13.0",
"class": "@ember/component/helper",
"module": "@ember/component"
}
],
"events": [],
"properties": []
},
"relationships": {
"parent-class": {
"data": null
},
"descendants": {
"data": []
},
"module": {
"data": {
"id": "ember-4.0.1-@ember/component",
"type": "module"
}
},
"project-version": {
"data": {
"id": "ember-4.0.1",
"type": "project-version"
}
}
}
}
}
65 changes: 65 additions & 0 deletions json-docs/ember/4.0.1/classes/ember-4.0.1-@ember/controller-cb2b88c0cc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"data": {
"id": "ember-4.0.1-@ember/controller",
"type": "class",
"attributes": {
"name": "@ember/controller",
"shortname": "@ember/controller",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "@ember/controller",
"namespace": "",
"methods": [
{
"file": "packages/@ember/controller/index.js",
"line": 17,
"description": "<html><head></head><body><p>Creates a property that lazily looks up another controller in the container.\nCan only be used when defining another controller.</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\">app/controllers/post.js</td>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td class=\"line-numbers\"><pre>1\n2\n3\n4\n5\n6\n7\n</pre></td>\n <td class=\"code\"><pre><span class=\"keyword\">import</span> <span class=\"type\">Controller</span>, {\n inject as controller\n} from &apos;<span class=\"meta\">@ember</span>/controller&apos;;\n\n<span class=\"keyword\">export</span> <span class=\"keyword\">default</span> <span class=\"class\"><span class=\"keyword\">class</span> <span class=\"title\">PostController</span> <span class=\"keyword\">extends</span> <span class=\"title\">Controller</span> </span>{\n <span class=\"meta\">@controller</span> posts;\n}</pre></td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>\n \n<p>Classic Class 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\">app/controllers/post.js</td>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td class=\"line-numbers\"><pre>1\n2\n3\n4\n5\n6\n7\n</pre></td>\n <td class=\"code\"><pre><span class=\"keyword\">import</span> Controller, {\n inject <span class=\"keyword\">as</span> controller\n} <span class=\"keyword\">from</span> <span class=\"string\">&apos;@ember/controller&apos;</span>;\n\n<span class=\"keyword\">export</span> <span class=\"keyword\">default</span> Controller.extend({\n posts: controller()\n});</pre></td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>\n \n<p>This example will create a <code>posts</code> property on the <code>post</code> controller that\nlooks up the <code>posts</code> controller in the container, making it easy to reference\nother controllers.</p>\n</body></html>",
"itemtype": "method",
"name": "inject",
"static": 1,
"since": "1.10.0",
"params": [
{
"name": "name",
"description": "(optional) name of the controller to inject, defaults to\n the property's name",
"type": "String"
}
],
"return": {
"description": "injection decorator instance",
"type": "ComputedDecorator"
},
"access": "public",
"tagname": "",
"class": "@ember/controller",
"module": "@ember/controller"
}
],
"events": [],
"properties": []
},
"relationships": {
"parent-class": {
"data": null
},
"descendants": {
"data": []
},
"module": {
"data": {
"id": "ember-4.0.1-@ember/controller",
"type": "module"
}
},
"project-version": {
"data": {
"id": "ember-4.0.1",
"type": "project-version"
}
}
}
}
}
Loading

0 comments on commit 52436a2

Please sign in to comment.