Function
4 |5 |
Ember CLI API Documentation
8 |9 |
Ember CLI API documentation is available on ember-cli.com/api.
10 |5 |
2 |
--------------------------------------------------------------------------------
/app/helpers/function-heading-id.js:
--------------------------------------------------------------------------------
1 | import { helper } from '@ember/component/helper';
2 | import { A } from '@ember/array';
3 |
4 | export function functionHeadingId([heading] /*, hash*/) {
5 | return `functions-${A(heading.split('/')).get('lastObject')}`;
6 | }
7 |
8 | export default helper(functionHeadingId);
9 |
--------------------------------------------------------------------------------
/fastboot/initializers/ajax.js:
--------------------------------------------------------------------------------
1 | export default {
2 | name: 'ajax-service',
3 | initialize() {
4 | // noop
5 | // This is to override Fastboot's initializer which prevents ember-fetch from working
6 | // https://github.com/ember-fastboot/ember-cli-fastboot/blob/master/fastboot/initializers/ajax.js
7 | },
8 | };
9 |
--------------------------------------------------------------------------------
/jsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "@tsconfig/ember",
3 | "compilerOptions": {
4 | "baseUrl": ".",
5 | "paths": {
6 | "ember-api-docs/*": [
7 | "app/*"
8 | ]
9 | }
10 | },
11 | "glint": {
12 | "environment": "ember-loose",
13 | "checkStandaloneTemplates": false
14 | }
15 | }
16 |
--------------------------------------------------------------------------------
/app/registry.d.ts:
--------------------------------------------------------------------------------
1 | import ApiIndex from './components/api-index';
2 | import ApiIndexFilter from './components/api-index-filter';
3 |
4 | declare module '@glint/environment-ember-loose/registry' {
5 | export default interface Registry {
6 | ApiIndex: typeof ApiIndex;
7 | ApiIndexFilter: typeof ApiIndexFilter;
8 | }
9 | }
10 |
--------------------------------------------------------------------------------
/app/helpers/better-get.js:
--------------------------------------------------------------------------------
1 | import { helper } from '@ember/component/helper';
2 |
3 | /**
4 | * gives a similar functionality to the get helper, but it supports dot separated
5 | * object keys.
6 | */
7 | export function betterGet(params /*, hash*/) {
8 | return params[0][params[1]];
9 | }
10 |
11 | export default helper(betterGet);
12 |
--------------------------------------------------------------------------------
/tests/helpers/search-selectors.js:
--------------------------------------------------------------------------------
1 | export default {
2 | input: '[data-test-search-input]',
3 | dropdown: '[data-test-search-dropdown]',
4 | searchResult: '[data-test-search-result]',
5 | screenReaderContent: '[data-test-screen-reader]',
6 | noResults: '[data-test-search-no-results]',
7 | searchLabel: '[data-test-search-label]',
8 | };
9 |
--------------------------------------------------------------------------------
/app/initializers/set-global-promise.js:
--------------------------------------------------------------------------------
1 | import RSVP from 'rsvp';
2 |
3 | export function initialize() {
4 | // async/await is using window.Promise by default and we want async/await to
5 | // use RSVP instead which is properly integrated with Ember's runloop
6 | window.Promise = RSVP.Promise;
7 | }
8 |
9 | export default { initialize };
10 |
--------------------------------------------------------------------------------
/app/helpers/is-latest.js:
--------------------------------------------------------------------------------
1 | import { helper } from '@ember/component/helper';
2 | import getLastVersion from 'ember-api-docs/utils/get-last-version';
3 |
4 | export function isLatest(params, { version, allVersions }) {
5 | let latestVersion = getLastVersion(allVersions);
6 | return version === latestVersion;
7 | }
8 |
9 | export default helper(isLatest);
10 |
--------------------------------------------------------------------------------
/app/templates/not-found.hbs:
--------------------------------------------------------------------------------
1 | {{page-title "Page Not Found"}}
2 |
3 |
3 |
4 |
5 |
6 |
7 |
8 | {{yield}}
9 | 
5 |
6 | Click here to go home
8 |
9 | Ack! 404 friend, you're in the wrong place
7 |-
2 |
-
3 |
Home 4 |
5 | - Projects 6 |
Ember
8 | EmberData
9 | Ember CLI
10 |
-
7 |
Ack! 404 friend, you're in the wrong place
4 | {{#if this.model.attemptedVersion}} 5 |6 | {{this.model.message}} 7 |
8 |
9 | Modules, classes, and functions sometimes move around or are renamed across versions.
10 | Try the
14 | This page wasn't found. Please try the
20 | Whoops! Something went wrong. 21 |
22 | {{/if}} 23 | 1\n2\n3\n4 | import Ember from 'ember';\nexport default Ember.Component.extend({\n // this is the old way\n}); |
1\n2\n3\n4 | import Component from '@ember/component';\nexport default Component.extend({\n // this is the current way\n}); |
22 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 | {{content-for "body-footer"}} {{content-for "test-body-footer"}}
34 |
35 |
36 |
--------------------------------------------------------------------------------
/public/assets/images/twitter-logo.svg:
--------------------------------------------------------------------------------
1 |
2 |
32 |
--------------------------------------------------------------------------------
/app/templates/project-version.hbs:
--------------------------------------------------------------------------------
1 | {{page-title @model.version}}
2 |
3 |
40 |
--------------------------------------------------------------------------------
/public/assets/images/google-plus-logo.svg:
--------------------------------------------------------------------------------
1 |
2 |
32 |
--------------------------------------------------------------------------------
/tests/helpers/index.js:
--------------------------------------------------------------------------------
1 | import {
2 | setupApplicationTest as upstreamSetupApplicationTest,
3 | setupRenderingTest as upstreamSetupRenderingTest,
4 | setupTest as upstreamSetupTest,
5 | } from 'ember-qunit';
6 |
7 | // This file exists to provide wrappers around ember-qunit's / ember-mocha's
8 | // test setup functions. This way, you can easily extend the setup that is
9 | // needed per test type.
10 |
11 | function setupApplicationTest(hooks, options) {
12 | upstreamSetupApplicationTest(hooks, options);
13 |
14 | // Additional setup for application tests can be done here.
15 | //
16 | // For example, if you need an authenticated session for each
17 | // application test, you could do:
18 | //
19 | // hooks.beforeEach(async function () {
20 | // await authenticateSession(); // ember-simple-auth
21 | // });
22 | //
23 | // This is also a good place to call test setup functions coming
24 | // from other addons:
25 | //
26 | // setupIntl(hooks); // ember-intl
27 | // setupMirage(hooks); // ember-cli-mirage
28 | }
29 |
30 | function setupRenderingTest(hooks, options) {
31 | upstreamSetupRenderingTest(hooks, options);
32 |
33 | // Additional setup for rendering tests can be done here.
34 | }
35 |
36 | function setupTest(hooks, options) {
37 | upstreamSetupTest(hooks, options);
38 |
39 | // Additional setup for unit tests can be done here.
40 | }
41 |
42 | export { setupApplicationTest, setupRenderingTest, setupTest };
43 |
--------------------------------------------------------------------------------
/app/routes/class.js:
--------------------------------------------------------------------------------
1 | import { inject as service } from '@ember/service';
2 | import Route from '@ember/routing/route';
3 |
4 | export default class ClassRoute extends Route {
5 | /** @type {import('@ember/routing/router-service').default} */
6 | @service
7 | router;
8 |
9 | @service
10 | legacyModuleMappings;
11 |
12 | model(params) {
13 | let ret = {
14 | mappings: this.legacyModuleMappings.buildMappings(
15 | this.legacyModuleMappings.legacyMappings,
16 | ),
17 | className: params['class'].substr(0, params['class'].lastIndexOf('.')),
18 | };
19 | return ret;
20 | }
21 |
22 | redirect(model) {
23 | let mappedInfo = this.legacyModuleMappings.getNewClassFromOld(
24 | model.className,
25 | model.mappings,
26 | );
27 | if (!mappedInfo.error && model.className !== mappedInfo.newName) {
28 | let { itemType, newName, newModule } = mappedInfo;
29 | if (itemType === 'class') {
30 | return this.router.transitionTo(
31 | `project-version.classes.class`,
32 | 'ember',
33 | 'release',
34 | newName,
35 | );
36 | } else {
37 | return this.router.transitionTo(
38 | `project-version.functions.function`,
39 | 'ember',
40 | 'release',
41 | newModule,
42 | newName,
43 | );
44 | }
45 | }
46 | return this.router.transitionTo('project-version', 'ember', 'release');
47 | }
48 | }
49 |
--------------------------------------------------------------------------------
/config/manifest.js:
--------------------------------------------------------------------------------
1 | /* eslint-env node */
2 | 'use strict';
3 |
4 | module.exports = function (environment, appConfig) {
5 | // See https://github.com/san650/ember-web-app#documentation for a list of
6 | // supported properties
7 | return {
8 | name: 'Ember API Docs',
9 | short_name: 'Ember API',
10 | description: 'Ember & Ember Data API Documentation',
11 | start_url: appConfig.routerRootURL,
12 | display: 'standalone',
13 | background_color: '#FDFDFD',
14 | theme_color: '#f67862',
15 | scope: appConfig.routerRootURL,
16 | lang: 'en-US',
17 | icons: [
18 | {
19 | src: '/assets/images/launch-icon-4x.png',
20 | sizes: '192x192',
21 | type: 'image/png',
22 | },
23 | {
24 | src: '/assets/images/launch-icon-3x.png',
25 | sizes: '144x122',
26 | type: 'image/png',
27 | },
28 | {
29 | src: '/assets/images/launch-icon-2x.png',
30 | sizes: '96x96',
31 | type: 'image/png',
32 | },
33 | {
34 | src: '/assets/images/launch-icon-1-5x.png',
35 | sizes: '72x72',
36 | type: 'image/png',
37 | },
38 | {
39 | src: '/assets/images/launch-icon-1x.png',
40 | sizes: '48x48',
41 | type: 'image/png',
42 | },
43 | {
44 | src: '/assets/images/launch-icon-0-75x.png',
45 | sizes: '36x36',
46 | type: 'image/png',
47 | },
48 | ],
49 | apple: {
50 | statusBarStyle: 'black-translucent',
51 | },
52 | };
53 | };
54 |
--------------------------------------------------------------------------------
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
1 | name: CI
2 |
3 | on:
4 | push:
5 | branches:
6 | - master
7 | - main
8 | pull_request:
9 |
10 | env:
11 | NODE_VERSION: 20
12 | PERCY_PARALLEL_NONCE: ${{ github.run_id }}-${{ github.run_number }}
13 | PERCY_PARALLEL_TOTAL: 1
14 |
15 | concurrency:
16 | group: ci-${{ github.head_ref || github.ref }}
17 | cancel-in-progress: true
18 |
19 | jobs:
20 | lint:
21 | name: "Lint"
22 | runs-on: ubuntu-latest
23 | timeout-minutes: 10
24 |
25 | steps:
26 | - uses: actions/checkout@v4
27 | - uses: pnpm/action-setup@v4
28 | - uses: actions/setup-node@v4
29 | with:
30 | cache: pnpm
31 | node-version: ${{ env.NODE_VERSION }}
32 | - name: Install Dependencies
33 | run: pnpm install
34 | - name: Lint
35 | run: pnpm run lint
36 |
37 | test:
38 | name: "Test"
39 | runs-on: ubuntu-latest
40 | timeout-minutes: 10
41 |
42 | steps:
43 | - uses: actions/checkout@v4
44 | - uses: pnpm/action-setup@v4
45 | - uses: actions/setup-node@v4
46 | with:
47 | cache: pnpm
48 | node-version: ${{ env.NODE_VERSION }}
49 | - run: pnpm install
50 | - run: pnpm run clone
51 | - name: Run Tests
52 | env:
53 | PERCY_PARALLEL_NONCE: ${{ env.PERCY_PARALLEL_NONCE }}
54 | PERCY_PARALLEL_TOTAL: ${{ env.PERCY_PARALLEL_TOTAL }}
55 | PERCY_TOKEN: 5ad6687f6b1ad3dec2b964f94d3d59ff3880baccf1492c0663e85c1ce79c1a52
56 | run: pnpm percy exec -- pnpm run test:ember
57 |
--------------------------------------------------------------------------------
/tests/acceptance/head-test.js:
--------------------------------------------------------------------------------
1 | import { visit } from '@ember/test-helpers';
2 | import ENV from 'ember-api-docs/config/environment';
3 | import { module, test } from 'qunit';
4 |
5 | import { setupApplicationTest } from 'ember-qunit';
6 |
7 | module('Acceptance | head', function (hooks) {
8 | setupApplicationTest(hooks);
9 |
10 | hooks.beforeEach(function () {
11 | this.head = document.querySelector('head');
12 | });
13 |
14 | test('no link rel=canonical for release url', async function (assert) {
15 | await visit('/ember/release/classes/Application');
16 | assert.dom('link[rel=canonical]', this.head).doesNotExist();
17 | });
18 |
19 | test('shows link rel=canonical for version url', async function (assert) {
20 | await visit('/ember/2.16/classes/Application');
21 | assert.dom('link[rel=canonical]', this.head).hasAttribute('href');
22 | });
23 |
24 | test('no link rel=canonical when root url visited', async function (assert) {
25 | await visit('/');
26 | assert.dom('link[rel=canonical]', this.head).doesNotExist();
27 | });
28 |
29 | test('dns prefetch should be populated', async function (assert) {
30 | await visit('/ember/release/classes/Application');
31 | assert
32 | .dom('link[rel=dns-prefetch]', this.head)
33 | .hasAttribute('href', ENV.API_HOST);
34 | });
35 |
36 | test('dns prefetch should be populated when root url visited', async function (assert) {
37 | await visit('/');
38 | assert
39 | .dom('link[rel=dns-prefetch]', this.head)
40 | .hasAttribute('href', ENV.API_HOST);
41 | });
42 | });
43 |
--------------------------------------------------------------------------------
/ember-cli-build.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 |
3 | const EmberApp = require('ember-cli/lib/broccoli/ember-app');
4 | const envIsProduction = process.env.EMBER_ENV === 'production';
5 | const premberUrls = require('./prember-urls');
6 |
7 | module.exports = function (defaults) {
8 | const app = new EmberApp(defaults, {
9 | prember: {
10 | urls: premberUrls(),
11 | },
12 | fingerprint: {
13 | extensions: ['js', 'css', 'jpg', 'png', 'gif', 'map', 'webmanifest'],
14 | generateAssetMap: true,
15 | },
16 | autoprefixer: {
17 | enabled: true,
18 | cascade: true,
19 | sourcemap: !envIsProduction,
20 | overrideBrowsersList: ['default'],
21 | },
22 | 'ember-composable-helpers': {
23 | only: ['join', 'map-by'],
24 | },
25 | 'asset-cache': {
26 | version: '4', //Might have to change this with the app build,
27 | },
28 | svgJar: {
29 | sourceDirs: ['public/assets/images'],
30 | },
31 | 'ember-cli-babel': {
32 | includePolyfill: true,
33 | },
34 | babel: {
35 | plugins: [
36 | // ... any other plugins
37 | require.resolve('ember-concurrency/async-arrow-task-transform'),
38 |
39 | // NOTE: put any code coverage plugins last, after the transform.
40 | ],
41 | },
42 | });
43 |
44 | const { Webpack } = require('@embroider/webpack');
45 | const appTree = require('@embroider/compat').compatBuild(app, Webpack, {
46 | staticAddonTrees: true,
47 | staticAddonTestSupportTrees: true,
48 | staticHelpers: true,
49 | staticModifiers: true,
50 | staticComponents: true,
51 | });
52 |
53 | return require('prember').prerender(app, appTree);
54 | };
55 |
--------------------------------------------------------------------------------
/app/components/ember-data-landing-page.hbs:
--------------------------------------------------------------------------------
1 |
23 |
24 |
25 | 3 | Ember Data API Documentation 4 |
5 |6 |
7 | Ember Data is a library for robustly managing data in applications built with Ember.js. 8 |
9 |10 | Commonly searched-for documentation 11 |
12 |-
13 |
-
14 |
15 | Model 16 | 17 | - an object that represents the underlying data that your application presents to the user. 18 |
19 | -
20 |
21 | Store 22 | 23 | - a service that contains all of the data for records loaded from the server. 24 |
25 | -
26 |
27 | Adapter 28 | 29 | - determines how data is persisted to a backend data store. 30 |
31 | -
32 |
33 | Serializer 34 | 35 | - format the data sent to and received from the backend store. 36 |
37 |
39 | Useful links 40 |
41 |-
42 |
-
43 |
44 | 45 | API Documentation Github Repository 46 | 47 |
48 |
49 | -
50 |
51 | 52 | Introduction to Ember Data 53 | 54 |
55 |
56 |
-
6 |
-
7 | Packages
8 |
-
9 | {{#each @moduleIDs as |moduleID|}}
10 |
11 | {{#if (not-eq moduleID '@ember/object/computed')}}
12 |
-
13 |
{{moduleID}} 14 |
15 | {{/if}}
16 |
17 | {{/each}}
18 |
20 |
21 | {{#if @isShowingNamespaces}}
22 | -
13 |
-
23 | Namespaces
24 |
-
25 | {{#each @namespaceIDs as |namespaceID|}}
26 |
-
27 |
{{namespaceID}} 28 |
29 | {{/each}}
30 |
32 | {{/if}}
33 |
34 | -
27 |
-
35 | Classes
36 |
-
37 | {{#each @classesIDs as |classID|}}
38 |
-
39 |
{{classID}} 40 |
41 | {{/each}}
42 |
44 | -
39 |
HashLocation implements the location API using the browser's\nhash. At present, it relies on a hashchange event existing in the\nbrowser.
Using HashLocation results in URLs with a # (hash sign) separating the\nserver side URL portion of the URL from the portion that is used by Ember.
Example:
\n\n \n \n \n
\n
\n \n| app/router.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n | \n Router.map(function() {\n this.route('posts', function() {\n this.route('new');\n });\n});\n\nRouter.reopen({\n location: 'hash'\n}); | \n
This will result in a posts.new url of /#/posts/new.
4 | {{#if (eq this.model.name 'ember-data-overview')}}
5 |
12 | EmberData Overview
6 | {{else}} 7 |Package {{this.model.name}} 8 | {{#if this.model.access}}{{this.model.access}}{{/if}} 9 |
10 | {{/if}} 11 |13 | 14 |
15 | {{#if this.model.parent}} 16 |
17 | Parent:
18 | {{this.model.parent}}
19 |
20 | {{/if}}
21 |
22 |
23 | 28 | 29 | Submodules 30 |
31 |-
32 | {{#each this.submodules as |module|}}
33 |
-
34 |
35 | {{module}} 36 | 37 |
38 | {{/each}}
39 |
46 | 47 | Classes 48 |
49 |-
50 | {{#each this.classesAndNamespaces as |klass|}}
51 | {{#if (not (and (eq this.model.name "ember-data") (eq klass "Ember")))}}
52 |
-
53 |
54 | {{klass}} 55 | 56 |
57 | {{/if}}
58 | {{/each}}
59 |
66 | 67 | Functions 68 |
69 | {{#each this.functionHeadings as |funcHeading|}} 70 |71 | 72 | {{funcHeading}} 73 |
74 |-
75 | {{#each (better-get this.functions funcHeading) as |method|}}
76 |
-
77 |
78 | {{method.name}} 79 | 80 |
81 | {{/each}}
82 |
4 | 5 | 6 | {{@field.name}} 7 | 8 | {{#if @field.params}}({{join ', ' (map-by 'name' @field.params)}}){{/if}} 9 | {{#if @field.return}} 10 | : {{@field.return.type}} 11 | {{/if}} 12 | 13 | {{#if @field.access}} 14 | {{@field.access}} 15 | {{/if}} 16 | {{#if @field.deprecated}} 17 | deprecated 18 | {{/if}} 19 | 20 | {{svg-jar 'link' width='20px' height='20px' aria-hidden='true'}} 21 | 22 |
23 | {{#if @model.module}} 24 |
25 |
30 | {{/if}}
31 |
26 | Module:
27 | {{@model.module}}
28 |
29 | 32 | {{#if @field.inherited}} 33 | Inherited from 34 | 35 | {{@field.inheritedFrom}} {{@field.file}}:{{@field.line}} 36 | 37 | {{else}} 38 | Defined in 39 | 40 | {{@field.file}}:{{@field.line}} 41 | 42 | {{/if}} 43 |
44 | {{#if @field.since}} 45 |46 | Available since v{{@field.since}} 47 |
48 | {{/if}} 49 | {{#if (and (eq @field.static 1) (eq @field.itemtype 'method') this.hasImportExample)}} 50 |-
53 | {{#each @field.params as |param|}}
54 |
- {{param.name}} 56 |
- {{param.type}} 57 |
- {{prop.name}} 63 |
- {{prop.type}} 64 |
- returns 74 |
- {{@field.return.type}} 75 |
55 |
70 | {{/each}}
71 | {{#if @field.return}}
72 | -
60 | {{#each param.props as |prop|}}
61 |
62 |
66 | {{/each}}
67 |
73 |
77 | {{/if}}
78 | Ember API Documentation
3 |4 |
5 | To get started, choose a project (Ember or Ember Data) and a version 6 | from the dropdown menu. Ember has core methods used in any app, while Ember Data has 7 | documentation of the built-in library for making requests to a back end. 8 | If you're looking for documentation of the command line tool used to generate files, build your 9 | app, and more, visit ember-cli. The latest 10 | testing API is available at 11 | ember-test-helpers. 12 |
13 |Commonly searched-for documentation
14 |-
15 | {{! template-lint-disable no-potential-path-strings }}
16 |
- Components -
Classic orGlimmer ; a view that is completely isolated
17 | Tracked - make your templates responsive to property updates
18 | Computed Properties - declare functions as properties
19 | {{! template-lint-disable no-potential-path-strings }}
20 | Computed Macros - shorter ways of expressing certain types of computed properties
21 | -
22 |
EmberArray - contains methods like 23 | forEach and 24 | mapBy 25 | that help you iterate over Ember Objects 26 |
27 | -
28 |
EmberObject - the main base class for all Ember objects, including the 29 | get and 30 | set methods 31 |
32 | -
33 |
Ember.Templates.helpers - built-in functions that can be used in templates, such as the 34 | each and 35 | on helpers 36 |
37 | Helpers - a way to define custom display functions that are used in templates
38 | -
39 |
Route - used to define individual routes, including the 40 | model hook for loading data 41 |
42 | Service - an Ember object that lives for the duration of the application, and can be made available in different parts of your application
43 |
Useful links
45 |-
46 |
-
47 |
48 | API Documentation Github Repository 49 |
50 |
51 | -
52 |
53 | Ember Core Concepts 54 |
55 |
56 |
93 |
--------------------------------------------------------------------------------
/public/assets/images/dnsimple-logo-dark.svg:
--------------------------------------------------------------------------------
1 |
2 |
38 |
--------------------------------------------------------------------------------