Skip to content

Update Ember API docs from workflow for version 7.2.0-alpha.1 #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kategengler wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update Ember API docs from workflow for version 7.2.0-alpha.1 #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6d4db8
Add docs for Ember 7.2.0-alpha.1
github-actions[bot] May 20, 2026
9db82c8
fix urls and rev-index for ember
github-actions[bot] May 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
189 changes: 189 additions & 0 deletions json-docs/ember/7.2.0-alpha.1/classes/ember-7.2.0-alpha.1-@ember/array.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
{
"data": {
"id": "ember-7.2.0-alpha.1-@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": "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 `null` or `undefined`, it will return an empty array.\n\n```javascript\nimport { makeArray } from '@ember/array';\nimport ArrayProxy from '@ember/array/proxy';\n\nmakeArray(); // []\nmakeArray(null); // []\nmakeArray(undefined); // []\nmakeArray('lindsay'); // ['lindsay']\nmakeArray([1, 2, 42]); // [1, 2, 42]\n\nlet proxy = ArrayProxy.create({ content: [] });\n\nmakeArray(proxy) === proxy; // false\n```",
"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": "Returns true if the passed object is an array or Array-like.\n\nObjects are considered Array-like if any of the following are true:\n\n - the object is a native Array\n - the object has an objectAt property\n - the object is an Object, and has a length property\n\nUnlike `typeOf` this method returns true even if the passed object is\nnot formally an array but appears to be array-like (i.e. implements `Array`)\n\n```javascript\nimport { isArray } from '@ember/array';\nimport ArrayProxy from '@ember/array/proxy';\n\nisArray(); // false\nisArray([]); // true\nisArray(ArrayProxy.create({ content: [] })); // true\n```",
"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": 1870,
"description": "Creates an `NativeArray` from an Array-like object.\nDoes not modify the original object's contents.\n\nExample\n\n```js {data-filename=app/components/my-component.js}\nimport Component from '@ember/component';\nimport { A } from '@ember/array';\n\nexport default Component.extend({\n tagName: 'ul',\n classNames: ['pagination'],\n\n init() {\n this._super(...arguments);\n\n if (!this.get('content')) {\n this.set('content', A());\n this.set('otherContent', A([1,2,3]));\n }\n }\n});\n```",
"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": 1987,
"description": "Remove all occurrences of an object in the array.\n\n```javascript\nlet cities = ['Chicago', 'Berlin', 'Lima', 'Chicago'];\n\ncities.removeObject('Chicago'); // ['Berlin', 'Lima']\ncities.removeObject('Lima'); // ['Berlin']\ncities.removeObject('Tokyo') // ['Berlin']\n```",
"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": 2008,
"description": "Push the object onto the end of the array if it is not already\npresent in the array.\n\n```javascript\nlet cities = ['Chicago', 'Berlin'];\n\ncities.addObject('Lima'); // ['Chicago', 'Berlin', 'Lima']\ncities.addObject('Berlin'); // ['Chicago', 'Berlin', 'Lima']\n```",
"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": 2029,
"description": "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 `set(),` otherwise\nit will be set directly. `null` objects are skipped.\n\n```javascript\nlet people = [{name: 'Joe'}, {name: 'Matt'}];\n\npeople.setEach('zipCode', '10011');\n// [{name: 'Joe', zipCode: '10011'}, {name: 'Matt', zipCode: '10011'}];\n```",
"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": 2049,
"description": "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.\n\n```javascript\nlet peopleToMoon = ['Armstrong', 'Aldrin'];\n\npeopleToMoon.get('[]'); // ['Armstrong', 'Aldrin']\n\npeopleToMoon.set('[]', ['Collins']); // ['Collins']\npeopleToMoon.get('[]'); // ['Collins']\n```",
"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-7.2.0-alpha.1-ember",
"type": "module"
}
},
"project-version": {
"data": {
"id": "ember-7.2.0-alpha.1",
"type": "project-version"
}
}
}
}
}
164 changes: 164 additions & 0 deletions json-docs/ember/7.2.0-alpha.1/classes/ember-7.2.0-alpha.1-@ember/component.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
{
"data": {
"id": "ember-7.2.0-alpha.1-@ember/component",
"type": "class",
"attributes": {
"name": "@ember/component",
"shortname": "@ember/component",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "@ember/component",
"namespace": "",
"methods": [
{
"file": "packages/@ember/-internals/glimmer/lib/components/input.ts",
"line": 55,
"description": "An opaque interface which can be imported and used in strict-mode\ntemplates to call <Input>.\n\nSee [Ember.Templates.components.Input](/ember/release/classes/Ember.Templates.components/methods/Input?anchor=Input).",
"itemtype": "method",
"name": "Input",
"see": [
"{Ember.Templates.components.Input}"
],
"access": "public",
"tagname": "",
"class": "@ember/component",
"module": "@ember/component"
},
{
"file": "packages/@ember/-internals/glimmer/lib/components/textarea.ts",
"line": 132,
"description": "An opaque interface which can be imported and used in strict-mode\ntemplates to call <Textarea>.\n\nSee [Ember.Templates.components.Textarea](/ember/release/classes/Ember.Templates.components/methods/Textarea?anchor=Textarea).",
"itemtype": "method",
"name": "Textarea",
"see": [
"{Ember.Templates.components.Textarea}"
],
"access": "public",
"tagname": "",
"class": "@ember/component",
"module": "@ember/component"
},
{
"file": "packages/@ember/component/index.ts",
"line": 14,
"description": "Assigns a TemplateFactory to a component class.",
"itemtype": "method",
"name": "setComponentTemplate",
"static": 1,
"access": "public",
"tagname": "```js\nimport Component from '---AT-PLACEHOLDER---glimmer/component';\nimport { hbs } from 'ember-cli-htmlbars';\nimport { setComponentTemplate } from '---AT-PLACEHOLDER---ember/component';\n\nexport default class Demo extends Component {\n // ...\n}\n\nsetComponentTemplate(hbs`\n <div>my template</div>\n`, Demo);\n```",
"params": [
{
"name": "templateFactory",
"description": "",
"type": "TemplateFactory"
},
{
"name": "componentDefinition",
"description": "",
"type": "Object"
}
],
"class": "@ember/component",
"module": "@ember/component"
},
{
"file": "packages/@ember/component/index.ts",
"line": 40,
"description": "Returns the TemplateFactory associated with a component",
"itemtype": "method",
"name": "getComponentTemplate",
"static": 1,
"access": "public",
"tagname": "```js\nimport Component from '---AT-PLACEHOLDER---glimmer/component';\nimport { hbs } from 'ember-cli-htmlbars';\nimport { getComponentTemplate } from '---AT-PLACEHOLDER---ember/component';\n\nexport default class Demo extends Component {\n // ...\n}\n\nlet theTemplateFactory = getTemplateFactory(Demo)\n```",
"params": [
{
"name": "componentDefinition",
"description": "",
"type": "Object"
}
],
"return": {
"description": "",
"type": "TemplateFactory"
},
"class": "@ember/component",
"module": "@ember/component"
},
{
"file": "packages/@ember/component/index.ts",
"line": 64,
"description": "Tell the VM how manage a type of object / class when encountered\nvia component-invocation.\n\nA Component Manager, must implement this interface:\n- static create()\n- createComponent()\n- updateComponent()\n- destroyComponent()\n- getContext()",
"itemtype": "method",
"name": "setComponentManager",
"static": 1,
"access": "public",
"tagname": "After a component manager is registered via `setComponentManager`,\n\n```js\nimport { StateNode } from 'xstate';\nimport ComponentManager from './-private/statechart-manager';\n\nsetComponentManager((owner) => ComponentManager.create(owner), StateNode.prototype);\n```\n\nInstances of the class can be used as component.\nNo need to extend from `@glimmer/component`.\n\n```js\n// app/components/my-component.js\nimport { createMachine } from 'xstate';\n\nexport default createMachine({ ... });\n```\n```hbs\n{{!-- app/templates/application.hbs}}\n<MyComponent />\n```",
"params": [
{
"name": "managerFactory",
"description": "",
"type": "(owner: Owner) => import('@glimmer/interfaces').ComponentManager"
},
{
"name": "object",
"description": "that will be managed by the return value of `managerFactory`",
"type": "Object"
}
],
"class": "@ember/component",
"module": "@ember/component"
},
{
"file": "packages/@ember/component/index.ts",
"line": 109,
"description": "Tells Glimmer what capabilities a Component Manager will have\n\n```js\nimport { capabilities } from '@ember/component';\n\nexport class MyComponentManager {\n capabilities = capabilities('3.13', {\n // capabilities listed here\n })\n}\n```\n\n\nFor a full list of capabilities, their defaults, and how they are used, see [@glimmer/manager](https://github.com/glimmerjs/glimmer-vm/blob/4f1bef0d9a8a3c3ebd934c5b6e09de4c5f6e4468/packages/%40glimmer/manager/lib/public/component.ts#L26)",
"itemtype": "method",
"name": "capabilities",
"static": 1,
"access": "public",
"tagname": "",
"params": [
{
"name": "managerApiVersion",
"description": "",
"type": "'3.13'"
},
{
"name": "options",
"description": "",
"type": "Parameters<import('@ember/-internals/glimmer').componentCapabilities>[1]"
}
],
"class": "@ember/component",
"module": "@ember/component"
}
],
"events": [],
"properties": []
},
"relationships": {
"parent-class": {
"data": null
},
"descendants": {
"data": []
},
"module": {
"data": {
"id": "ember-7.2.0-alpha.1-@ember/component",
"type": "module"
}
},
"project-version": {
"data": {
"id": "ember-7.2.0-alpha.1",
"type": "project-version"
}
}
}
}
}
Loading
Loading