From aee0b5c2b1d9f9b9635003179f3b8d9102933c82 Mon Sep 17 00:00:00 2001 From: Angular Robot Date: Tue, 20 Oct 2026 13:16:28 +0000 Subject: [PATCH] docs: update cross-repo adev docs Updated Angular adev cross repo docs files. --- adev/src/content/aria/_build-info.json | 2 +- adev/src/content/aria/aria-accordion.json | 33 +- adev/src/content/aria/aria-combobox.json | 76 +- adev/src/content/aria/aria-grid.json | 14 +- adev/src/content/aria/aria-listbox.json | 10 +- adev/src/content/aria/aria-menu.json | 86 +- adev/src/content/aria/aria-tabs.json | 46 +- adev/src/content/aria/aria-toolbar.json | 6 +- adev/src/content/aria/aria-tree.json | 61 +- adev/src/content/cdk/_build-info.json | 2 +- adev/src/content/cdk/cdk_drag_drop.json | 457 +++-- .../content/cdk/cdk_testing_protractor.json | 1548 +++++++++++++++- .../cdk/cdk_testing_selenium_webdriver.json | 1548 +++++++++++++++- adev/src/content/cdk/cdk_testing_testbed.json | 1562 ++++++++++++++++- adev/src/content/cli/_build-info.json | 2 +- adev/src/content/cli/build.json | 2 +- adev/src/content/cli/completion.json | 2 +- adev/src/content/cli/deploy.json | 4 +- adev/src/content/cli/generate.json | 20 +- adev/src/content/cli/new.json | 6 +- adev/src/content/cli/run.json | 2 +- adev/src/content/cli/serve.json | 4 +- adev/src/content/cli/test.json | 2 +- 23 files changed, 5200 insertions(+), 295 deletions(-) diff --git a/adev/src/content/aria/_build-info.json b/adev/src/content/aria/_build-info.json index c1a86fd79bf5..eb183667f4b0 100644 --- a/adev/src/content/aria/_build-info.json +++ b/adev/src/content/aria/_build-info.json @@ -1,4 +1,4 @@ { "branchName": "refs/heads/22.2.x", - "sha": "6233674864056d089814f878c172f16217987183" + "sha": "45e87b44c5b4c07a20e57c1bd3a75cdb68bba4df" } \ No newline at end of file diff --git a/adev/src/content/aria/aria-accordion.json b/adev/src/content/aria/aria-accordion.json index d8a2485bd897..62cff285884c 100755 --- a/adev/src/content/aria/aria-accordion.json +++ b/adev/src/content/aria/aria-accordion.json @@ -7,7 +7,7 @@ { "name": "AccordionContent", "isAbstract": false, - "entryType": "undecorated_class", + "entryType": "directive", "members": [], "generics": [], "description": "A structural directive that provides a mechanism for lazily rendering the content for an\n`ngAccordionPanel`.\n\nThis directive should be applied to an `ng-template` inside an `ngAccordionPanel`.\nIt allows the content of the panel to be lazily rendered, improving performance\nby only creating the content when the panel is first expanded.\n\n```html\n
\n \n

This is the content that will be displayed inside the panel.

\n \n
\n```", @@ -19,6 +19,12 @@ ], "rawComment": "/**\n * A structural directive that provides a mechanism for lazily rendering the content for an\n * `ngAccordionPanel`.\n *\n * This directive should be applied to an `ng-template` inside an `ngAccordionPanel`.\n * It allows the content of the panel to be lazily rendered, improving performance\n * by only creating the content when the panel is first expanded.\n *\n * ```html\n *
\n * \n *

This is the content that will be displayed inside the panel.

\n * \n *
\n * ```\n *\n * @see [Accordion](guide/aria/accordion)\n */", "implements": [], + "isStandalone": true, + "selector": "ng-template[ngAccordionContent]", + "exportAs": [], + "aliases": [ + "ngAccordionContent" + ], "source": { "filePath": "src/aria/accordion/accordion-content.ts", "startLine": 30, @@ -41,7 +47,7 @@ { "name": "AccordionPanel", "isAbstract": false, - "entryType": "undecorated_class", + "entryType": "directive", "members": [ { "name": "element", @@ -55,13 +61,16 @@ }, { "name": "id", - "type": "InputSignal", + "type": "InputSignal", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "input" ], "description": "A global unique identifier for the panel.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "id", + "isRequiredInput": false }, { "name": "visible", @@ -183,6 +192,14 @@ ], "rawComment": "/**\n * The content panel of an accordion item that is conditionally visible.\n *\n * This directive is a container for the content that is shown or hidden. It should\n * expose a template reference that will be used by the corresponding `ngAccordionTrigger`.\n * The content within the panel should be provided using an `ng-template` with the\n * `ngAccordionContent` directive so that the content is not rendered on the page until the trigger\n * is expanded. It applies `role=\"region\"` for accessibility and uses the `inert` attribute to hide\n * its content from assistive technologies when not visible.\n *\n * ```html\n *
\n * \n *

This content is lazily rendered and will be shown when the panel is expanded.

\n * \n *
\n * ```\n *\n * @see [Accordion](guide/aria/accordion)\n */", "implements": [], + "isStandalone": true, + "selector": "[ngAccordionPanel]", + "exportAs": [ + "ngAccordionPanel" + ], + "aliases": [ + "ngAccordionPanel" + ], "source": { "filePath": "/src/aria/accordion/accordion-panel.ts", "startLine": 42, @@ -219,7 +236,7 @@ }, { "name": "id", - "type": "InputSignal", + "type": "InputSignal", "memberType": "property", "memberTags": [ "readonly", @@ -232,7 +249,7 @@ }, { "name": "panelId", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -270,7 +287,7 @@ }, { "name": "active", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" diff --git a/adev/src/content/aria/aria-combobox.json b/adev/src/content/aria/aria-combobox.json index 8a5efbe5d6b7..91c48e11b0bf 100755 --- a/adev/src/content/aria/aria-combobox.json +++ b/adev/src/content/aria/aria-combobox.json @@ -229,17 +229,20 @@ { "name": "ComboboxPopup", "isAbstract": false, - "entryType": "undecorated_class", + "entryType": "directive", "members": [ { "name": "combobox", "type": "InputSignal", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "input" ], "description": "The combobox that the popup belongs to.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "combobox", + "isRequiredInput": true }, { "name": "controlTarget", @@ -276,10 +279,13 @@ "type": "InputSignal<\"listbox\" | \"tree\" | \"grid\" | \"dialog\">", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "input" ], "description": "The type of the popup (e.g., listbox, tree, grid, dialog).", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "popupType", + "isRequiredInput": false }, { "name": "ngOnInit", @@ -356,6 +362,14 @@ "OnInit", "OnDestroy" ], + "isStandalone": true, + "selector": "ng-template[ngComboboxPopup]", + "exportAs": [ + "ngComboboxPopup" + ], + "aliases": [ + "ngComboboxPopup" + ], "source": { "filePath": "src/aria/combobox/combobox-popup.ts", "startLine": 29, @@ -431,7 +445,7 @@ }, { "name": "tabIndex", - "type": "InputSignal", + "type": "InputSignalWithTransform", "memberType": "property", "memberTags": [ "readonly", @@ -517,6 +531,28 @@ "rawComment": "", "memberType": "method", "memberTags": [] + }, + { + "name": "contentVisible", + "type": "WritableSignal", + "memberType": "property", + "memberTags": [ + "readonly", + "override" + ], + "description": "", + "jsdocTags": [] + }, + { + "name": "preserveContent", + "type": "ModelSignal", + "memberType": "property", + "memberTags": [ + "readonly", + "override" + ], + "description": "", + "jsdocTags": [] } ], "generics": [], @@ -587,14 +623,6 @@ "computed", "@angular/core" ], - [ - "DeferredContent", - "@angular/aria/private" - ], - [ - "ComboboxPopupPattern", - "@angular/aria/private" - ], [ "afterRenderEffect", "@angular/core" @@ -611,18 +639,6 @@ "Renderer2", "@angular/core" ], - [ - "DeferredContentAware", - "@angular/aria/private" - ], - [ - "ComboboxPattern", - "@angular/aria/private" - ], - [ - "tabIndexTransform", - "@angular/aria/private" - ], [ "COMBOBOX_POPUP", "@angular/aria/combobox" @@ -750,6 +766,14 @@ [ "Combobox.ngOnInit", "@angular/aria/combobox" + ], + [ + "Combobox.contentVisible", + "@angular/aria/combobox" + ], + [ + "Combobox.preserveContent", + "@angular/aria/combobox" ] ] } \ No newline at end of file diff --git a/adev/src/content/aria/aria-grid.json b/adev/src/content/aria/aria-grid.json index 05c38daee922..631fc80cd88a 100755 --- a/adev/src/content/aria/aria-grid.json +++ b/adev/src/content/aria/aria-grid.json @@ -156,7 +156,7 @@ }, { "name": "active", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -166,7 +166,7 @@ }, { "name": "id", - "type": "InputSignal", + "type": "InputSignal", "memberType": "property", "memberTags": [ "readonly", @@ -205,7 +205,7 @@ }, { "name": "focusTarget", - "type": "InputSignal", + "type": "InputSignal>", "memberType": "property", "memberTags": [ "readonly", @@ -509,7 +509,7 @@ }, { "name": "tabIndex", - "type": "InputSignal", + "type": "InputSignalWithTransform", "memberType": "property", "memberTags": [ "readonly", @@ -522,7 +522,7 @@ }, { "name": "activeDescendant", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -656,7 +656,7 @@ }, { "name": "active", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -676,7 +676,7 @@ }, { "name": "id", - "type": "InputSignal", + "type": "InputSignal", "memberType": "property", "memberTags": [ "readonly", diff --git a/adev/src/content/aria/aria-listbox.json b/adev/src/content/aria/aria-listbox.json index 751ab862ddc8..b6555b4413eb 100755 --- a/adev/src/content/aria/aria-listbox.json +++ b/adev/src/content/aria/aria-listbox.json @@ -34,7 +34,7 @@ }, { "name": "active", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -44,7 +44,7 @@ }, { "name": "id", - "type": "InputSignal", + "type": "InputSignal", "memberType": "property", "memberTags": [ "readonly", @@ -96,7 +96,7 @@ }, { "name": "selected", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -221,7 +221,7 @@ "members": [ { "name": "id", - "type": "InputSignal", + "type": "InputSignal", "memberType": "property", "memberTags": [ "readonly", @@ -372,7 +372,7 @@ }, { "name": "tabIndex", - "type": "InputSignal", + "type": "InputSignalWithTransform", "memberType": "property", "memberTags": [ "readonly", diff --git a/adev/src/content/aria/aria-menu.json b/adev/src/content/aria/aria-menu.json index 306748d57631..45c1a99e4d08 100755 --- a/adev/src/content/aria/aria-menu.json +++ b/adev/src/content/aria/aria-menu.json @@ -7,7 +7,7 @@ { "name": "MenuContent", "isAbstract": false, - "entryType": "undecorated_class", + "entryType": "directive", "members": [], "generics": [], "description": "Defers the rendering of the menu content.\n\nThis structural directive should be applied to an `ng-template` within a `ngMenu`\nor `ngMenuBar` to lazily render its content only when the menu is opened.\n\n```html\n
\n \n
Lazy Item 1
\n
Lazy Item 2
\n \n
\n```", @@ -23,6 +23,14 @@ ], "rawComment": "/**\n * Defers the rendering of the menu content.\n *\n * This structural directive should be applied to an `ng-template` within a `ngMenu`\n * or `ngMenuBar` to lazily render its content only when the menu is opened.\n *\n * ```html\n *
\n * \n *
Lazy Item 1
\n *
Lazy Item 2
\n * \n *
\n * ```\n *\n * @see [Menu](guide/aria/menu)\n * @see [MenuBar](guide/aria/menubar)\n */", "implements": [], + "isStandalone": true, + "selector": "ng-template[ngMenuContent]", + "exportAs": [ + "ngMenuContent" + ], + "aliases": [ + "ngMenuContent" + ], "source": { "filePath": "/src/aria/menu/menu-content.ts", "startLine": 30, @@ -82,7 +90,7 @@ }, { "name": "expanded", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -92,7 +100,7 @@ }, { "name": "hasPopup", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -242,7 +250,7 @@ }, { "name": "id", - "type": "InputSignal", + "type": "InputSignal", "memberType": "property", "memberTags": [ "readonly", @@ -332,7 +340,7 @@ }, { "name": "active", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -342,7 +350,7 @@ }, { "name": "expanded", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -352,7 +360,7 @@ }, { "name": "hasPopup", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -736,7 +744,7 @@ { "name": "Menu", "isAbstract": false, - "entryType": "undecorated_class", + "entryType": "directive", "members": [ { "name": "element", @@ -760,43 +768,55 @@ }, { "name": "id", - "type": "InputSignal", + "type": "InputSignal", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "input" ], "description": "The unique ID of the menu.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "id", + "isRequiredInput": false }, { "name": "wrap", "type": "InputSignalWithTransform", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "input" ], "description": "Whether the menu should wrap its items.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "wrap", + "isRequiredInput": false }, { "name": "typeaheadDelay", "type": "InputSignal", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "input" ], "description": "The delay in milliseconds before the typeahead buffer is cleared.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "typeaheadDelay", + "isRequiredInput": false }, { "name": "disabled", "type": "InputSignalWithTransform", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "input" ], "description": "Whether the menu is disabled.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "disabled", + "isRequiredInput": false }, { "name": "parent", @@ -813,14 +833,17 @@ "type": "InputSignalWithTransform", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "input" ], "description": "Whether the menu is soft disabled.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "softDisabled", + "isRequiredInput": false }, { "name": "visible", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -830,7 +853,7 @@ }, { "name": "tabIndex", - "type": "Signal", + "type": "Signal<0 | -1>", "memberType": "property", "memberTags": [ "readonly" @@ -843,20 +866,25 @@ "type": "OutputEmitterRef", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "output" ], "description": "A callback function triggered when a menu item is selected.", - "jsdocTags": [] + "jsdocTags": [], + "outputAlias": "itemSelected" }, { "name": "expansionDelay", "type": "InputSignal", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "input" ], "description": "The delay in milliseconds before expanding sub-menus on hover.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "expansionDelay", + "isRequiredInput": false }, { "name": "ngOnDestroy", @@ -945,6 +973,14 @@ "implements": [ "OnDestroy" ], + "isStandalone": true, + "selector": "[ngMenu]", + "exportAs": [ + "ngMenu" + ], + "aliases": [ + "ngMenu" + ], "source": { "filePath": "/src/aria/menu/menu.ts", "startLine": 57, diff --git a/adev/src/content/aria/aria-tabs.json b/adev/src/content/aria/aria-tabs.json index 428bba90011b..c3cdee3738b2 100755 --- a/adev/src/content/aria/aria-tabs.json +++ b/adev/src/content/aria/aria-tabs.json @@ -7,7 +7,7 @@ { "name": "TabContent", "isAbstract": false, - "entryType": "undecorated_class", + "entryType": "directive", "members": [], "generics": [], "description": "A TabContent container for the lazy-loaded content.\n\nThis structural directive should be applied to an `ng-template` within an `ngTabPanel`.\nIt enables lazy loading of the tab's content, meaning the content is only rendered\nwhen the tab is activated for the first time.\n\n```html\n
\n \n

This content will be loaded when 'myTabId' is selected.

\n \n
\n```", @@ -19,6 +19,14 @@ ], "rawComment": "/**\n * A TabContent container for the lazy-loaded content.\n *\n * This structural directive should be applied to an `ng-template` within an `ngTabPanel`.\n * It enables lazy loading of the tab's content, meaning the content is only rendered\n * when the tab is activated for the first time.\n *\n * ```html\n *
\n * \n *

This content will be loaded when 'myTabId' is selected.

\n * \n *
\n * ```\n *\n * @see [Tabs](guide/aria/tabs)\n */", "implements": [], + "isStandalone": true, + "selector": "ng-template[ngTabContent]", + "exportAs": [ + "ngTabContent" + ], + "aliases": [ + "ngTabContent" + ], "source": { "filePath": "/src/aria/tabs/tab-content.ts", "startLine": 29, @@ -143,7 +151,7 @@ }, { "name": "id", - "type": "InputSignal", + "type": "InputSignal", "memberType": "property", "memberTags": [ "readonly", @@ -182,7 +190,7 @@ }, { "name": "active", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -192,7 +200,7 @@ }, { "name": "selected", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -331,7 +339,7 @@ { "name": "TabPanel", "isAbstract": false, - "entryType": "undecorated_class", + "entryType": "directive", "members": [ { "name": "element", @@ -345,23 +353,29 @@ }, { "name": "id", - "type": "InputSignal", + "type": "InputSignal", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "input" ], "description": "A global unique identifier for the tab.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "id", + "isRequiredInput": false }, { "name": "value", "type": "InputSignal", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "input" ], "description": "A local unique identifier for the tabpanel.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "value", + "isRequiredInput": true }, { "name": "visible", @@ -453,6 +467,14 @@ "OnInit", "OnDestroy" ], + "isStandalone": true, + "selector": "[ngTabPanel]", + "exportAs": [ + "ngTabPanel" + ], + "aliases": [ + "ngTabPanel" + ], "source": { "filePath": "/src/aria/tabs/tab-panel.ts", "startLine": 42, @@ -712,7 +734,7 @@ } ], "rawComment": "", - "returnType": "any" + "returnType": "Tab | undefined" } ], "implementation": { @@ -726,7 +748,7 @@ } ], "isNewType": false, - "returnType": "any", + "returnType": "Tab | undefined", "generics": [], "name": "findTab", "description": "", diff --git a/adev/src/content/aria/aria-toolbar.json b/adev/src/content/aria/aria-toolbar.json index e2d03041c1fb..df92067a1e63 100755 --- a/adev/src/content/aria/aria-toolbar.json +++ b/adev/src/content/aria/aria-toolbar.json @@ -224,7 +224,7 @@ }, { "name": "id", - "type": "InputSignal", + "type": "InputSignal", "memberType": "property", "memberTags": [ "readonly", @@ -250,7 +250,7 @@ }, { "name": "hardDisabled", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -260,7 +260,7 @@ }, { "name": "active", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" diff --git a/adev/src/content/aria/aria-tree.json b/adev/src/content/aria/aria-tree.json index 0bfd2326b80c..c455e44a0548 100755 --- a/adev/src/content/aria/aria-tree.json +++ b/adev/src/content/aria/aria-tree.json @@ -7,7 +7,7 @@ { "name": "TreeItemGroup", "isAbstract": false, - "entryType": "undecorated_class", + "entryType": "directive", "members": [ { "name": "element", @@ -24,10 +24,13 @@ "type": "InputSignal>", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "input" ], "description": "Tree item that owns the group.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "ownedBy", + "isRequiredInput": true }, { "name": "ngOnInit", @@ -113,6 +116,14 @@ "OnInit", "OnDestroy" ], + "isStandalone": true, + "selector": "ng-template[ngTreeItemGroup]", + "exportAs": [ + "ngTreeItemGroup" + ], + "aliases": [ + "ngTreeItemGroup" + ], "source": { "filePath": "/src/aria/tree/tree-item-group.ts", "startLine": 42, @@ -136,7 +147,7 @@ }, { "name": "id", - "type": "InputSignal", + "type": "InputSignal", "memberType": "property", "memberTags": [ "readonly", @@ -249,7 +260,7 @@ }, { "name": "active", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -259,7 +270,7 @@ }, { "name": "level", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -269,7 +280,7 @@ }, { "name": "selected", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -279,7 +290,7 @@ }, { "name": "visible", - "type": "Signal", + "type": "Signal", "memberType": "property", "memberTags": [ "readonly" @@ -352,6 +363,28 @@ "rawComment": "", "memberType": "method", "memberTags": [] + }, + { + "name": "contentVisible", + "type": "WritableSignal", + "memberType": "property", + "memberTags": [ + "readonly", + "override" + ], + "description": "", + "jsdocTags": [] + }, + { + "name": "preserveContent", + "type": "ModelSignal", + "memberType": "property", + "memberTags": [ + "readonly", + "override" + ], + "description": "", + "jsdocTags": [] } ], "generics": [ @@ -399,7 +432,7 @@ }, { "name": "id", - "type": "InputSignal", + "type": "InputSignal", "memberType": "property", "memberTags": [ "readonly", @@ -516,7 +549,7 @@ }, { "name": "tabIndex", - "type": "InputSignal", + "type": "InputSignalWithTransform", "memberType": "property", "memberTags": [ "readonly", @@ -867,6 +900,14 @@ "TreeItem.ngOnDestroy", "@angular/aria/tree" ], + [ + "TreeItem.contentVisible", + "@angular/aria/tree" + ], + [ + "TreeItem.preserveContent", + "@angular/aria/tree" + ], [ "Tree", "@angular/aria/tree" diff --git a/adev/src/content/cdk/_build-info.json b/adev/src/content/cdk/_build-info.json index d15e53b1b3ed..9447249c65c1 100644 --- a/adev/src/content/cdk/_build-info.json +++ b/adev/src/content/cdk/_build-info.json @@ -1,4 +1,4 @@ { "branchName": "refs/heads/22.2.x", - "sha": "9722f3e85b835608de22f8ce9ae604dffab86417" + "sha": "be2e64225c90800c8aae356a172beda0de8da759" } \ No newline at end of file diff --git a/adev/src/content/cdk/cdk_drag_drop.json b/adev/src/content/cdk/cdk_drag_drop.json index b5e1cc703cf6..f84f903eb417 100755 --- a/adev/src/content/cdk/cdk_drag_drop.json +++ b/adev/src/content/cdk/cdk_drag_drop.json @@ -227,7 +227,7 @@ { "name": "element", "description": "Element to which to attach the dragging functionality.", - "type": "any", + "type": "HTMLElement | ElementRef", "isOptional": false, "isRestParam": false }, @@ -248,7 +248,7 @@ { "name": "element", "description": "Element to which to attach the dragging functionality.", - "type": "any", + "type": "HTMLElement | ElementRef", "isOptional": false, "isRestParam": false }, @@ -347,7 +347,7 @@ { "name": "element", "description": "Element to which to attach the drop list functionality.", - "type": "any", + "type": "HTMLElement | ElementRef", "isOptional": false, "isRestParam": false } @@ -361,7 +361,7 @@ { "name": "element", "description": "Element to which to attach the drop list functionality.", - "type": "any", + "type": "HTMLElement | ElementRef", "isOptional": false, "isRestParam": false } @@ -451,7 +451,7 @@ }, { "name": "CDK_DRAG_PARENT", - "type": "any", + "type": "InjectionToken>", "entryType": "constant", "rawComment": "/**\n * Injection token that can be used for a `CdkDrag` to provide itself as a parent to the\n * drag-specific child directive (`CdkDragHandle`, `CdkDragPreview` etc.). Used primarily\n * to avoid circular imports.\n * @docs-private\n */", "description": "Injection token that can be used for a `CdkDrag` to provide itself as a parent to the\ndrag-specific child directive (`CdkDragHandle`, `CdkDragPreview` etc.). Used primarily\nto avoid circular imports.", @@ -522,7 +522,7 @@ }, { "name": "CDK_DROP_LIST_GROUP", - "type": "any", + "type": "InjectionToken>>", "entryType": "constant", "rawComment": "/**\n * Injection token that can be used to reference instances of `CdkDropListGroup`. It serves as\n * alternative token to the actual `CdkDropListGroup` class which could cause unnecessary\n * retention of the class and its directive metadata.\n */", "description": "Injection token that can be used to reference instances of `CdkDropListGroup`. It serves as\nalternative token to the actual `CdkDropListGroup` class which could cause unnecessary\nretention of the class and its directive metadata.", @@ -535,7 +535,7 @@ }, { "name": "CDK_DRAG_PLACEHOLDER", - "type": "any", + "type": "InjectionToken>", "entryType": "constant", "rawComment": "/**\n * Injection token that can be used to reference instances of `CdkDragPlaceholder`. It serves as\n * alternative token to the actual `CdkDragPlaceholder` class which could cause unnecessary\n * retention of the class and its directive metadata.\n */", "description": "Injection token that can be used to reference instances of `CdkDragPlaceholder`. It serves as\nalternative token to the actual `CdkDragPlaceholder` class which could cause unnecessary\nretention of the class and its directive metadata.", @@ -548,7 +548,7 @@ }, { "name": "CDK_DRAG_PREVIEW", - "type": "any", + "type": "InjectionToken>", "entryType": "constant", "rawComment": "/**\n * Injection token that can be used to reference instances of `CdkDragPreview`. It serves as\n * alternative token to the actual `CdkDragPreview` class which could cause unnecessary\n * retention of the class and its directive metadata.\n */", "description": "Injection token that can be used to reference instances of `CdkDragPreview`. It serves as\nalternative token to the actual `CdkDragPreview` class which could cause unnecessary\nretention of the class and its directive metadata.", @@ -566,7 +566,7 @@ "members": [ { "name": "templateRef", - "type": "any", + "type": "TemplateRef", "memberType": "property", "memberTags": [], "description": "", @@ -645,15 +645,19 @@ { "name": "CdkDropListGroup", "isAbstract": false, - "entryType": "undecorated_class", + "entryType": "directive", "members": [ { "name": "disabled", "type": "boolean", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Whether starting a dragging sequence from inside this group is disabled.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDropListGroupDisabled", + "isRequiredInput": false }, { "name": "ngOnDestroy", @@ -700,6 +704,14 @@ "implements": [ "OnDestroy" ], + "isStandalone": true, + "selector": "[cdkDropListGroup]", + "exportAs": [ + "cdkDropListGroup" + ], + "aliases": [ + "cdkDropListGroup" + ], "source": { "filePath": "/src/cdk/drag-drop/directives/drop-list-group.ts", "startLine": 27, @@ -709,11 +721,11 @@ { "name": "CdkDragPreview", "isAbstract": false, - "entryType": "undecorated_class", + "entryType": "directive", "members": [ { "name": "templateRef", - "type": "any", + "type": "TemplateRef", "memberType": "property", "memberTags": [], "description": "", @@ -723,17 +735,25 @@ "name": "data", "type": "T", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Context data to be added to the preview template instance.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "data", + "isRequiredInput": false }, { "name": "matchSize", "type": "boolean", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Whether the preview should preserve the same size as the item that is being dragged.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "matchSize", + "isRequiredInput": false }, { "name": "ngOnDestroy", @@ -781,6 +801,12 @@ "implements": [ "OnDestroy" ], + "isStandalone": true, + "selector": "ng-template[cdkDragPreview]", + "exportAs": [], + "aliases": [ + "cdkDragPreview" + ], "source": { "filePath": "/src/cdk/drag-drop/directives/drag-preview.ts", "startLine": 31, @@ -789,7 +815,7 @@ }, { "name": "CDK_DRAG_CONFIG", - "type": "any", + "type": "InjectionToken", "entryType": "constant", "rawComment": "/**\n * Injection token that can be used to configure the\n * behavior of the drag&drop-related components.\n */", "description": "Injection token that can be used to configure the\nbehavior of the drag&drop-related components.", @@ -803,7 +829,7 @@ { "name": "DragDropModule", "isAbstract": false, - "entryType": "undecorated_class", + "entryType": "ng_module", "members": [], "generics": [], "description": "", @@ -818,7 +844,7 @@ }, { "name": "CDK_DRAG_HANDLE", - "type": "any", + "type": "InjectionToken", "entryType": "constant", "rawComment": "/**\n * Injection token that can be used to reference instances of `CdkDragHandle`. It serves as\n * alternative token to the actual `CdkDragHandle` class which could cause unnecessary\n * retention of the class and its directive metadata.\n */", "description": "Injection token that can be used to reference instances of `CdkDragHandle`. It serves as\nalternative token to the actual `CdkDragHandle` class which could cause unnecessary\nretention of the class and its directive metadata.", @@ -1211,11 +1237,11 @@ { "name": "CdkDragHandle", "isAbstract": false, - "entryType": "undecorated_class", + "entryType": "directive", "members": [ { "name": "element", - "type": "any", + "type": "ElementRef", "memberType": "property", "memberTags": [], "description": "", @@ -1225,17 +1251,25 @@ "name": "disabled", "type": "boolean", "memberType": "getter", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Whether starting to drag through this handle is disabled.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDragHandleDisabled", + "isRequiredInput": false }, { "name": "disabled", "type": "boolean", "memberType": "setter", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDragHandleDisabled", + "isRequiredInput": false }, { "name": "ngAfterViewInit", @@ -1312,6 +1346,12 @@ "AfterViewInit", "OnDestroy" ], + "isStandalone": true, + "selector": "[cdkDragHandle]", + "exportAs": [], + "aliases": [ + "cdkDragHandle" + ], "source": { "filePath": "/src/cdk/drag-drop/directives/drag-handle.ts", "startLine": 33, @@ -1321,11 +1361,11 @@ { "name": "CdkDropList", "isAbstract": false, - "entryType": "undecorated_class", + "entryType": "directive", "members": [ { "name": "element", - "type": "any", + "type": "ElementRef", "memberType": "property", "memberTags": [], "description": "", @@ -1335,153 +1375,217 @@ "name": "connectedTo", "type": "string | CdkDropList | (string | CdkDropList)[]", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Other draggable containers that this container is connected to and into which the\ncontainer's items can be transferred. Can either be references to other drop containers,\nor their unique IDs.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDropListConnectedTo", + "isRequiredInput": false }, { "name": "data", "type": "T", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Arbitrary data to attach to this container.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDropListData", + "isRequiredInput": false }, { "name": "orientation", "type": "DropListOrientation", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Direction in which the list is oriented.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDropListOrientation", + "isRequiredInput": false }, { "name": "id", "type": "string", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Unique ID for the drop zone. Can be used as a reference\nin the `connectedTo` of another `CdkDropList`.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "id", + "isRequiredInput": false }, { "name": "lockAxis", "type": "DragAxis | null", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Locks the position of the draggable elements inside the container along the specified axis.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDropListLockAxis", + "isRequiredInput": false }, { "name": "disabled", "type": "boolean", "memberType": "getter", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Whether starting a dragging sequence from this container is disabled.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDropListDisabled", + "isRequiredInput": false }, { "name": "disabled", "type": "boolean", "memberType": "setter", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDropListDisabled", + "isRequiredInput": false }, { "name": "sortingDisabled", "type": "boolean", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Whether sorting within this drop list is disabled.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDropListSortingDisabled", + "isRequiredInput": false }, { "name": "enterPredicate", "type": "(drag: CdkDrag, drop: CdkDropList) => boolean", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Function that is used to determine whether an item\nis allowed to be moved into a drop container.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDropListEnterPredicate", + "isRequiredInput": false }, { "name": "sortPredicate", "type": "(index: number, drag: CdkDrag, drop: CdkDropList) => boolean", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Functions that is used to determine whether an item can be sorted into a particular index.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDropListSortPredicate", + "isRequiredInput": false }, { "name": "autoScrollDisabled", "type": "boolean", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Whether to auto-scroll the view when the user moves their pointer close to the edges.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDropListAutoScrollDisabled", + "isRequiredInput": false }, { "name": "autoScrollStep", "type": "NumberInput", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Number of pixels to scroll for each frame when auto-scrolling an element.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDropListAutoScrollStep", + "isRequiredInput": false }, { "name": "elementContainerSelector", "type": "string | null", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Selector that will be used to resolve an alternate element container for the drop list.\nPassing an alternate container is useful for the cases where one might not have control\nover the parent node of the draggable items within the list (e.g. due to content projection).\nThis allows for usages like:\n\n```\n
\n
\n
\n
\n
\n```", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDropListElementContainer", + "isRequiredInput": false }, { "name": "hasAnchor", "type": "boolean", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "By default when an item leaves its initial container, its placeholder will be transferred\nto the new container. If that's not desirable for your use case, you can enable this option\nwhich will clone the placeholder and leave it inside the original container. If the item is\nreturned to the initial container, the anchor element will be removed automatically.\n\nThe cloned placeholder can be styled by targeting the `cdk-drag-anchor` class.\n\nThis option is useful in combination with `cdkDropListSortingDisabled` to implement copying\nbehavior in a drop list.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDropListHasAnchor", + "isRequiredInput": false }, { "name": "dropped", "type": "EventEmitter>", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "output" ], "description": "Emits when the user drops an item inside the container.", - "jsdocTags": [] + "jsdocTags": [], + "outputAlias": "cdkDropListDropped" }, { "name": "entered", "type": "EventEmitter>", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "output" ], "description": "Emits when the user has moved a new drag item into this container.", - "jsdocTags": [] + "jsdocTags": [], + "outputAlias": "cdkDropListEntered" }, { "name": "exited", "type": "EventEmitter>", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "output" ], "description": "Emits when the user removes an item from the container\nby dragging it into another container.", - "jsdocTags": [] + "jsdocTags": [], + "outputAlias": "cdkDropListExited" }, { "name": "sorted", "type": "EventEmitter>", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "output" ], "description": "Emits as the user is swapping items while actively dragging.", - "jsdocTags": [] + "jsdocTags": [], + "outputAlias": "cdkDropListSorted" }, { "name": "addItem", @@ -1660,6 +1764,14 @@ "implements": [ "OnDestroy" ], + "isStandalone": true, + "selector": "[cdkDropList], cdk-drop-list", + "exportAs": [ + "cdkDropList" + ], + "aliases": [ + "cdkDropList" + ], "source": { "filePath": "/src/cdk/drag-drop/directives/drop-list.ts", "startLine": 36, @@ -2711,7 +2823,7 @@ }, { "name": "CDK_DROP_LIST", - "type": "any", + "type": "InjectionToken>", "entryType": "constant", "rawComment": "/**\n * Injection token that can be used to reference instances of `CdkDropList`. It serves as\n * alternative token to the actual `CdkDropList` class which could cause unnecessary\n * retention of the class and its directive metadata.\n */", "description": "Injection token that can be used to reference instances of `CdkDropList`. It serves as\nalternative token to the actual `CdkDropList` class which could cause unnecessary\nretention of the class and its directive metadata.", @@ -2757,7 +2869,7 @@ { "name": "element", "description": "Element to which to attach the drop list functionality.", - "type": "any", + "type": "HTMLElement | ElementRef", "isOptional": false, "isRestParam": false } @@ -2778,7 +2890,7 @@ { "name": "element", "description": "Element to which to attach the drop list functionality.", - "type": "any", + "type": "HTMLElement | ElementRef", "isOptional": false, "isRestParam": false } @@ -2828,11 +2940,11 @@ { "name": "CdkDrag", "isAbstract": false, - "entryType": "undecorated_class", + "entryType": "directive", "members": [ { "name": "element", - "type": "any", + "type": "ElementRef", "memberType": "property", "memberTags": [], "description": "", @@ -2840,7 +2952,7 @@ }, { "name": "dropContainer", - "type": "any", + "type": "CdkDropList", "memberType": "property", "memberTags": [], "description": "", @@ -2850,169 +2962,230 @@ "name": "data", "type": "T", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Arbitrary data to attach to this drag instance.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDragData", + "isRequiredInput": false }, { "name": "lockAxis", "type": "DragAxis | null", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Locks the position of the dragged element along the specified axis.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDragLockAxis", + "isRequiredInput": false }, { "name": "rootElementSelector", "type": "string", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Selector that will be used to determine the root draggable element, starting from\nthe `cdkDrag` element and going up the DOM. Passing an alternate root element is useful\nwhen trying to enable dragging on an element that you might not have access to.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDragRootElement", + "isRequiredInput": false }, { "name": "boundaryElement", - "type": "any", + "type": "string | HTMLElement | ElementRef", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Node or selector that will be used to determine the element to which the draggable's\nposition will be constrained. If a string is passed in, it'll be used as a selector that\nwill be matched starting from the element's parent and going up the DOM until a match\nhas been found.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDragBoundary", + "isRequiredInput": false }, { "name": "dragStartDelay", "type": "DragStartDelay", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Amount of milliseconds to wait after the user has put their\npointer down before starting to drag the element.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDragStartDelay", + "isRequiredInput": false }, { "name": "freeDragPosition", "type": "Point", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Sets the position of a `CdkDrag` that is outside of a drop container.\nCan be used to restore the element's position for a returning user.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDragFreeDragPosition", + "isRequiredInput": false }, { "name": "disabled", "type": "boolean", "memberType": "getter", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Whether starting to drag this element is disabled.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDragDisabled", + "isRequiredInput": false }, { "name": "disabled", "type": "boolean", "memberType": "setter", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDragDisabled", + "isRequiredInput": false }, { "name": "constrainPosition", "type": "DragConstrainPosition | undefined", "memberType": "property", "memberTags": [ - "optional" + "optional", + "input" ], "description": "Function that can be used to customize the logic of how the position of the drag item\nis limited while it's being dragged. Gets called with a point containing the current position\nof the user's pointer on the page, a reference to the item being dragged and its dimensions.\nShould return a point describing where the item should be rendered.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDragConstrainPosition", + "isRequiredInput": false }, { "name": "previewClass", "type": "string | string[]", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Class to be added to the preview element.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDragPreviewClass", + "isRequiredInput": false }, { "name": "previewContainer", - "type": "any", + "type": "PreviewContainer", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "Configures the place into which the preview of the item will be inserted. Can be configured\nglobally through `CDK_DROP_LIST`. Possible values:\n- `global` - Preview will be inserted at the bottom of the ``. The advantage is that\nyou don't have to worry about `overflow: hidden` or `z-index`, but the item won't retain\nits inherited styles.\n- `parent` - Preview will be inserted into the parent of the drag item. The advantage is that\ninherited styles will be preserved, but it may be clipped by `overflow: hidden` or not be\nvisible due to `z-index`. Furthermore, the preview is going to have an effect over selectors\nlike `:nth-child` and some flexbox configurations.\n- `ElementRef | HTMLElement` - Preview will be inserted into a specific element.\nSame advantages and disadvantages as `parent`.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDragPreviewContainer", + "isRequiredInput": false }, { "name": "scale", "type": "number", "memberType": "property", - "memberTags": [], + "memberTags": [ + "input" + ], "description": "If the parent of the dragged element has a `scale` transform, it can throw off the\npositioning when the user starts dragging. Use this input to notify the CDK of the scale.", - "jsdocTags": [] + "jsdocTags": [], + "inputAlias": "cdkDragScale", + "isRequiredInput": false }, { "name": "started", "type": "EventEmitter>", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "output" ], "description": "Emits when the user starts dragging the item.", - "jsdocTags": [] + "jsdocTags": [], + "outputAlias": "cdkDragStarted" }, { "name": "released", "type": "EventEmitter>", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "output" ], "description": "Emits when the user has released a drag item, before any animations have started.", - "jsdocTags": [] + "jsdocTags": [], + "outputAlias": "cdkDragReleased" }, { "name": "ended", "type": "EventEmitter>", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "output" ], "description": "Emits when the user stops dragging an item in the container.", - "jsdocTags": [] + "jsdocTags": [], + "outputAlias": "cdkDragEnded" }, { "name": "entered", "type": "EventEmitter>", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "output" ], "description": "Emits when the user has moved the item into a new container.", - "jsdocTags": [] + "jsdocTags": [], + "outputAlias": "cdkDragEntered" }, { "name": "exited", "type": "EventEmitter>", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "output" ], "description": "Emits when the user removes the item its container by dragging it into another container.", - "jsdocTags": [] + "jsdocTags": [], + "outputAlias": "cdkDragExited" }, { "name": "dropped", "type": "EventEmitter>", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "output" ], "description": "Emits when the user drops the item inside a container.", - "jsdocTags": [] + "jsdocTags": [], + "outputAlias": "cdkDragDropped" }, { "name": "moved", "type": "Observable>", "memberType": "property", "memberTags": [ - "readonly" + "readonly", + "output" ], "description": "Emits as the user is dragging the item. Use with caution,\nbecause this event will fire for every pixel that the user has dragged.", - "jsdocTags": [] + "jsdocTags": [], + "outputAlias": "cdkDragMoved" }, { "name": "getPlaceholderElement", @@ -3373,6 +3546,14 @@ "OnChanges", "OnDestroy" ], + "isStandalone": true, + "selector": "[cdkDrag]", + "exportAs": [ + "cdkDrag" + ], + "aliases": [ + "cdkDrag" + ], "source": { "filePath": "/src/cdk/drag-drop/directives/drag.ts", "startLine": 60, @@ -3508,7 +3689,7 @@ { "name": "element", "description": "", - "type": "any", + "type": "HTMLElement | ElementRef", "isOptional": false, "isRestParam": false }, @@ -3559,7 +3740,7 @@ }, { "name": "element", - "type": "any", + "type": "HTMLElement | ElementRef", "memberType": "property", "memberTags": [], "description": "Element that the drop list is attached to.", @@ -3631,7 +3812,7 @@ }, { "name": "beforeStarted", - "type": "any", + "type": "Subject", "memberType": "property", "memberTags": [ "readonly" @@ -3641,7 +3822,7 @@ }, { "name": "entered", - "type": "any", + "type": "Subject<{ item: DragRef; container: DropListRef; currentIndex: number; }>", "memberType": "property", "memberTags": [ "readonly" @@ -3651,7 +3832,7 @@ }, { "name": "exited", - "type": "any", + "type": "Subject<{ item: DragRef; container: DropListRef; }>", "memberType": "property", "memberTags": [ "readonly" @@ -3661,7 +3842,7 @@ }, { "name": "dropped", - "type": "any", + "type": "Subject<{ item: DragRef; currentIndex: number; previousIndex: number; container: DropListRef; previousContainer: DropListRef; isPointerOverContainer: boolean; distance: Point; dropPoint: Point; event: MouseEvent | TouchEvent; }>", "memberType": "property", "memberTags": [ "readonly" @@ -3671,7 +3852,7 @@ }, { "name": "sorted", - "type": "any", + "type": "Subject<{ previousIndex: number; currentIndex: number; container: DropListRef; item: DragRef; }>", "memberType": "property", "memberTags": [ "readonly" @@ -3681,7 +3862,7 @@ }, { "name": "receivingStarted", - "type": "any", + "type": "Subject<{ receiver: DropListRef; initiator: DropListRef; items: DragRef[]; }>", "memberType": "property", "memberTags": [ "readonly" @@ -3691,7 +3872,7 @@ }, { "name": "receivingStopped", - "type": "any", + "type": "Subject<{ receiver: DropListRef; initiator: DropListRef; }>", "memberType": "property", "memberTags": [ "readonly" @@ -5033,7 +5214,7 @@ { "name": "element", "description": "Element to which to attach the dragging functionality.", - "type": "any", + "type": "HTMLElement | ElementRef", "isOptional": false, "isRestParam": false }, @@ -5061,7 +5242,7 @@ { "name": "element", "description": "Element to which to attach the dragging functionality.", - "type": "any", + "type": "HTMLElement | ElementRef", "isOptional": false, "isRestParam": false }, @@ -5136,7 +5317,7 @@ { "name": "element", "description": "", - "type": "any", + "type": "HTMLElement | ElementRef", "isOptional": false, "isRestParam": false }, @@ -5249,7 +5430,7 @@ }, { "name": "beforeStarted", - "type": "any", + "type": "Subject", "memberType": "property", "memberTags": [ "readonly" @@ -5259,7 +5440,7 @@ }, { "name": "started", - "type": "any", + "type": "Subject<{ source: DragRef; event: MouseEvent | TouchEvent; }>", "memberType": "property", "memberTags": [ "readonly" @@ -5269,7 +5450,7 @@ }, { "name": "released", - "type": "any", + "type": "Subject<{ source: DragRef; event: MouseEvent | TouchEvent; }>", "memberType": "property", "memberTags": [ "readonly" @@ -5279,7 +5460,7 @@ }, { "name": "ended", - "type": "any", + "type": "Subject<{ source: DragRef; distance: Point; dropPoint: Point; event: MouseEvent | TouchEvent; }>", "memberType": "property", "memberTags": [ "readonly" @@ -5289,7 +5470,7 @@ }, { "name": "entered", - "type": "any", + "type": "Subject<{ container: DropListRef; item: DragRef; currentIndex: number; }>", "memberType": "property", "memberTags": [ "readonly" @@ -5299,7 +5480,7 @@ }, { "name": "exited", - "type": "any", + "type": "Subject<{ container: DropListRef; item: DragRef; }>", "memberType": "property", "memberTags": [ "readonly" @@ -5309,7 +5490,7 @@ }, { "name": "dropped", - "type": "any", + "type": "Subject<{ previousIndex: number; currentIndex: number; item: DragRef; container: DropListRef; previousContainer: DropListRef; distance: Point; dropPoint: Point; isPointerOverContainer: boolean; event: MouseEvent | TouchEvent; }>", "memberType": "property", "memberTags": [ "readonly" @@ -5458,7 +5639,7 @@ { "name": "handles", "description": "", - "type": "any[]", + "type": "(HTMLElement | ElementRef)[]", "isOptional": false, "isRestParam": false } @@ -5472,7 +5653,7 @@ { "name": "handles", "description": "", - "type": "any[]", + "type": "(HTMLElement | ElementRef)[]", "isOptional": false, "isRestParam": false } @@ -5635,7 +5816,7 @@ { "name": "rootElement", "description": "", - "type": "any", + "type": "HTMLElement | ElementRef", "isOptional": false, "isRestParam": false } @@ -5649,7 +5830,7 @@ { "name": "rootElement", "description": "", - "type": "any", + "type": "HTMLElement | ElementRef", "isOptional": false, "isRestParam": false } @@ -5684,7 +5865,7 @@ { "name": "boundaryElement", "description": "", - "type": "any", + "type": "HTMLElement | ElementRef | null", "isOptional": false, "isRestParam": false } @@ -5698,7 +5879,7 @@ { "name": "boundaryElement", "description": "", - "type": "any", + "type": "HTMLElement | ElementRef | null", "isOptional": false, "isRestParam": false } @@ -6193,7 +6374,7 @@ { "name": "value", "description": "Container into which to insert the preview.", - "type": "any", + "type": "PreviewContainer", "isOptional": false, "isRestParam": false } @@ -6207,7 +6388,7 @@ { "name": "value", "description": "Container into which to insert the preview.", - "type": "any", + "type": "PreviewContainer", "isOptional": false, "isRestParam": false } diff --git a/adev/src/content/cdk/cdk_testing_protractor.json b/adev/src/content/cdk/cdk_testing_protractor.json index 9ef6126b8926..a8d47d303418 100755 --- a/adev/src/content/cdk/cdk_testing_protractor.json +++ b/adev/src/content/cdk/cdk_testing_protractor.json @@ -350,6 +350,1454 @@ "protected" ] }, + { + "name": "rawRootElement", + "type": "E", + "memberType": "property", + "memberTags": [ + "protected", + "override" + ], + "description": "The native root element of this `HarnessEnvironment`.", + "jsdocTags": [] + }, + { + "name": "rootElement", + "type": "TestElement", + "memberType": "getter", + "memberTags": [ + "override" + ], + "description": "The root element of this `HarnessEnvironment` as a `TestElement`.", + "jsdocTags": [] + }, + { + "name": "rootElement", + "type": "TestElement", + "memberType": "setter", + "memberTags": [ + "override" + ], + "description": "", + "jsdocTags": [] + }, + { + "name": "documentRootLocatorFactory", + "signatures": [ + { + "name": "documentRootLocatorFactory", + "entryType": "function", + "description": "Gets a locator factory rooted at the document root.", + "generics": [], + "isNewType": false, + "jsdocTags": [], + "params": [], + "rawComment": "/** Gets a locator factory rooted at the document root. */", + "returnType": "LocatorFactory" + } + ], + "implementation": { + "params": [], + "isNewType": false, + "returnType": "LocatorFactory", + "generics": [], + "name": "documentRootLocatorFactory", + "description": "Gets a locator factory rooted at the document root.", + "entryType": "function", + "jsdocTags": [], + "rawComment": "/** Gets a locator factory rooted at the document root. */" + }, + "entryType": "function", + "description": "Gets a locator factory rooted at the document root.", + "jsdocTags": [], + "rawComment": "/** Gets a locator factory rooted at the document root. */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "locatorFor", + "signatures": [ + { + "name": "locatorFor", + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorFor('span')() // Throws because the `Promise` rejects\n```", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\neach query." + } + ], + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorFor('span')() // Throws because the `Promise` rejects\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\n * each query.\n */", + "returnType": "() => Promise>" + } + ], + "implementation": { + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "isNewType": false, + "returnType": "() => Promise>", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "name": "locatorFor", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorFor('span')() // Throws because the `Promise` rejects\n```", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\neach query." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorFor('span')() // Throws because the `Promise` rejects\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\n * each query.\n */" + }, + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorFor('span')() // Throws because the `Promise` rejects\n```", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\neach query." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorFor('span')() // Throws because the `Promise` rejects\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\n * each query.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "locatorForOptional", + "signatures": [ + { + "name": "locatorForOptional", + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironmnet`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorForOptional('span')() // Gets `null`\n```", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\nresult types for each query or null." + } + ], + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironmnet`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorForOptional('span')() // Gets `null`\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\n * result types for each query or null.\n */", + "returnType": "() => Promise | null>" + } + ], + "implementation": { + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "isNewType": false, + "returnType": "() => Promise | null>", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "name": "locatorForOptional", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironmnet`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorForOptional('span')() // Gets `null`\n```", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\nresult types for each query or null." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironmnet`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorForOptional('span')() // Gets `null`\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\n * result types for each query or null.\n */" + }, + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironmnet`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorForOptional('span')() // Gets `null`\n```", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\nresult types for each query or null." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironmnet`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorForOptional('span')() // Gets `null`\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\n * result types for each query or null.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "locatorForAll", + "signatures": [ + { + "name": "locatorForAll", + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\nor elements under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n`IdIsD1Harness.hostSelector` is `'#d1'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\n// Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\nawait lf.locatorForAll(DivHarness, 'div')()\n// Gets [TestElement for #d1, TestElement for #d2]\nawait lf.locatorForAll('div', '#d1')()\n// Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\nawait lf.locatorForAll(DivHarness, IdIsD1Harness)()\n// Gets []\nawait lf.locatorForAll('span')()\n```", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for all\nelements and harnesses matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If an element matches more than\none `ComponentHarness` class, the locator gets an instance of each for the same element. If\nan element matches multiple `string` selectors, only one `TestElement` instance is returned\nfor that element. The type that the `Promise` resolves to is an array where each element is\nthe union of all result types for each query." + } + ], + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\n * or elements under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n * `IdIsD1Harness.hostSelector` is `'#d1'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * // Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\n * await lf.locatorForAll(DivHarness, 'div')()\n * // Gets [TestElement for #d1, TestElement for #d2]\n * await lf.locatorForAll('div', '#d1')()\n * // Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\n * await lf.locatorForAll(DivHarness, IdIsD1Harness)()\n * // Gets []\n * await lf.locatorForAll('span')()\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for all\n * elements and harnesses matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If an element matches more than\n * one `ComponentHarness` class, the locator gets an instance of each for the same element. If\n * an element matches multiple `string` selectors, only one `TestElement` instance is returned\n * for that element. The type that the `Promise` resolves to is an array where each element is\n * the union of all result types for each query.\n */", + "returnType": "() => Promise[]>" + } + ], + "implementation": { + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "isNewType": false, + "returnType": "() => Promise[]>", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "name": "locatorForAll", + "description": "Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\nor elements under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n`IdIsD1Harness.hostSelector` is `'#d1'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\n// Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\nawait lf.locatorForAll(DivHarness, 'div')()\n// Gets [TestElement for #d1, TestElement for #d2]\nawait lf.locatorForAll('div', '#d1')()\n// Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\nawait lf.locatorForAll(DivHarness, IdIsD1Harness)()\n// Gets []\nawait lf.locatorForAll('span')()\n```", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for all\nelements and harnesses matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If an element matches more than\none `ComponentHarness` class, the locator gets an instance of each for the same element. If\nan element matches multiple `string` selectors, only one `TestElement` instance is returned\nfor that element. The type that the `Promise` resolves to is an array where each element is\nthe union of all result types for each query." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\n * or elements under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n * `IdIsD1Harness.hostSelector` is `'#d1'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * // Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\n * await lf.locatorForAll(DivHarness, 'div')()\n * // Gets [TestElement for #d1, TestElement for #d2]\n * await lf.locatorForAll('div', '#d1')()\n * // Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\n * await lf.locatorForAll(DivHarness, IdIsD1Harness)()\n * // Gets []\n * await lf.locatorForAll('span')()\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for all\n * elements and harnesses matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If an element matches more than\n * one `ComponentHarness` class, the locator gets an instance of each for the same element. If\n * an element matches multiple `string` selectors, only one `TestElement` instance is returned\n * for that element. The type that the `Promise` resolves to is an array where each element is\n * the union of all result types for each query.\n */" + }, + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\nor elements under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n`IdIsD1Harness.hostSelector` is `'#d1'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\n// Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\nawait lf.locatorForAll(DivHarness, 'div')()\n// Gets [TestElement for #d1, TestElement for #d2]\nawait lf.locatorForAll('div', '#d1')()\n// Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\nawait lf.locatorForAll(DivHarness, IdIsD1Harness)()\n// Gets []\nawait lf.locatorForAll('span')()\n```", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for all\nelements and harnesses matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If an element matches more than\none `ComponentHarness` class, the locator gets an instance of each for the same element. If\nan element matches multiple `string` selectors, only one `TestElement` instance is returned\nfor that element. The type that the `Promise` resolves to is an array where each element is\nthe union of all result types for each query." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\n * or elements under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n * `IdIsD1Harness.hostSelector` is `'#d1'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * // Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\n * await lf.locatorForAll(DivHarness, 'div')()\n * // Gets [TestElement for #d1, TestElement for #d2]\n * await lf.locatorForAll('div', '#d1')()\n * // Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\n * await lf.locatorForAll(DivHarness, IdIsD1Harness)()\n * // Gets []\n * await lf.locatorForAll('span')()\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for all\n * elements and harnesses matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If an element matches more than\n * one `ComponentHarness` class, the locator gets an instance of each for the same element. If\n * an element matches multiple `string` selectors, only one `TestElement` instance is returned\n * for that element. The type that the `Promise` resolves to is an array where each element is\n * the union of all result types for each query.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "rootHarnessLoader", + "signatures": [ + { + "name": "rootHarnessLoader", + "entryType": "function", + "description": "", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`." + } + ], + "params": [], + "rawComment": "/** @return A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`. */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "rootHarnessLoader", + "description": "", + "entryType": "function", + "jsdocTags": [ + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`." + } + ], + "rawComment": "/** @return A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`. */" + }, + "entryType": "function", + "description": "", + "jsdocTags": [ + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`." + } + ], + "rawComment": "/** @return A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`. */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "harnessLoaderFor", + "signatures": [ + { + "name": "harnessLoaderFor", + "entryType": "function", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector." + }, + { + "name": "throws", + "comment": "If no matching element is found for the given selector." + } + ], + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector.\n * @throws If no matching element is found for the given selector.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "harnessLoaderFor", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector." + }, + { + "name": "throws", + "comment": "If no matching element is found for the given selector." + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector.\n * @throws If no matching element is found for the given selector.\n */" + }, + "entryType": "function", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector." + }, + { + "name": "throws", + "comment": "If no matching element is found for the given selector." + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector.\n * @throws If no matching element is found for the given selector.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "harnessLoaderForOptional", + "signatures": [ + { + "name": "harnessLoaderForOptional", + "entryType": "function", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector, or null if\nno matching element is found." + } + ], + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector, or null if\n * no matching element is found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "harnessLoaderForOptional", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector, or null if\nno matching element is found." + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector, or null if\n * no matching element is found.\n */" + }, + "entryType": "function", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector, or null if\nno matching element is found." + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector, or null if\n * no matching element is found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "harnessLoaderForAll", + "signatures": [ + { + "name": "harnessLoaderForAll", + "entryType": "function", + "description": "Gets a list of `HarnessLoader` instances, one for each matching element.", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`, one rooted at each element matching the given selector." + } + ], + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Gets a list of `HarnessLoader` instances, one for each matching element.\n * @param selector The selector for the root element.\n * @return A list of `HarnessLoader`, one rooted at each element matching the given selector.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "harnessLoaderForAll", + "description": "Gets a list of `HarnessLoader` instances, one for each matching element.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`, one rooted at each element matching the given selector." + } + ], + "rawComment": "/**\n * Gets a list of `HarnessLoader` instances, one for each matching element.\n * @param selector The selector for the root element.\n * @return A list of `HarnessLoader`, one rooted at each element matching the given selector.\n */" + }, + "entryType": "function", + "description": "Gets a list of `HarnessLoader` instances, one for each matching element.", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`, one rooted at each element matching the given selector." + } + ], + "rawComment": "/**\n * Gets a list of `HarnessLoader` instances, one for each matching element.\n * @param selector The selector for the root element.\n * @return A list of `HarnessLoader`, one rooted at each element matching the given selector.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getHarness", + "signatures": [ + { + "name": "getHarness", + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, an error is thrown.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, an error is thrown.\n * @param query A query for a harness to create\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "getHarness", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, an error is thrown.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, an error is thrown.\n * @param query A query for a harness to create\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */" + }, + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, an error is thrown.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, an error is thrown.\n * @param query A query for a harness to create\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getHarnessOrNull", + "signatures": [ + { + "name": "getHarnessOrNull", + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, null is returned.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type (or null if not found)." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, null is returned.\n * @param query A query for a harness to create\n * @return An instance of the given harness type (or null if not found).\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "getHarnessOrNull", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, null is returned.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type (or null if not found)." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, null is returned.\n * @param query A query for a harness to create\n * @return An instance of the given harness type (or null if not found).\n */" + }, + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, null is returned.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type (or null if not found)." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, null is returned.\n * @param query A query for a harness to create\n * @return An instance of the given harness type (or null if not found).\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getHarnessAtIndex", + "signatures": [ + { + "name": "getHarnessAtIndex", + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type and index\nunder the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\ninstance. The index specifies the offset of the component to find. If no matching\ncomponent is found at that index, an error is thrown.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "param", + "comment": "The zero-indexed offset of the component to find" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + }, + { + "name": "offset", + "description": "", + "type": "number", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type and index\n * under the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\n * instance. The index specifies the offset of the component to find. If no matching\n * component is found at that index, an error is thrown.\n * @param query A query for a harness to create\n * @param index The zero-indexed offset of the component to find\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + }, + { + "name": "offset", + "description": "", + "type": "number", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "getHarnessAtIndex", + "description": "Searches for an instance of the component corresponding to the given harness type and index\nunder the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\ninstance. The index specifies the offset of the component to find. If no matching\ncomponent is found at that index, an error is thrown.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "param", + "comment": "The zero-indexed offset of the component to find" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type and index\n * under the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\n * instance. The index specifies the offset of the component to find. If no matching\n * component is found at that index, an error is thrown.\n * @param query A query for a harness to create\n * @param index The zero-indexed offset of the component to find\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */" + }, + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type and index\nunder the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\ninstance. The index specifies the offset of the component to find. If no matching\ncomponent is found at that index, an error is thrown.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "param", + "comment": "The zero-indexed offset of the component to find" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type and index\n * under the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\n * instance. The index specifies the offset of the component to find. If no matching\n * component is found at that index, an error is thrown.\n * @param query A query for a harness to create\n * @param index The zero-indexed offset of the component to find\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getAllHarnesses", + "signatures": [ + { + "name": "getAllHarnesses", + "entryType": "function", + "description": "Searches for all instances of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A list instances of the given harness type." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for all instances of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.\n * @param query A query for a harness to create\n * @return A list instances of the given harness type.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "getAllHarnesses", + "description": "Searches for all instances of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A list instances of the given harness type." + } + ], + "rawComment": "/**\n * Searches for all instances of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.\n * @param query A query for a harness to create\n * @return A list instances of the given harness type.\n */" + }, + "entryType": "function", + "description": "Searches for all instances of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A list instances of the given harness type." + } + ], + "rawComment": "/**\n * Searches for all instances of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.\n * @param query A query for a harness to create\n * @return A list instances of the given harness type.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "countHarnesses", + "signatures": [ + { + "name": "countHarnesses", + "entryType": "function", + "description": "Searches for all instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns the number that were found.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "The number of instances that were found." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for all instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns the number that were found.\n * @param query A query for a harness to create\n * @return The number of instances that were found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "countHarnesses", + "description": "Searches for all instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns the number that were found.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "The number of instances that were found." + } + ], + "rawComment": "/**\n * Searches for all instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns the number that were found.\n * @param query A query for a harness to create\n * @return The number of instances that were found.\n */" + }, + "entryType": "function", + "description": "Searches for all instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns the number that were found.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "The number of instances that were found." + } + ], + "rawComment": "/**\n * Searches for all instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns the number that were found.\n * @param query A query for a harness to create\n * @return The number of instances that were found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "hasHarness", + "signatures": [ + { + "name": "hasHarness", + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A boolean indicating if an instance was found." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.\n * @param query A query for a harness to create\n * @return A boolean indicating if an instance was found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "hasHarness", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A boolean indicating if an instance was found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.\n * @param query A query for a harness to create\n * @return A boolean indicating if an instance was found.\n */" + }, + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A boolean indicating if an instance was found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.\n * @param query A query for a harness to create\n * @return A boolean indicating if an instance was found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getChildLoader", + "signatures": [ + { + "name": "getChildLoader", + "entryType": "function", + "description": "Searches for an element with the given selector under the evironment's root element,\nand returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\nselector, the first is used. If no elements match, an error is thrown.", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the element matching the given selector." + }, + { + "name": "throws", + "comment": "If a matching element can't be found." + } + ], + "params": [ + { + "name": "selector", + "description": "The selector for the root element of the new `HarnessLoader`", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for an element with the given selector under the evironment's root element,\n * and returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\n * selector, the first is used. If no elements match, an error is thrown.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A `HarnessLoader` rooted at the element matching the given selector.\n * @throws If a matching element can't be found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "selector", + "description": "The selector for the root element of the new `HarnessLoader`", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "getChildLoader", + "description": "Searches for an element with the given selector under the evironment's root element,\nand returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\nselector, the first is used. If no elements match, an error is thrown.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the element matching the given selector." + }, + { + "name": "throws", + "comment": "If a matching element can't be found." + } + ], + "rawComment": "/**\n * Searches for an element with the given selector under the evironment's root element,\n * and returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\n * selector, the first is used. If no elements match, an error is thrown.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A `HarnessLoader` rooted at the element matching the given selector.\n * @throws If a matching element can't be found.\n */" + }, + "entryType": "function", + "description": "Searches for an element with the given selector under the evironment's root element,\nand returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\nselector, the first is used. If no elements match, an error is thrown.", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the element matching the given selector." + }, + { + "name": "throws", + "comment": "If a matching element can't be found." + } + ], + "rawComment": "/**\n * Searches for an element with the given selector under the evironment's root element,\n * and returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\n * selector, the first is used. If no elements match, an error is thrown.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A `HarnessLoader` rooted at the element matching the given selector.\n * @throws If a matching element can't be found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getAllChildLoaders", + "signatures": [ + { + "name": "getAllChildLoaders", + "entryType": "function", + "description": "Searches for all elements with the given selector under the environment's root element,\nand returns an array of `HarnessLoader`s, one for each matching element, rooted at that\nelement.", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`s, one for each matching element, rooted at that element." + } + ], + "params": [ + { + "name": "selector", + "description": "The selector for the root element of the new `HarnessLoader`", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for all elements with the given selector under the environment's root element,\n * and returns an array of `HarnessLoader`s, one for each matching element, rooted at that\n * element.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A list of `HarnessLoader`s, one for each matching element, rooted at that element.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "selector", + "description": "The selector for the root element of the new `HarnessLoader`", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "getAllChildLoaders", + "description": "Searches for all elements with the given selector under the environment's root element,\nand returns an array of `HarnessLoader`s, one for each matching element, rooted at that\nelement.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`s, one for each matching element, rooted at that element." + } + ], + "rawComment": "/**\n * Searches for all elements with the given selector under the environment's root element,\n * and returns an array of `HarnessLoader`s, one for each matching element, rooted at that\n * element.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A list of `HarnessLoader`s, one for each matching element, rooted at that element.\n */" + }, + "entryType": "function", + "description": "Searches for all elements with the given selector under the environment's root element,\nand returns an array of `HarnessLoader`s, one for each matching element, rooted at that\nelement.", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`s, one for each matching element, rooted at that element." + } + ], + "rawComment": "/**\n * Searches for all elements with the given selector under the environment's root element,\n * and returns an array of `HarnessLoader`s, one for each matching element, rooted at that\n * element.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A list of `HarnessLoader`s, one for each matching element, rooted at that element.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "createComponentHarness", + "signatures": [ + { + "name": "createComponentHarness", + "entryType": "function", + "description": "Creates a `ComponentHarness` for the given harness type with the given raw host element.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [], + "params": [ + { + "name": "harnessType", + "description": "", + "type": "ComponentHarnessConstructor", + "isOptional": false, + "isRestParam": false + }, + { + "name": "element", + "description": "", + "type": "E", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/** Creates a `ComponentHarness` for the given harness type with the given raw host element. */", + "returnType": "T" + } + ], + "implementation": { + "params": [ + { + "name": "harnessType", + "description": "", + "type": "ComponentHarnessConstructor", + "isOptional": false, + "isRestParam": false + }, + { + "name": "element", + "description": "", + "type": "E", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "T", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "createComponentHarness", + "description": "Creates a `ComponentHarness` for the given harness type with the given raw host element.", + "entryType": "function", + "jsdocTags": [], + "rawComment": "/** Creates a `ComponentHarness` for the given harness type with the given raw host element. */" + }, + "entryType": "function", + "description": "Creates a `ComponentHarness` for the given harness type with the given raw host element.", + "jsdocTags": [], + "rawComment": "/** Creates a `ComponentHarness` for the given harness type with the given raw host element. */", + "memberType": "method", + "memberTags": [ + "protected", + "override" + ] + }, { "name": "loader", "signatures": [ @@ -588,7 +2036,7 @@ { "name": "modifiers", "description": "", - "type": "any", + "type": "ModifierKeys | undefined", "isOptional": true, "isRestParam": false } @@ -614,7 +2062,7 @@ { "name": "modifiers", "description": "", - "type": "any", + "type": "ModifierKeys | undefined", "isOptional": true, "isRestParam": false } @@ -660,7 +2108,7 @@ { "name": "modifiers", "description": "Modifier keys held while clicking", - "type": "any", + "type": "ModifierKeys | undefined", "isOptional": true, "isRestParam": false } @@ -674,7 +2122,7 @@ { "name": "args", "description": "", - "type": "[any?] | [\"center\", any?] | [number, number, any?]", + "type": "[(ModifierKeys | undefined)?] | [\"center\", (ModifierKeys | undefined)?] | [number, number, (ModifierKeys | undefined)?]", "isOptional": false, "isRestParam": true } @@ -736,7 +2184,7 @@ { "name": "modifiers", "description": "Modifier keys held while clicking", - "type": "any", + "type": "ModifierKeys | undefined", "isOptional": true, "isRestParam": false } @@ -750,7 +2198,7 @@ { "name": "args", "description": "", - "type": "[any?] | [\"center\", any?] | [number, number, any?]", + "type": "[(ModifierKeys | undefined)?] | [\"center\", (ModifierKeys | undefined)?] | [number, number, (ModifierKeys | undefined)?]", "isOptional": false, "isRestParam": true } @@ -946,7 +2394,7 @@ { "name": "keys", "description": "", - "type": "any[]", + "type": "(string | TestKey)[]", "isOptional": false, "isRestParam": true } @@ -972,7 +2420,7 @@ { "name": "keys", "description": "", - "type": "any[]", + "type": "(string | TestKey)[]", "isOptional": false, "isRestParam": true } @@ -1026,7 +2474,7 @@ { "name": "options", "description": "Options that affect what text is included.", - "type": "any", + "type": "TextOptions | undefined", "isOptional": true, "isRestParam": false } @@ -1040,7 +2488,7 @@ { "name": "options", "description": "Options that affect what text is included.", - "type": "any", + "type": "TextOptions | undefined", "isOptional": true, "isRestParam": false } @@ -1660,6 +3108,86 @@ "ProtractorHarnessEnvironment.getAllRawElements", "@angular/cdk/testing/protractor" ], + [ + "ProtractorHarnessEnvironment.rawRootElement", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.rootElement", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.rootElement", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.documentRootLocatorFactory", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.locatorFor", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.locatorForOptional", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.locatorForAll", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.rootHarnessLoader", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.harnessLoaderFor", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.harnessLoaderForOptional", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.harnessLoaderForAll", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.getHarness", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.getHarnessOrNull", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.getHarnessAtIndex", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.getAllHarnesses", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.countHarnesses", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.hasHarness", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.getChildLoader", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.getAllChildLoaders", + "@angular/cdk/testing/protractor" + ], + [ + "ProtractorHarnessEnvironment.createComponentHarness", + "@angular/cdk/testing/protractor" + ], [ "ProtractorHarnessEnvironment.loader", "@angular/cdk/testing/protractor" diff --git a/adev/src/content/cdk/cdk_testing_selenium_webdriver.json b/adev/src/content/cdk/cdk_testing_selenium_webdriver.json index d6e10bcd809b..7f8165a6d2ec 100755 --- a/adev/src/content/cdk/cdk_testing_selenium_webdriver.json +++ b/adev/src/content/cdk/cdk_testing_selenium_webdriver.json @@ -125,7 +125,7 @@ { "name": "modifiers", "description": "", - "type": "any", + "type": "ModifierKeys | undefined", "isOptional": true, "isRestParam": false } @@ -151,7 +151,7 @@ { "name": "modifiers", "description": "", - "type": "any", + "type": "ModifierKeys | undefined", "isOptional": true, "isRestParam": false } @@ -197,7 +197,7 @@ { "name": "modifiers", "description": "Modifier keys held while clicking", - "type": "any", + "type": "ModifierKeys | undefined", "isOptional": true, "isRestParam": false } @@ -211,7 +211,7 @@ { "name": "args", "description": "", - "type": "[any?] | [\"center\", any?] | [number, number, any?]", + "type": "[(ModifierKeys | undefined)?] | [\"center\", (ModifierKeys | undefined)?] | [number, number, (ModifierKeys | undefined)?]", "isOptional": false, "isRestParam": true } @@ -273,7 +273,7 @@ { "name": "modifiers", "description": "Modifier keys held while clicking", - "type": "any", + "type": "ModifierKeys | undefined", "isOptional": true, "isRestParam": false } @@ -287,7 +287,7 @@ { "name": "args", "description": "", - "type": "[any?] | [\"center\", any?] | [number, number, any?]", + "type": "[(ModifierKeys | undefined)?] | [\"center\", (ModifierKeys | undefined)?] | [number, number, (ModifierKeys | undefined)?]", "isOptional": false, "isRestParam": true } @@ -483,7 +483,7 @@ { "name": "keys", "description": "", - "type": "any[]", + "type": "(string | TestKey)[]", "isOptional": false, "isRestParam": true } @@ -509,7 +509,7 @@ { "name": "keys", "description": "", - "type": "any[]", + "type": "(string | TestKey)[]", "isOptional": false, "isRestParam": true } @@ -563,7 +563,7 @@ { "name": "options", "description": "Options that affect what text is included.", - "type": "any", + "type": "TextOptions | undefined", "isOptional": true, "isRestParam": false } @@ -577,7 +577,7 @@ { "name": "options", "description": "Options that affect what text is included.", - "type": "any", + "type": "TextOptions | undefined", "isOptional": true, "isRestParam": false } @@ -1523,6 +1523,1454 @@ "protected" ] }, + { + "name": "rawRootElement", + "type": "E", + "memberType": "property", + "memberTags": [ + "protected", + "override" + ], + "description": "The native root element of this `HarnessEnvironment`.", + "jsdocTags": [] + }, + { + "name": "rootElement", + "type": "TestElement", + "memberType": "getter", + "memberTags": [ + "override" + ], + "description": "The root element of this `HarnessEnvironment` as a `TestElement`.", + "jsdocTags": [] + }, + { + "name": "rootElement", + "type": "TestElement", + "memberType": "setter", + "memberTags": [ + "override" + ], + "description": "", + "jsdocTags": [] + }, + { + "name": "documentRootLocatorFactory", + "signatures": [ + { + "name": "documentRootLocatorFactory", + "entryType": "function", + "description": "Gets a locator factory rooted at the document root.", + "generics": [], + "isNewType": false, + "jsdocTags": [], + "params": [], + "rawComment": "/** Gets a locator factory rooted at the document root. */", + "returnType": "LocatorFactory" + } + ], + "implementation": { + "params": [], + "isNewType": false, + "returnType": "LocatorFactory", + "generics": [], + "name": "documentRootLocatorFactory", + "description": "Gets a locator factory rooted at the document root.", + "entryType": "function", + "jsdocTags": [], + "rawComment": "/** Gets a locator factory rooted at the document root. */" + }, + "entryType": "function", + "description": "Gets a locator factory rooted at the document root.", + "jsdocTags": [], + "rawComment": "/** Gets a locator factory rooted at the document root. */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "locatorFor", + "signatures": [ + { + "name": "locatorFor", + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorFor('span')() // Throws because the `Promise` rejects\n```", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\neach query." + } + ], + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorFor('span')() // Throws because the `Promise` rejects\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\n * each query.\n */", + "returnType": "() => Promise>" + } + ], + "implementation": { + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "isNewType": false, + "returnType": "() => Promise>", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "name": "locatorFor", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorFor('span')() // Throws because the `Promise` rejects\n```", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\neach query." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorFor('span')() // Throws because the `Promise` rejects\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\n * each query.\n */" + }, + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorFor('span')() // Throws because the `Promise` rejects\n```", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\neach query." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorFor('span')() // Throws because the `Promise` rejects\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\n * each query.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "locatorForOptional", + "signatures": [ + { + "name": "locatorForOptional", + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironmnet`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorForOptional('span')() // Gets `null`\n```", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\nresult types for each query or null." + } + ], + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironmnet`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorForOptional('span')() // Gets `null`\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\n * result types for each query or null.\n */", + "returnType": "() => Promise | null>" + } + ], + "implementation": { + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "isNewType": false, + "returnType": "() => Promise | null>", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "name": "locatorForOptional", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironmnet`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorForOptional('span')() // Gets `null`\n```", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\nresult types for each query or null." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironmnet`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorForOptional('span')() // Gets `null`\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\n * result types for each query or null.\n */" + }, + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironmnet`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorForOptional('span')() // Gets `null`\n```", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\nresult types for each query or null." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironmnet`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorForOptional('span')() // Gets `null`\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\n * result types for each query or null.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "locatorForAll", + "signatures": [ + { + "name": "locatorForAll", + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\nor elements under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n`IdIsD1Harness.hostSelector` is `'#d1'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\n// Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\nawait lf.locatorForAll(DivHarness, 'div')()\n// Gets [TestElement for #d1, TestElement for #d2]\nawait lf.locatorForAll('div', '#d1')()\n// Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\nawait lf.locatorForAll(DivHarness, IdIsD1Harness)()\n// Gets []\nawait lf.locatorForAll('span')()\n```", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for all\nelements and harnesses matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If an element matches more than\none `ComponentHarness` class, the locator gets an instance of each for the same element. If\nan element matches multiple `string` selectors, only one `TestElement` instance is returned\nfor that element. The type that the `Promise` resolves to is an array where each element is\nthe union of all result types for each query." + } + ], + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\n * or elements under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n * `IdIsD1Harness.hostSelector` is `'#d1'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * // Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\n * await lf.locatorForAll(DivHarness, 'div')()\n * // Gets [TestElement for #d1, TestElement for #d2]\n * await lf.locatorForAll('div', '#d1')()\n * // Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\n * await lf.locatorForAll(DivHarness, IdIsD1Harness)()\n * // Gets []\n * await lf.locatorForAll('span')()\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for all\n * elements and harnesses matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If an element matches more than\n * one `ComponentHarness` class, the locator gets an instance of each for the same element. If\n * an element matches multiple `string` selectors, only one `TestElement` instance is returned\n * for that element. The type that the `Promise` resolves to is an array where each element is\n * the union of all result types for each query.\n */", + "returnType": "() => Promise[]>" + } + ], + "implementation": { + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "isNewType": false, + "returnType": "() => Promise[]>", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "name": "locatorForAll", + "description": "Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\nor elements under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n`IdIsD1Harness.hostSelector` is `'#d1'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\n// Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\nawait lf.locatorForAll(DivHarness, 'div')()\n// Gets [TestElement for #d1, TestElement for #d2]\nawait lf.locatorForAll('div', '#d1')()\n// Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\nawait lf.locatorForAll(DivHarness, IdIsD1Harness)()\n// Gets []\nawait lf.locatorForAll('span')()\n```", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for all\nelements and harnesses matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If an element matches more than\none `ComponentHarness` class, the locator gets an instance of each for the same element. If\nan element matches multiple `string` selectors, only one `TestElement` instance is returned\nfor that element. The type that the `Promise` resolves to is an array where each element is\nthe union of all result types for each query." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\n * or elements under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n * `IdIsD1Harness.hostSelector` is `'#d1'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * // Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\n * await lf.locatorForAll(DivHarness, 'div')()\n * // Gets [TestElement for #d1, TestElement for #d2]\n * await lf.locatorForAll('div', '#d1')()\n * // Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\n * await lf.locatorForAll(DivHarness, IdIsD1Harness)()\n * // Gets []\n * await lf.locatorForAll('span')()\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for all\n * elements and harnesses matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If an element matches more than\n * one `ComponentHarness` class, the locator gets an instance of each for the same element. If\n * an element matches multiple `string` selectors, only one `TestElement` instance is returned\n * for that element. The type that the `Promise` resolves to is an array where each element is\n * the union of all result types for each query.\n */" + }, + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\nor elements under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n`IdIsD1Harness.hostSelector` is `'#d1'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\n// Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\nawait lf.locatorForAll(DivHarness, 'div')()\n// Gets [TestElement for #d1, TestElement for #d2]\nawait lf.locatorForAll('div', '#d1')()\n// Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\nawait lf.locatorForAll(DivHarness, IdIsD1Harness)()\n// Gets []\nawait lf.locatorForAll('span')()\n```", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for all\nelements and harnesses matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If an element matches more than\none `ComponentHarness` class, the locator gets an instance of each for the same element. If\nan element matches multiple `string` selectors, only one `TestElement` instance is returned\nfor that element. The type that the `Promise` resolves to is an array where each element is\nthe union of all result types for each query." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\n * or elements under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n * `IdIsD1Harness.hostSelector` is `'#d1'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * // Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\n * await lf.locatorForAll(DivHarness, 'div')()\n * // Gets [TestElement for #d1, TestElement for #d2]\n * await lf.locatorForAll('div', '#d1')()\n * // Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\n * await lf.locatorForAll(DivHarness, IdIsD1Harness)()\n * // Gets []\n * await lf.locatorForAll('span')()\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for all\n * elements and harnesses matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If an element matches more than\n * one `ComponentHarness` class, the locator gets an instance of each for the same element. If\n * an element matches multiple `string` selectors, only one `TestElement` instance is returned\n * for that element. The type that the `Promise` resolves to is an array where each element is\n * the union of all result types for each query.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "rootHarnessLoader", + "signatures": [ + { + "name": "rootHarnessLoader", + "entryType": "function", + "description": "", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`." + } + ], + "params": [], + "rawComment": "/** @return A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`. */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "rootHarnessLoader", + "description": "", + "entryType": "function", + "jsdocTags": [ + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`." + } + ], + "rawComment": "/** @return A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`. */" + }, + "entryType": "function", + "description": "", + "jsdocTags": [ + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`." + } + ], + "rawComment": "/** @return A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`. */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "harnessLoaderFor", + "signatures": [ + { + "name": "harnessLoaderFor", + "entryType": "function", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector." + }, + { + "name": "throws", + "comment": "If no matching element is found for the given selector." + } + ], + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector.\n * @throws If no matching element is found for the given selector.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "harnessLoaderFor", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector." + }, + { + "name": "throws", + "comment": "If no matching element is found for the given selector." + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector.\n * @throws If no matching element is found for the given selector.\n */" + }, + "entryType": "function", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector." + }, + { + "name": "throws", + "comment": "If no matching element is found for the given selector." + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector.\n * @throws If no matching element is found for the given selector.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "harnessLoaderForOptional", + "signatures": [ + { + "name": "harnessLoaderForOptional", + "entryType": "function", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector, or null if\nno matching element is found." + } + ], + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector, or null if\n * no matching element is found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "harnessLoaderForOptional", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector, or null if\nno matching element is found." + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector, or null if\n * no matching element is found.\n */" + }, + "entryType": "function", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector, or null if\nno matching element is found." + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector, or null if\n * no matching element is found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "harnessLoaderForAll", + "signatures": [ + { + "name": "harnessLoaderForAll", + "entryType": "function", + "description": "Gets a list of `HarnessLoader` instances, one for each matching element.", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`, one rooted at each element matching the given selector." + } + ], + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Gets a list of `HarnessLoader` instances, one for each matching element.\n * @param selector The selector for the root element.\n * @return A list of `HarnessLoader`, one rooted at each element matching the given selector.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "harnessLoaderForAll", + "description": "Gets a list of `HarnessLoader` instances, one for each matching element.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`, one rooted at each element matching the given selector." + } + ], + "rawComment": "/**\n * Gets a list of `HarnessLoader` instances, one for each matching element.\n * @param selector The selector for the root element.\n * @return A list of `HarnessLoader`, one rooted at each element matching the given selector.\n */" + }, + "entryType": "function", + "description": "Gets a list of `HarnessLoader` instances, one for each matching element.", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`, one rooted at each element matching the given selector." + } + ], + "rawComment": "/**\n * Gets a list of `HarnessLoader` instances, one for each matching element.\n * @param selector The selector for the root element.\n * @return A list of `HarnessLoader`, one rooted at each element matching the given selector.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getHarness", + "signatures": [ + { + "name": "getHarness", + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, an error is thrown.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, an error is thrown.\n * @param query A query for a harness to create\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "getHarness", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, an error is thrown.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, an error is thrown.\n * @param query A query for a harness to create\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */" + }, + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, an error is thrown.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, an error is thrown.\n * @param query A query for a harness to create\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getHarnessOrNull", + "signatures": [ + { + "name": "getHarnessOrNull", + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, null is returned.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type (or null if not found)." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, null is returned.\n * @param query A query for a harness to create\n * @return An instance of the given harness type (or null if not found).\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "getHarnessOrNull", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, null is returned.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type (or null if not found)." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, null is returned.\n * @param query A query for a harness to create\n * @return An instance of the given harness type (or null if not found).\n */" + }, + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, null is returned.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type (or null if not found)." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, null is returned.\n * @param query A query for a harness to create\n * @return An instance of the given harness type (or null if not found).\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getHarnessAtIndex", + "signatures": [ + { + "name": "getHarnessAtIndex", + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type and index\nunder the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\ninstance. The index specifies the offset of the component to find. If no matching\ncomponent is found at that index, an error is thrown.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "param", + "comment": "The zero-indexed offset of the component to find" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + }, + { + "name": "offset", + "description": "", + "type": "number", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type and index\n * under the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\n * instance. The index specifies the offset of the component to find. If no matching\n * component is found at that index, an error is thrown.\n * @param query A query for a harness to create\n * @param index The zero-indexed offset of the component to find\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + }, + { + "name": "offset", + "description": "", + "type": "number", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "getHarnessAtIndex", + "description": "Searches for an instance of the component corresponding to the given harness type and index\nunder the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\ninstance. The index specifies the offset of the component to find. If no matching\ncomponent is found at that index, an error is thrown.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "param", + "comment": "The zero-indexed offset of the component to find" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type and index\n * under the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\n * instance. The index specifies the offset of the component to find. If no matching\n * component is found at that index, an error is thrown.\n * @param query A query for a harness to create\n * @param index The zero-indexed offset of the component to find\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */" + }, + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type and index\nunder the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\ninstance. The index specifies the offset of the component to find. If no matching\ncomponent is found at that index, an error is thrown.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "param", + "comment": "The zero-indexed offset of the component to find" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type and index\n * under the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\n * instance. The index specifies the offset of the component to find. If no matching\n * component is found at that index, an error is thrown.\n * @param query A query for a harness to create\n * @param index The zero-indexed offset of the component to find\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getAllHarnesses", + "signatures": [ + { + "name": "getAllHarnesses", + "entryType": "function", + "description": "Searches for all instances of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A list instances of the given harness type." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for all instances of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.\n * @param query A query for a harness to create\n * @return A list instances of the given harness type.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "getAllHarnesses", + "description": "Searches for all instances of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A list instances of the given harness type." + } + ], + "rawComment": "/**\n * Searches for all instances of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.\n * @param query A query for a harness to create\n * @return A list instances of the given harness type.\n */" + }, + "entryType": "function", + "description": "Searches for all instances of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A list instances of the given harness type." + } + ], + "rawComment": "/**\n * Searches for all instances of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.\n * @param query A query for a harness to create\n * @return A list instances of the given harness type.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "countHarnesses", + "signatures": [ + { + "name": "countHarnesses", + "entryType": "function", + "description": "Searches for all instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns the number that were found.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "The number of instances that were found." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for all instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns the number that were found.\n * @param query A query for a harness to create\n * @return The number of instances that were found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "countHarnesses", + "description": "Searches for all instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns the number that were found.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "The number of instances that were found." + } + ], + "rawComment": "/**\n * Searches for all instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns the number that were found.\n * @param query A query for a harness to create\n * @return The number of instances that were found.\n */" + }, + "entryType": "function", + "description": "Searches for all instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns the number that were found.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "The number of instances that were found." + } + ], + "rawComment": "/**\n * Searches for all instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns the number that were found.\n * @param query A query for a harness to create\n * @return The number of instances that were found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "hasHarness", + "signatures": [ + { + "name": "hasHarness", + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A boolean indicating if an instance was found." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.\n * @param query A query for a harness to create\n * @return A boolean indicating if an instance was found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "hasHarness", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A boolean indicating if an instance was found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.\n * @param query A query for a harness to create\n * @return A boolean indicating if an instance was found.\n */" + }, + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A boolean indicating if an instance was found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.\n * @param query A query for a harness to create\n * @return A boolean indicating if an instance was found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getChildLoader", + "signatures": [ + { + "name": "getChildLoader", + "entryType": "function", + "description": "Searches for an element with the given selector under the evironment's root element,\nand returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\nselector, the first is used. If no elements match, an error is thrown.", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the element matching the given selector." + }, + { + "name": "throws", + "comment": "If a matching element can't be found." + } + ], + "params": [ + { + "name": "selector", + "description": "The selector for the root element of the new `HarnessLoader`", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for an element with the given selector under the evironment's root element,\n * and returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\n * selector, the first is used. If no elements match, an error is thrown.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A `HarnessLoader` rooted at the element matching the given selector.\n * @throws If a matching element can't be found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "selector", + "description": "The selector for the root element of the new `HarnessLoader`", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "getChildLoader", + "description": "Searches for an element with the given selector under the evironment's root element,\nand returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\nselector, the first is used. If no elements match, an error is thrown.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the element matching the given selector." + }, + { + "name": "throws", + "comment": "If a matching element can't be found." + } + ], + "rawComment": "/**\n * Searches for an element with the given selector under the evironment's root element,\n * and returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\n * selector, the first is used. If no elements match, an error is thrown.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A `HarnessLoader` rooted at the element matching the given selector.\n * @throws If a matching element can't be found.\n */" + }, + "entryType": "function", + "description": "Searches for an element with the given selector under the evironment's root element,\nand returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\nselector, the first is used. If no elements match, an error is thrown.", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the element matching the given selector." + }, + { + "name": "throws", + "comment": "If a matching element can't be found." + } + ], + "rawComment": "/**\n * Searches for an element with the given selector under the evironment's root element,\n * and returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\n * selector, the first is used. If no elements match, an error is thrown.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A `HarnessLoader` rooted at the element matching the given selector.\n * @throws If a matching element can't be found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getAllChildLoaders", + "signatures": [ + { + "name": "getAllChildLoaders", + "entryType": "function", + "description": "Searches for all elements with the given selector under the environment's root element,\nand returns an array of `HarnessLoader`s, one for each matching element, rooted at that\nelement.", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`s, one for each matching element, rooted at that element." + } + ], + "params": [ + { + "name": "selector", + "description": "The selector for the root element of the new `HarnessLoader`", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for all elements with the given selector under the environment's root element,\n * and returns an array of `HarnessLoader`s, one for each matching element, rooted at that\n * element.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A list of `HarnessLoader`s, one for each matching element, rooted at that element.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "selector", + "description": "The selector for the root element of the new `HarnessLoader`", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "getAllChildLoaders", + "description": "Searches for all elements with the given selector under the environment's root element,\nand returns an array of `HarnessLoader`s, one for each matching element, rooted at that\nelement.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`s, one for each matching element, rooted at that element." + } + ], + "rawComment": "/**\n * Searches for all elements with the given selector under the environment's root element,\n * and returns an array of `HarnessLoader`s, one for each matching element, rooted at that\n * element.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A list of `HarnessLoader`s, one for each matching element, rooted at that element.\n */" + }, + "entryType": "function", + "description": "Searches for all elements with the given selector under the environment's root element,\nand returns an array of `HarnessLoader`s, one for each matching element, rooted at that\nelement.", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`s, one for each matching element, rooted at that element." + } + ], + "rawComment": "/**\n * Searches for all elements with the given selector under the environment's root element,\n * and returns an array of `HarnessLoader`s, one for each matching element, rooted at that\n * element.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A list of `HarnessLoader`s, one for each matching element, rooted at that element.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "createComponentHarness", + "signatures": [ + { + "name": "createComponentHarness", + "entryType": "function", + "description": "Creates a `ComponentHarness` for the given harness type with the given raw host element.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [], + "params": [ + { + "name": "harnessType", + "description": "", + "type": "ComponentHarnessConstructor", + "isOptional": false, + "isRestParam": false + }, + { + "name": "element", + "description": "", + "type": "E", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/** Creates a `ComponentHarness` for the given harness type with the given raw host element. */", + "returnType": "T" + } + ], + "implementation": { + "params": [ + { + "name": "harnessType", + "description": "", + "type": "ComponentHarnessConstructor", + "isOptional": false, + "isRestParam": false + }, + { + "name": "element", + "description": "", + "type": "E", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "T", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "createComponentHarness", + "description": "Creates a `ComponentHarness` for the given harness type with the given raw host element.", + "entryType": "function", + "jsdocTags": [], + "rawComment": "/** Creates a `ComponentHarness` for the given harness type with the given raw host element. */" + }, + "entryType": "function", + "description": "Creates a `ComponentHarness` for the given harness type with the given raw host element.", + "jsdocTags": [], + "rawComment": "/** Creates a `ComponentHarness` for the given harness type with the given raw host element. */", + "memberType": "method", + "memberTags": [ + "protected", + "override" + ] + }, { "name": "getNativeElement", "signatures": [ @@ -1802,6 +3250,86 @@ "SeleniumWebDriverHarnessEnvironment.getAllRawElements", "@angular/cdk/testing/selenium-webdriver" ], + [ + "SeleniumWebDriverHarnessEnvironment.rawRootElement", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.rootElement", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.rootElement", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.documentRootLocatorFactory", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.locatorFor", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.locatorForOptional", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.locatorForAll", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.rootHarnessLoader", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.harnessLoaderFor", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.harnessLoaderForOptional", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.harnessLoaderForAll", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.getHarness", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.getHarnessOrNull", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.getHarnessAtIndex", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.getAllHarnesses", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.countHarnesses", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.hasHarness", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.getChildLoader", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.getAllChildLoaders", + "@angular/cdk/testing/selenium-webdriver" + ], + [ + "SeleniumWebDriverHarnessEnvironment.createComponentHarness", + "@angular/cdk/testing/selenium-webdriver" + ], [ "SeleniumWebDriverHarnessEnvironment.getNativeElement", "@angular/cdk/testing/selenium-webdriver" diff --git a/adev/src/content/cdk/cdk_testing_testbed.json b/adev/src/content/cdk/cdk_testing_testbed.json index d35aba34f241..81b9285a69e8 100755 --- a/adev/src/content/cdk/cdk_testing_testbed.json +++ b/adev/src/content/cdk/cdk_testing_testbed.json @@ -69,7 +69,7 @@ { "name": "_fixture", "description": "", - "type": "any", + "type": "Fixture", "isOptional": false, "isRestParam": false }, @@ -353,6 +353,1454 @@ "protected" ] }, + { + "name": "rawRootElement", + "type": "E", + "memberType": "property", + "memberTags": [ + "protected", + "override" + ], + "description": "The native root element of this `HarnessEnvironment`.", + "jsdocTags": [] + }, + { + "name": "rootElement", + "type": "TestElement", + "memberType": "getter", + "memberTags": [ + "override" + ], + "description": "The root element of this `HarnessEnvironment` as a `TestElement`.", + "jsdocTags": [] + }, + { + "name": "rootElement", + "type": "TestElement", + "memberType": "setter", + "memberTags": [ + "override" + ], + "description": "", + "jsdocTags": [] + }, + { + "name": "documentRootLocatorFactory", + "signatures": [ + { + "name": "documentRootLocatorFactory", + "entryType": "function", + "description": "Gets a locator factory rooted at the document root.", + "generics": [], + "isNewType": false, + "jsdocTags": [], + "params": [], + "rawComment": "/** Gets a locator factory rooted at the document root. */", + "returnType": "LocatorFactory" + } + ], + "implementation": { + "params": [], + "isNewType": false, + "returnType": "LocatorFactory", + "generics": [], + "name": "documentRootLocatorFactory", + "description": "Gets a locator factory rooted at the document root.", + "entryType": "function", + "jsdocTags": [], + "rawComment": "/** Gets a locator factory rooted at the document root. */" + }, + "entryType": "function", + "description": "Gets a locator factory rooted at the document root.", + "jsdocTags": [], + "rawComment": "/** Gets a locator factory rooted at the document root. */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "locatorFor", + "signatures": [ + { + "name": "locatorFor", + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorFor('span')() // Throws because the `Promise` rejects\n```", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\neach query." + } + ], + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorFor('span')() // Throws because the `Promise` rejects\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\n * each query.\n */", + "returnType": "() => Promise>" + } + ], + "implementation": { + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "isNewType": false, + "returnType": "() => Promise>", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "name": "locatorFor", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorFor('span')() // Throws because the `Promise` rejects\n```", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\neach query." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorFor('span')() // Throws because the `Promise` rejects\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\n * each query.\n */" + }, + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorFor('span')() // Throws because the `Promise` rejects\n```", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\neach query." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorFor('span')() // Throws because the `Promise` rejects\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` rejects. The type that the `Promise` resolves to is a union of all result types for\n * each query.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "locatorForOptional", + "signatures": [ + { + "name": "locatorForOptional", + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironmnet`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorForOptional('span')() // Gets `null`\n```", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\nresult types for each query or null." + } + ], + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironmnet`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorForOptional('span')() // Gets `null`\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\n * result types for each query or null.\n */", + "returnType": "() => Promise | null>" + } + ], + "implementation": { + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "isNewType": false, + "returnType": "() => Promise | null>", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "name": "locatorForOptional", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironmnet`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorForOptional('span')() // Gets `null`\n```", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\nresult types for each query or null." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironmnet`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorForOptional('span')() // Gets `null`\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\n * result types for each query or null.\n */" + }, + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\nor element under the root element of this `HarnessEnvironmnet`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\nawait lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\nawait lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\nawait lf.locatorForOptional('span')() // Gets `null`\n```", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for the\nfirst element or harness matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If no matches are found, the\n`Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\nresult types for each query or null." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find a `ComponentHarness` instance\n * or element under the root element of this `HarnessEnvironmnet`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * await lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1\n * await lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1\n * await lf.locatorForOptional('span')() // Gets `null`\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for the\n * first element or harness matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If no matches are found, the\n * `Promise` is resolved with `null`. The type that the `Promise` resolves to is a union of all\n * result types for each query or null.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "locatorForAll", + "signatures": [ + { + "name": "locatorForAll", + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\nor elements under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n`IdIsD1Harness.hostSelector` is `'#d1'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\n// Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\nawait lf.locatorForAll(DivHarness, 'div')()\n// Gets [TestElement for #d1, TestElement for #d2]\nawait lf.locatorForAll('div', '#d1')()\n// Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\nawait lf.locatorForAll(DivHarness, IdIsD1Harness)()\n// Gets []\nawait lf.locatorForAll('span')()\n```", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for all\nelements and harnesses matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If an element matches more than\none `ComponentHarness` class, the locator gets an instance of each for the same element. If\nan element matches multiple `string` selectors, only one `TestElement` instance is returned\nfor that element. The type that the `Promise` resolves to is an array where each element is\nthe union of all result types for each query." + } + ], + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\n * or elements under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n * `IdIsD1Harness.hostSelector` is `'#d1'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * // Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\n * await lf.locatorForAll(DivHarness, 'div')()\n * // Gets [TestElement for #d1, TestElement for #d2]\n * await lf.locatorForAll('div', '#d1')()\n * // Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\n * await lf.locatorForAll(DivHarness, IdIsD1Harness)()\n * // Gets []\n * await lf.locatorForAll('span')()\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for all\n * elements and harnesses matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If an element matches more than\n * one `ComponentHarness` class, the locator gets an instance of each for the same element. If\n * an element matches multiple `string` selectors, only one `TestElement` instance is returned\n * for that element. The type that the `Promise` resolves to is an array where each element is\n * the union of all result types for each query.\n */", + "returnType": "() => Promise[]>" + } + ], + "implementation": { + "params": [ + { + "name": "queries", + "description": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate.", + "type": "T", + "isOptional": false, + "isRestParam": true + } + ], + "isNewType": false, + "returnType": "() => Promise[]>", + "generics": [ + { + "name": "T", + "constraint": "(HarnessQuery | string)[]" + } + ], + "name": "locatorForAll", + "description": "Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\nor elements under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n`IdIsD1Harness.hostSelector` is `'#d1'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\n// Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\nawait lf.locatorForAll(DivHarness, 'div')()\n// Gets [TestElement for #d1, TestElement for #d2]\nawait lf.locatorForAll('div', '#d1')()\n// Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\nawait lf.locatorForAll(DivHarness, IdIsD1Harness)()\n// Gets []\nawait lf.locatorForAll('span')()\n```", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for all\nelements and harnesses matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If an element matches more than\none `ComponentHarness` class, the locator gets an instance of each for the same element. If\nan element matches multiple `string` selectors, only one `TestElement` instance is returned\nfor that element. The type that the `Promise` resolves to is an array where each element is\nthe union of all result types for each query." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\n * or elements under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n * `IdIsD1Harness.hostSelector` is `'#d1'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * // Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\n * await lf.locatorForAll(DivHarness, 'div')()\n * // Gets [TestElement for #d1, TestElement for #d2]\n * await lf.locatorForAll('div', '#d1')()\n * // Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\n * await lf.locatorForAll(DivHarness, IdIsD1Harness)()\n * // Gets []\n * await lf.locatorForAll('span')()\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for all\n * elements and harnesses matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If an element matches more than\n * one `ComponentHarness` class, the locator gets an instance of each for the same element. If\n * an element matches multiple `string` selectors, only one `TestElement` instance is returned\n * for that element. The type that the `Promise` resolves to is an array where each element is\n * the union of all result types for each query.\n */" + }, + "entryType": "function", + "description": "Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\nor elements under the root element of this `HarnessEnvironment`.\n\nFor example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n`IdIsD1Harness.hostSelector` is `'#d1'`\n\n```html\n
\n```\n\nthen we expect:\n\n```ts\n// Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\nawait lf.locatorForAll(DivHarness, 'div')()\n// Gets [TestElement for #d1, TestElement for #d2]\nawait lf.locatorForAll('div', '#d1')()\n// Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\nawait lf.locatorForAll(DivHarness, IdIsD1Harness)()\n// Gets []\nawait lf.locatorForAll('span')()\n```", + "jsdocTags": [ + { + "name": "param", + "comment": "A list of queries specifying which harnesses and elements to search for:\n- A `string` searches for elements matching the CSS selector specified by the string.\n- A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\ngiven class.\n- A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\npredicate." + }, + { + "name": "return", + "comment": "An asynchronous locator function that searches for and returns a `Promise` for all\nelements and harnesses matching the given search criteria. Matches are ordered first by\norder in the DOM, and second by order in the queries list. If an element matches more than\none `ComponentHarness` class, the locator gets an instance of each for the same element. If\nan element matches multiple `string` selectors, only one `TestElement` instance is returned\nfor that element. The type that the `Promise` resolves to is an array where each element is\nthe union of all result types for each query." + } + ], + "rawComment": "/**\n * Creates an asynchronous locator function that can be used to find `ComponentHarness` instances\n * or elements under the root element of this `HarnessEnvironment`.\n *\n * For example, given the following DOM and assuming `DivHarness.hostSelector` is `'div'` and\n * `IdIsD1Harness.hostSelector` is `'#d1'`\n *\n * ```html\n *
\n * ```\n *\n * then we expect:\n *\n * ```ts\n * // Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]\n * await lf.locatorForAll(DivHarness, 'div')()\n * // Gets [TestElement for #d1, TestElement for #d2]\n * await lf.locatorForAll('div', '#d1')()\n * // Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]\n * await lf.locatorForAll(DivHarness, IdIsD1Harness)()\n * // Gets []\n * await lf.locatorForAll('span')()\n * ```\n *\n * @param queries A list of queries specifying which harnesses and elements to search for:\n * - A `string` searches for elements matching the CSS selector specified by the string.\n * - A `ComponentHarness` constructor searches for `ComponentHarness` instances matching the\n * given class.\n * - A `HarnessPredicate` searches for `ComponentHarness` instances matching the given\n * predicate.\n * @return An asynchronous locator function that searches for and returns a `Promise` for all\n * elements and harnesses matching the given search criteria. Matches are ordered first by\n * order in the DOM, and second by order in the queries list. If an element matches more than\n * one `ComponentHarness` class, the locator gets an instance of each for the same element. If\n * an element matches multiple `string` selectors, only one `TestElement` instance is returned\n * for that element. The type that the `Promise` resolves to is an array where each element is\n * the union of all result types for each query.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "rootHarnessLoader", + "signatures": [ + { + "name": "rootHarnessLoader", + "entryType": "function", + "description": "", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`." + } + ], + "params": [], + "rawComment": "/** @return A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`. */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "rootHarnessLoader", + "description": "", + "entryType": "function", + "jsdocTags": [ + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`." + } + ], + "rawComment": "/** @return A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`. */" + }, + "entryType": "function", + "description": "", + "jsdocTags": [ + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`." + } + ], + "rawComment": "/** @return A `HarnessLoader` rooted at the root element of this `HarnessEnvironment`. */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "harnessLoaderFor", + "signatures": [ + { + "name": "harnessLoaderFor", + "entryType": "function", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector." + }, + { + "name": "throws", + "comment": "If no matching element is found for the given selector." + } + ], + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector.\n * @throws If no matching element is found for the given selector.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "harnessLoaderFor", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector." + }, + { + "name": "throws", + "comment": "If no matching element is found for the given selector." + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector.\n * @throws If no matching element is found for the given selector.\n */" + }, + "entryType": "function", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector." + }, + { + "name": "throws", + "comment": "If no matching element is found for the given selector." + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector.\n * @throws If no matching element is found for the given selector.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "harnessLoaderForOptional", + "signatures": [ + { + "name": "harnessLoaderForOptional", + "entryType": "function", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector, or null if\nno matching element is found." + } + ], + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector, or null if\n * no matching element is found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "harnessLoaderForOptional", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector, or null if\nno matching element is found." + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector, or null if\n * no matching element is found.\n */" + }, + "entryType": "function", + "description": "Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the first element matching the given selector, or null if\nno matching element is found." + } + ], + "rawComment": "/**\n * Gets a `HarnessLoader` instance for an element under the root of this `HarnessEnvironment`.\n * @param selector The selector for the root element.\n * @return A `HarnessLoader` rooted at the first element matching the given selector, or null if\n * no matching element is found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "harnessLoaderForAll", + "signatures": [ + { + "name": "harnessLoaderForAll", + "entryType": "function", + "description": "Gets a list of `HarnessLoader` instances, one for each matching element.", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`, one rooted at each element matching the given selector." + } + ], + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Gets a list of `HarnessLoader` instances, one for each matching element.\n * @param selector The selector for the root element.\n * @return A list of `HarnessLoader`, one rooted at each element matching the given selector.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "selector", + "description": "The selector for the root element.", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "harnessLoaderForAll", + "description": "Gets a list of `HarnessLoader` instances, one for each matching element.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`, one rooted at each element matching the given selector." + } + ], + "rawComment": "/**\n * Gets a list of `HarnessLoader` instances, one for each matching element.\n * @param selector The selector for the root element.\n * @return A list of `HarnessLoader`, one rooted at each element matching the given selector.\n */" + }, + "entryType": "function", + "description": "Gets a list of `HarnessLoader` instances, one for each matching element.", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element." + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`, one rooted at each element matching the given selector." + } + ], + "rawComment": "/**\n * Gets a list of `HarnessLoader` instances, one for each matching element.\n * @param selector The selector for the root element.\n * @return A list of `HarnessLoader`, one rooted at each element matching the given selector.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getHarness", + "signatures": [ + { + "name": "getHarness", + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, an error is thrown.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, an error is thrown.\n * @param query A query for a harness to create\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "getHarness", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, an error is thrown.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, an error is thrown.\n * @param query A query for a harness to create\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */" + }, + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, an error is thrown.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, an error is thrown.\n * @param query A query for a harness to create\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getHarnessOrNull", + "signatures": [ + { + "name": "getHarnessOrNull", + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, null is returned.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type (or null if not found)." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, null is returned.\n * @param query A query for a harness to create\n * @return An instance of the given harness type (or null if not found).\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "getHarnessOrNull", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, null is returned.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type (or null if not found)." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, null is returned.\n * @param query A query for a harness to create\n * @return An instance of the given harness type (or null if not found).\n */" + }, + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\nmultiple matching components are found, a harness for the first one is returned. If no matching\ncomponent is found, null is returned.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "An instance of the given harness type (or null if not found)." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that instance. If\n * multiple matching components are found, a harness for the first one is returned. If no matching\n * component is found, null is returned.\n * @param query A query for a harness to create\n * @return An instance of the given harness type (or null if not found).\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getHarnessAtIndex", + "signatures": [ + { + "name": "getHarnessAtIndex", + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type and index\nunder the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\ninstance. The index specifies the offset of the component to find. If no matching\ncomponent is found at that index, an error is thrown.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "param", + "comment": "The zero-indexed offset of the component to find" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + }, + { + "name": "offset", + "description": "", + "type": "number", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type and index\n * under the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\n * instance. The index specifies the offset of the component to find. If no matching\n * component is found at that index, an error is thrown.\n * @param query A query for a harness to create\n * @param index The zero-indexed offset of the component to find\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + }, + { + "name": "offset", + "description": "", + "type": "number", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "getHarnessAtIndex", + "description": "Searches for an instance of the component corresponding to the given harness type and index\nunder the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\ninstance. The index specifies the offset of the component to find. If no matching\ncomponent is found at that index, an error is thrown.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "param", + "comment": "The zero-indexed offset of the component to find" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type and index\n * under the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\n * instance. The index specifies the offset of the component to find. If no matching\n * component is found at that index, an error is thrown.\n * @param query A query for a harness to create\n * @param index The zero-indexed offset of the component to find\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */" + }, + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type and index\nunder the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\ninstance. The index specifies the offset of the component to find. If no matching\ncomponent is found at that index, an error is thrown.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "param", + "comment": "The zero-indexed offset of the component to find" + }, + { + "name": "return", + "comment": "An instance of the given harness type" + }, + { + "name": "throws", + "comment": "If a matching component instance can't be found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type and index\n * under the `HarnessEnvironment`'s root element, and returns a `ComponentHarness` for that\n * instance. The index specifies the offset of the component to find. If no matching\n * component is found at that index, an error is thrown.\n * @param query A query for a harness to create\n * @param index The zero-indexed offset of the component to find\n * @return An instance of the given harness type\n * @throws If a matching component instance can't be found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getAllHarnesses", + "signatures": [ + { + "name": "getAllHarnesses", + "entryType": "function", + "description": "Searches for all instances of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A list instances of the given harness type." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for all instances of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.\n * @param query A query for a harness to create\n * @return A list instances of the given harness type.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "getAllHarnesses", + "description": "Searches for all instances of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A list instances of the given harness type." + } + ], + "rawComment": "/**\n * Searches for all instances of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.\n * @param query A query for a harness to create\n * @return A list instances of the given harness type.\n */" + }, + "entryType": "function", + "description": "Searches for all instances of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A list instances of the given harness type." + } + ], + "rawComment": "/**\n * Searches for all instances of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a list `ComponentHarness` for each instance.\n * @param query A query for a harness to create\n * @return A list instances of the given harness type.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "countHarnesses", + "signatures": [ + { + "name": "countHarnesses", + "entryType": "function", + "description": "Searches for all instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns the number that were found.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "The number of instances that were found." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for all instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns the number that were found.\n * @param query A query for a harness to create\n * @return The number of instances that were found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "countHarnesses", + "description": "Searches for all instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns the number that were found.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "The number of instances that were found." + } + ], + "rawComment": "/**\n * Searches for all instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns the number that were found.\n * @param query A query for a harness to create\n * @return The number of instances that were found.\n */" + }, + "entryType": "function", + "description": "Searches for all instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns the number that were found.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "The number of instances that were found." + } + ], + "rawComment": "/**\n * Searches for all instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns the number that were found.\n * @param query A query for a harness to create\n * @return The number of instances that were found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "hasHarness", + "signatures": [ + { + "name": "hasHarness", + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A boolean indicating if an instance was found." + } + ], + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.\n * @param query A query for a harness to create\n * @return A boolean indicating if an instance was found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "query", + "description": "A query for a harness to create", + "type": "HarnessQuery", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "hasHarness", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A boolean indicating if an instance was found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.\n * @param query A query for a harness to create\n * @return A boolean indicating if an instance was found.\n */" + }, + "entryType": "function", + "description": "Searches for an instance of the component corresponding to the given harness type under the\n`HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.", + "jsdocTags": [ + { + "name": "param", + "comment": "A query for a harness to create" + }, + { + "name": "return", + "comment": "A boolean indicating if an instance was found." + } + ], + "rawComment": "/**\n * Searches for an instance of the component corresponding to the given harness type under the\n * `HarnessEnvironment`'s root element, and returns a boolean indicating if any were found.\n * @param query A query for a harness to create\n * @return A boolean indicating if an instance was found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getChildLoader", + "signatures": [ + { + "name": "getChildLoader", + "entryType": "function", + "description": "Searches for an element with the given selector under the evironment's root element,\nand returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\nselector, the first is used. If no elements match, an error is thrown.", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the element matching the given selector." + }, + { + "name": "throws", + "comment": "If a matching element can't be found." + } + ], + "params": [ + { + "name": "selector", + "description": "The selector for the root element of the new `HarnessLoader`", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for an element with the given selector under the evironment's root element,\n * and returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\n * selector, the first is used. If no elements match, an error is thrown.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A `HarnessLoader` rooted at the element matching the given selector.\n * @throws If a matching element can't be found.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "selector", + "description": "The selector for the root element of the new `HarnessLoader`", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "getChildLoader", + "description": "Searches for an element with the given selector under the evironment's root element,\nand returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\nselector, the first is used. If no elements match, an error is thrown.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the element matching the given selector." + }, + { + "name": "throws", + "comment": "If a matching element can't be found." + } + ], + "rawComment": "/**\n * Searches for an element with the given selector under the evironment's root element,\n * and returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\n * selector, the first is used. If no elements match, an error is thrown.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A `HarnessLoader` rooted at the element matching the given selector.\n * @throws If a matching element can't be found.\n */" + }, + "entryType": "function", + "description": "Searches for an element with the given selector under the evironment's root element,\nand returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\nselector, the first is used. If no elements match, an error is thrown.", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A `HarnessLoader` rooted at the element matching the given selector." + }, + { + "name": "throws", + "comment": "If a matching element can't be found." + } + ], + "rawComment": "/**\n * Searches for an element with the given selector under the evironment's root element,\n * and returns a `HarnessLoader` rooted at the matching element. If multiple elements match the\n * selector, the first is used. If no elements match, an error is thrown.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A `HarnessLoader` rooted at the element matching the given selector.\n * @throws If a matching element can't be found.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "getAllChildLoaders", + "signatures": [ + { + "name": "getAllChildLoaders", + "entryType": "function", + "description": "Searches for all elements with the given selector under the environment's root element,\nand returns an array of `HarnessLoader`s, one for each matching element, rooted at that\nelement.", + "generics": [], + "isNewType": false, + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`s, one for each matching element, rooted at that element." + } + ], + "params": [ + { + "name": "selector", + "description": "The selector for the root element of the new `HarnessLoader`", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/**\n * Searches for all elements with the given selector under the environment's root element,\n * and returns an array of `HarnessLoader`s, one for each matching element, rooted at that\n * element.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A list of `HarnessLoader`s, one for each matching element, rooted at that element.\n */", + "returnType": "Promise" + } + ], + "implementation": { + "params": [ + { + "name": "selector", + "description": "The selector for the root element of the new `HarnessLoader`", + "type": "string", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "Promise", + "generics": [], + "name": "getAllChildLoaders", + "description": "Searches for all elements with the given selector under the environment's root element,\nand returns an array of `HarnessLoader`s, one for each matching element, rooted at that\nelement.", + "entryType": "function", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`s, one for each matching element, rooted at that element." + } + ], + "rawComment": "/**\n * Searches for all elements with the given selector under the environment's root element,\n * and returns an array of `HarnessLoader`s, one for each matching element, rooted at that\n * element.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A list of `HarnessLoader`s, one for each matching element, rooted at that element.\n */" + }, + "entryType": "function", + "description": "Searches for all elements with the given selector under the environment's root element,\nand returns an array of `HarnessLoader`s, one for each matching element, rooted at that\nelement.", + "jsdocTags": [ + { + "name": "param", + "comment": "The selector for the root element of the new `HarnessLoader`" + }, + { + "name": "return", + "comment": "A list of `HarnessLoader`s, one for each matching element, rooted at that element." + } + ], + "rawComment": "/**\n * Searches for all elements with the given selector under the environment's root element,\n * and returns an array of `HarnessLoader`s, one for each matching element, rooted at that\n * element.\n * @param selector The selector for the root element of the new `HarnessLoader`\n * @return A list of `HarnessLoader`s, one for each matching element, rooted at that element.\n */", + "memberType": "method", + "memberTags": [ + "override" + ] + }, + { + "name": "createComponentHarness", + "signatures": [ + { + "name": "createComponentHarness", + "entryType": "function", + "description": "Creates a `ComponentHarness` for the given harness type with the given raw host element.", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "isNewType": false, + "jsdocTags": [], + "params": [ + { + "name": "harnessType", + "description": "", + "type": "ComponentHarnessConstructor", + "isOptional": false, + "isRestParam": false + }, + { + "name": "element", + "description": "", + "type": "E", + "isOptional": false, + "isRestParam": false + } + ], + "rawComment": "/** Creates a `ComponentHarness` for the given harness type with the given raw host element. */", + "returnType": "T" + } + ], + "implementation": { + "params": [ + { + "name": "harnessType", + "description": "", + "type": "ComponentHarnessConstructor", + "isOptional": false, + "isRestParam": false + }, + { + "name": "element", + "description": "", + "type": "E", + "isOptional": false, + "isRestParam": false + } + ], + "isNewType": false, + "returnType": "T", + "generics": [ + { + "name": "T", + "constraint": "ComponentHarness" + } + ], + "name": "createComponentHarness", + "description": "Creates a `ComponentHarness` for the given harness type with the given raw host element.", + "entryType": "function", + "jsdocTags": [], + "rawComment": "/** Creates a `ComponentHarness` for the given harness type with the given raw host element. */" + }, + "entryType": "function", + "description": "Creates a `ComponentHarness` for the given harness type with the given raw host element.", + "jsdocTags": [], + "rawComment": "/** Creates a `ComponentHarness` for the given harness type with the given raw host element. */", + "memberType": "method", + "memberTags": [ + "protected", + "override" + ] + }, { "name": "loader", "signatures": [ @@ -367,7 +1815,7 @@ { "name": "fixture", "description": "", - "type": "any", + "type": "Fixture", "isOptional": false, "isRestParam": false }, @@ -388,7 +1836,7 @@ { "name": "fixture", "description": "", - "type": "any", + "type": "Fixture", "isOptional": false, "isRestParam": false }, @@ -432,7 +1880,7 @@ { "name": "fixture", "description": "", - "type": "any", + "type": "Fixture", "isOptional": false, "isRestParam": false }, @@ -453,7 +1901,7 @@ { "name": "fixture", "description": "", - "type": "any", + "type": "Fixture", "isOptional": false, "isRestParam": false }, @@ -553,7 +2001,7 @@ { "name": "fixture", "description": "", - "type": "any", + "type": "Fixture", "isOptional": false, "isRestParam": false }, @@ -581,7 +2029,7 @@ { "name": "fixture", "description": "", - "type": "any", + "type": "Fixture", "isOptional": false, "isRestParam": false }, @@ -757,7 +2205,7 @@ { "name": "modifiers", "description": "", - "type": "any", + "type": "ModifierKeys | undefined", "isOptional": true, "isRestParam": false } @@ -783,7 +2231,7 @@ { "name": "modifiers", "description": "", - "type": "any", + "type": "ModifierKeys | undefined", "isOptional": true, "isRestParam": false } @@ -829,7 +2277,7 @@ { "name": "modifiers", "description": "Modifier keys held while clicking", - "type": "any", + "type": "ModifierKeys | undefined", "isOptional": true, "isRestParam": false } @@ -843,7 +2291,7 @@ { "name": "args", "description": "", - "type": "[any?] | [\"center\", any?] | [number, number, any?]", + "type": "[(ModifierKeys | undefined)?] | [\"center\", (ModifierKeys | undefined)?] | [number, number, (ModifierKeys | undefined)?]", "isOptional": false, "isRestParam": true } @@ -905,7 +2353,7 @@ { "name": "modifiers", "description": "Modifier keys held while clicking", - "type": "any", + "type": "ModifierKeys | undefined", "isOptional": true, "isRestParam": false } @@ -919,7 +2367,7 @@ { "name": "args", "description": "", - "type": "[any?] | [\"center\", any?] | [number, number, any?]", + "type": "[(ModifierKeys | undefined)?] | [\"center\", (ModifierKeys | undefined)?] | [number, number, (ModifierKeys | undefined)?]", "isOptional": false, "isRestParam": true } @@ -1115,7 +2563,7 @@ { "name": "keys", "description": "", - "type": "any[]", + "type": "(string | TestKey)[]", "isOptional": false, "isRestParam": true } @@ -1141,7 +2589,7 @@ { "name": "keys", "description": "", - "type": "any[]", + "type": "(string | TestKey)[]", "isOptional": false, "isRestParam": true } @@ -1195,7 +2643,7 @@ { "name": "options", "description": "Options that affect what text is included.", - "type": "any", + "type": "TextOptions | undefined", "isOptional": true, "isRestParam": false } @@ -1209,7 +2657,7 @@ { "name": "options", "description": "Options that affect what text is included.", - "type": "any", + "type": "TextOptions | undefined", "isOptional": true, "isRestParam": false } @@ -1840,6 +3288,86 @@ "TestbedHarnessEnvironment.getAllRawElements", "@angular/cdk/testing/testbed" ], + [ + "TestbedHarnessEnvironment.rawRootElement", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.rootElement", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.rootElement", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.documentRootLocatorFactory", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.locatorFor", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.locatorForOptional", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.locatorForAll", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.rootHarnessLoader", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.harnessLoaderFor", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.harnessLoaderForOptional", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.harnessLoaderForAll", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.getHarness", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.getHarnessOrNull", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.getHarnessAtIndex", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.getAllHarnesses", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.countHarnesses", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.hasHarness", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.getChildLoader", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.getAllChildLoaders", + "@angular/cdk/testing/testbed" + ], + [ + "TestbedHarnessEnvironment.createComponentHarness", + "@angular/cdk/testing/testbed" + ], [ "TestbedHarnessEnvironment.loader", "@angular/cdk/testing/testbed" diff --git a/adev/src/content/cli/_build-info.json b/adev/src/content/cli/_build-info.json index edd3387321e8..e84391f0ac83 100644 --- a/adev/src/content/cli/_build-info.json +++ b/adev/src/content/cli/_build-info.json @@ -1,4 +1,4 @@ { "branchName": "refs/heads/22.2.x", - "sha": "208b48760a69a8388eedd8ce9245b9bad5d26127" + "sha": "b739f23b1bf89cd9c6d646d6ae9f05fb6d812a89" } \ No newline at end of file diff --git a/adev/src/content/cli/build.json b/adev/src/content/cli/build.json index c772aeeebcce..86d38cac7172 100644 --- a/adev/src/content/cli/build.json +++ b/adev/src/content/cli/build.json @@ -3,7 +3,7 @@ "command": "ng build [project]", "shortDescription": "Compiles an Angular application or library into an output directory named dist/ at the given output path.", "longDescriptionRelativePath": "@angular/cli/src/commands/build/long-description.md", - "longDescription": "The command can be used to build a project of type \"application\" or \"library\".\nWhen used to build a library, a different builder is invoked, and only the `ts-config`, `configuration`, `poll` and `watch` options are applied.\nAll other options apply only to building applications.\n\nThe application builder uses the [esbuild](https://esbuild.github.io/) build tool, with default configuration options specified in the workspace configuration file (`angular.json`) or with a named alternative configuration.\nA \"development\" configuration is created by default when you use the CLI to create the project, and you can use that configuration by specifying the `--configuration development`.\n\nThe configuration options generally correspond to the command options.\nYou can override individual configuration defaults by specifying the corresponding options on the command line.\nThe command can accept option names given in dash-case.\nNote that in the configuration file, you must specify names in camelCase.\n\nSome additional options can only be set through the configuration file,\neither by direct editing or with the `ng config` command.\nThese include `assets`, `styles`, and `scripts` objects that provide runtime-global resources to include in the project.\nResources in CSS, such as images and fonts, are automatically written and fingerprinted at the root of the output folder.\n\nFor further details, see [Workspace Configuration](reference/configs/workspace-config).\n", + "longDescription": "The command can be used to build a project of type \"application\" or \"library\".\nWhen used to build a library, a different builder is invoked, and only the `ts-config`, `configuration`, `poll` and `watch` options are applied.\nAll other options apply only to building applications.\n\nThe application builder uses the [esbuild](https://esbuild.github.io/) build tool, with default configuration options specified in the workspace configuration file (`angular.json`) or with a named alternative configuration.\nA \"development\" configuration is created by default when you use the CLI to create the project, and you can use that configuration by specifying the `--configuration development`.\n\nThe configuration options generally correspond to the command options.\nYou can override individual configuration defaults by specifying the corresponding options on the command line.\nThe command can accept option names given in dash-case.\nNote that in the configuration file, you must specify names in camelCase.\n\nSome additional options can only be set through the configuration file,\neither by direct editing or with the `ng config` command.\nThese include `assets`, `styles`, and `scripts` objects that provide runtime-global resources to include in the project.\nResources in CSS, such as images and fonts, are automatically written to the `media` directory of the browser output\n(configurable with the `outputPath.media` option) and fingerprinted when `outputHashing` is set to `all` or `media`.\n\nFor further details, see [Workspace Configuration](reference/configs/workspace-config).\n", "aliases": [ "b" ], diff --git a/adev/src/content/cli/completion.json b/adev/src/content/cli/completion.json index 32a2e398588e..24c56522b835 100644 --- a/adev/src/content/cli/completion.json +++ b/adev/src/content/cli/completion.json @@ -3,7 +3,7 @@ "command": "ng completion", "shortDescription": "Set up Angular CLI autocompletion for your terminal.", "longDescriptionRelativePath": "@angular/cli/src/commands/completion/long-description.md", - "longDescription": "Setting up autocompletion configures your terminal, so pressing the `` key while in the middle\nof typing will display various commands and options available to you. This makes it very easy to\ndiscover and use CLI commands without lots of memorization.\n\n![A demo of Angular CLI autocompletion in a terminal. The user types several partial `ng` commands,\nusing autocompletion to finish several arguments and list contextual options.\n](assets/images/guide/cli/completion.gif)\n\n## Automated setup\n\nThe CLI should prompt and ask to set up autocompletion for you the first time you use it (v14+).\nSimply answer \"Yes\" and the CLI will take care of the rest.\n\n```\n$ ng serve\n? Would you like to enable autocompletion? This will set up your terminal so pressing TAB while typing Angular CLI commands will show possible options and autocomplete arguments. (Enabling autocompletion will modify configuration files in your home directory.) Yes\nAppended `source <(ng completion script)` to `/home/my-username/.bashrc`. Restart your terminal or run:\n\nsource <(ng completion script)\n\nto autocomplete `ng` commands.\n\n# Serve output...\n```\n\nIf you already refused the prompt, it won't ask again. But you can run `ng completion` to\ndo the same thing automatically.\n\nThis modifies your terminal environment to load Angular CLI autocompletion, but can't update your\ncurrent terminal session. Either restart it or run `source <(ng completion script)` directly to\nenable autocompletion in your current session.\n\nTest it out by typing `ng ser` and it should autocomplete to `ng serve`. Ambiguous arguments\nwill show all possible options and their documentation, such as `ng generate `.\n\n## Manual setup\n\nSome users may have highly customized terminal setups, possibly with configuration files checked\ninto source control with an opinionated structure. `ng completion` only ever appends Angular's setup\nto an existing configuration file for your current shell, or creates one if none exists. If you want\nmore control over exactly where this configuration lives, you can manually set it up by having your\nshell run at startup:\n\n```bash\nsource <(ng completion script)\n```\n\nThis is equivalent to what `ng completion` will automatically set up, and gives power users more\nflexibility in their environments when desired.\n\n## Platform support\n\nAngular CLI supports autocompletion for the Bash and Zsh shells on MacOS and Linux operating\nsystems. On Windows, Git Bash and [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/)\nusing Bash or Zsh are supported.\n\n## Global install\n\nAutocompletion works by configuring your terminal to invoke the Angular CLI on startup to load the\nsetup script. This means the terminal must be able to find and execute the Angular CLI, typically\nthrough a global install that places the binary on the user's `$PATH`. If you get\n`command not found: ng`, make sure the CLI is installed globally which you can do with the `-g`\nflag:\n\n```bash\nnpm install -g @angular/cli\n```\n", + "longDescription": "Setting up autocompletion configures your terminal, so pressing the `` key while in the middle\nof typing will display various commands and options available to you. This makes it very easy to\ndiscover and use CLI commands without lots of memorization.\n\n![A demo of Angular CLI autocompletion in a terminal. The user types several partial `ng` commands,\nusing autocompletion to finish several arguments and list contextual options.\n](assets/images/guide/cli/completion.gif)\n\n## Automated setup\n\nThe CLI should prompt and ask to set up autocompletion for you the first time you use it (v14+).\nSimply answer \"Yes\" and the CLI will take care of the rest.\n\n```\n$ ng serve\n? Would you like to enable autocompletion? This will set up your terminal so pressing TAB while typing Angular CLI commands will show possible options and autocomplete arguments. (Enabling autocompletion will modify configuration files in your home directory.) Yes\nAppended `source <(ng completion script)` to `/home/my-username/.bashrc`. Restart your terminal or run:\n\nsource <(ng completion script)\n\nto autocomplete `ng` commands.\n\n# Serve output...\n```\n\nIf you already refused the prompt, it won't ask again. But you can run `ng completion` to\ndo the same thing automatically.\n\nThis modifies your terminal environment to load Angular CLI autocompletion, but can't update your\ncurrent terminal session. Either restart it or run `source <(ng completion script)` directly to\nenable autocompletion in your current session.\n\nTest it out by typing `ng ser` and it should autocomplete to `ng serve`. Ambiguous arguments\nwill show all possible options and their documentation, such as `ng generate `.\n\n## Manual setup\n\nSome users may have highly customized terminal setups, possibly with configuration files checked\ninto source control with an opinionated structure. `ng completion` only ever appends Angular's setup\nto an existing configuration file for your current shell, or creates one if none exists. If you want\nmore control over exactly where this configuration lives, you can manually set it up by having your\nshell run at startup:\n\n```bash\nif [[ $- == *i* ]]; then\n source <(ng completion script)\nfi\n```\n\nThis is equivalent to what `ng completion` will automatically set up, and gives power users more\nflexibility in their environments when desired.\n\n## Platform support\n\nAngular CLI supports autocompletion for the Bash and Zsh shells on MacOS and Linux operating\nsystems. On Windows, Git Bash and [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/)\nusing Bash or Zsh are supported.\n\n## Global install\n\nAutocompletion works by configuring your terminal to invoke the Angular CLI on startup to load the\nsetup script. This means the terminal must be able to find and execute the Angular CLI, typically\nthrough a global install that places the binary on the user's `$PATH`. If you get\n`command not found: ng`, make sure the CLI is installed globally which you can do with the `-g`\nflag:\n\n```bash\nnpm install -g @angular/cli\n```\n", "aliases": [], "deprecated": false, "options": [ diff --git a/adev/src/content/cli/deploy.json b/adev/src/content/cli/deploy.json index e168ec6c4a37..66973ab7e210 100644 --- a/adev/src/content/cli/deploy.json +++ b/adev/src/content/cli/deploy.json @@ -1,9 +1,9 @@ { "name": "deploy", "command": "ng deploy [project]", - "shortDescription": "Invokes the deploy builder for a specified project or for the default project in the workspace.", + "shortDescription": "Invokes the deploy builder for a specified project, the only project with a deploy target, or the project in the current working directory.", "longDescriptionRelativePath": "@angular/cli/src/commands/deploy/long-description.md", - "longDescription": "The command takes an optional project name, as specified in the `projects` section of the `angular.json` workspace configuration file.\nWhen a project name is not supplied, executes the `deploy` builder for the default project.\n\nTo use the `ng deploy` command, use `ng add` to add a package that implements deployment capabilities to your favorite platform.\nAdding the package automatically updates your workspace configuration, adding a deployment\n[CLI builder](tools/cli/cli-builder).\nFor example:\n\n```json\n\"projects\": {\n \"my-project\": {\n ...\n \"architect\": {\n ...\n \"deploy\": {\n \"builder\": \"@angular/fire:deploy\",\n \"options\": {}\n }\n }\n }\n}\n```\n", + "longDescription": "The command takes an optional project name, as specified in the `projects` section of the `angular.json` workspace configuration file.\nWhen a project name is not supplied, executes the `deploy` builder for the only project that has a `deploy` target,\nor for the project in the current working directory.\n\nTo use the `ng deploy` command, use `ng add` to add a package that implements deployment capabilities to your favorite platform.\nAdding the package automatically updates your workspace configuration, adding a deployment\n[CLI builder](tools/cli/cli-builder).\nFor example:\n\n```json\n\"projects\": {\n \"my-project\": {\n ...\n \"architect\": {\n ...\n \"deploy\": {\n \"builder\": \"@angular/fire:deploy\",\n \"options\": {}\n }\n }\n }\n}\n```\n", "aliases": [], "deprecated": false, "options": [ diff --git a/adev/src/content/cli/generate.json b/adev/src/content/cli/generate.json index c54ae2016487..ee2f9bfbf334 100644 --- a/adev/src/content/cli/generate.json +++ b/adev/src/content/cli/generate.json @@ -168,7 +168,7 @@ "S" ], "default": false, - "description": "Skip the generation of a unit test files `spec.ts`." + "description": "Skip the generation of unit test files `spec.ts`." }, { "name": "ssr", @@ -493,7 +493,7 @@ { "name": "name", "type": "string", - "description": "The name for the new directive. This will be used to create the directive's class and spec files (e.g., `my-directive.directive.ts` and `my-directive.directive.spec.ts`).", + "description": "The name for the new directive. This will be used to create the directive's class and spec files (e.g., `my-directive.ts` and `my-directive.spec.ts`).", "positional": 0 }, { @@ -551,7 +551,7 @@ { "name": "name", "type": "string", - "description": "The name for the new enum. This will be used to create the enum file (e.g., `my-enum.enum.ts`).", + "description": "The name for the new enum. This will be used to create the enum file (e.g., `my-enum.ts`).", "positional": 0 }, { @@ -621,7 +621,7 @@ { "name": "name", "type": "string", - "description": "The name for the new route guard. This will be used to create the guard's class and spec files (e.g., `my-guard.guard.ts` and `my-guard.guard.spec.ts`).", + "description": "The name for the new route guard. This will be used to create the guard's class and spec files (e.g., `example-guard.ts` and `example-guard.spec.ts`).", "positional": 0 }, { @@ -671,7 +671,7 @@ { "name": "name", "type": "string", - "description": "The name for the new interceptor. This will be used to create the interceptor's class and spec files (e.g., `my-interceptor.interceptor.ts` and `my-interceptor.interceptor.spec.ts`).", + "description": "The name for the new interceptor. This will be used to create the interceptor's class and spec files (e.g., `example-interceptor.ts` and `example-interceptor.spec.ts`).", "positional": 0 }, { @@ -707,7 +707,7 @@ { "name": "name", "type": "string", - "description": "The name for the new interface. This will be used to create the interface file (e.g., `my-interface.interface.ts`).", + "description": "The name for the new interface. This will be used to create the interface file (e.g., `my-interface.ts`).", "positional": 0 }, { @@ -741,7 +741,7 @@ "name": "entry-file", "type": "string", "default": "public-api", - "description": "The path to the library's public API file, relative to the workspace root. This file defines what parts of the library are accessible to applications that import it." + "description": "The name of the library's public API file, without the `.ts` extension, created in the library's `src` directory. This file defines what parts of the library are accessible to applications that import it." }, { "name": "name", @@ -898,7 +898,7 @@ { "name": "name", "type": "string", - "description": "The name for the new pipe. This will be used to create the pipe's class and spec files (e.g., `my-pipe.pipe.ts` and `my-pipe.pipe.spec.ts`).", + "description": "The name for the new pipe. This will be used to create the pipe's class and spec files (e.g., `example-pipe.ts` and `example-pipe.spec.ts`).", "positional": 0 }, { @@ -960,7 +960,7 @@ { "name": "name", "type": "string", - "description": "The name for the new resolver. This will be used to create the resolver's class and spec files (e.g., `my-resolver.resolver.ts` and `my-resolver.resolver.spec.ts`).", + "description": "The name for the new resolver. This will be used to create the resolver's class and spec files (e.g., `example-resolver.ts` and `example-resolver.spec.ts`).", "positional": 0 }, { @@ -1016,7 +1016,7 @@ { "name": "name", "type": "string", - "description": "The name for the new service. This will be used to create the service's class and spec files (e.g., `my-service.service.ts` and `my-service.service.spec.ts`).", + "description": "The name for the new service. This will be used to create the service's class and spec files (e.g., `my-service.ts` and `my-service.spec.ts`).", "positional": 0 }, { diff --git a/adev/src/content/cli/new.json b/adev/src/content/cli/new.json index 61346e585ad9..807a622142b7 100644 --- a/adev/src/content/cli/new.json +++ b/adev/src/content/cli/new.json @@ -3,7 +3,7 @@ "command": "ng new [name]", "shortDescription": "Creates a new Angular workspace.", "longDescriptionRelativePath": "@angular/cli/src/commands/new/long-description.md", - "longDescription": "Creates and initializes a new Angular application that is the default project for a new workspace.\n\nProvides interactive prompts for optional configuration, such as adding routing support.\nAll prompts can safely be allowed to default.\n\n- The new workspace folder is given the specified project name, and contains configuration files at the top level.\n\n- By default, the files for a new initial application (with the same name as the workspace) are placed in the `src/` subfolder.\n- The new application's configuration appears in the `projects` section of the `angular.json` workspace configuration file, under its project name.\n\n- Subsequent applications that you generate in the workspace reside in the `projects/` subfolder.\n\nIf you plan to have multiple applications in the workspace, you can create an empty workspace by using the `--no-create-application` option.\nYou can then use `ng generate application` to create an initial application.\nThis allows a workspace name different from the initial app name, and ensures that all applications reside in the `/projects` subfolder, matching the structure of the configuration file.\n", + "longDescription": "Creates and initializes a new Angular workspace with an initial application.\n\nProvides interactive prompts for optional configuration, such as adding routing support.\nAll prompts can safely be allowed to default.\n\n- The new workspace folder is given the specified project name, and contains configuration files at the top level.\n\n- By default, the files for a new initial application (with the same name as the workspace) are placed in the `src/` subfolder.\n- The new application's configuration appears in the `projects` section of the `angular.json` workspace configuration file, under its project name.\n\n- Subsequent applications that you generate in the workspace reside in the `projects/` subfolder.\n\nIf you plan to have multiple applications in the workspace, you can create an empty workspace by using the `--no-create-application` option.\nYou can then use `ng generate application` to create an initial application.\nThis allows a workspace name different from the initial app name, and ensures that all applications reside in the `/projects` subfolder, matching the structure of the configuration file.\n", "aliases": [ "n" ], @@ -20,7 +20,7 @@ "open-ai-codex", "vscode" ], - "description": "Specifies which AI tools to generate configuration files for. These file are used to improve the outputs of AI tools by following the best practices." + "description": "Specifies which AI tools to generate configuration files for. These files are used to improve the outputs of AI tools by following the best practices." }, { "name": "collection", @@ -51,7 +51,7 @@ { "name": "directory", "type": "string", - "description": "The directory where the new workspace and project should be created. If not specified, the workspace will be created in the current directory." + "description": "The directory where the new workspace and project should be created. If not specified, the workspace will be created in a subfolder within the current directory, using the workspace's name." }, { "name": "dry-run", diff --git a/adev/src/content/cli/run.json b/adev/src/content/cli/run.json index 5468e6798ef9..c7a988c3b38d 100644 --- a/adev/src/content/cli/run.json +++ b/adev/src/content/cli/run.json @@ -3,7 +3,7 @@ "command": "ng run ", "shortDescription": "Runs an Architect target with an optional custom builder configuration defined in your project.", "longDescriptionRelativePath": "@angular/cli/src/commands/run/long-description.md", - "longDescription": "Architect is the tool that the CLI uses to perform complex tasks such as compilation, according to provided configurations.\nThe CLI commands run Architect targets such as `build`, `serve`, `test`, and `lint`.\nEach named target has a default configuration, specified by an `options` object,\nand an optional set of named alternate configurations in the `configurations` object.\n\nFor example, the `serve` target for a newly generated app has a predefined\nalternate configuration named `production`.\n\nYou can define new targets and their configuration options in the `architect` section\nof the `angular.json` file which you can run them from the command line using the `ng run` command.\n", + "longDescription": "Architect is the tool that the CLI uses to perform complex tasks such as compilation, according to provided configurations.\nThe CLI commands run Architect targets such as `build`, `serve`, `test`, and `lint`.\nEach named target has a default configuration, specified by an `options` object,\nand an optional set of named alternate configurations in the `configurations` object.\n\nFor example, the `serve` target for a newly generated app has a predefined\nalternate configuration named `production`.\n\nYou can define new targets and their configuration options in the `architect` section\nof the `angular.json` file, which you can run from the command line using the `ng run` command.\n", "aliases": [], "deprecated": false, "options": [ diff --git a/adev/src/content/cli/serve.json b/adev/src/content/cli/serve.json index a83453477e50..8fc3eef8fba2 100644 --- a/adev/src/content/cli/serve.json +++ b/adev/src/content/cli/serve.json @@ -44,7 +44,7 @@ { "name": "hmr", "type": "boolean", - "description": "Enable hot module replacement. Defaults to the value of 'liveReload'. Currently, only global and component stylesheets are supported." + "description": "Enable hot module replacement. Defaults to the value of 'liveReload'. Currently, global stylesheets, component stylesheets, and component templates are supported." }, { "name": "host", @@ -81,7 +81,7 @@ "name": "port", "type": "number", "default": 4200, - "description": "Port to listen on." + "description": "Port to listen on. The `PORT` environment variable, when set, takes precedence over this option." }, { "name": "prebundle", diff --git a/adev/src/content/cli/test.json b/adev/src/content/cli/test.json index 2897f410274f..fcf58abebf14 100644 --- a/adev/src/content/cli/test.json +++ b/adev/src/content/cli/test.json @@ -111,7 +111,7 @@ { "name": "output-file", "type": "string", - "description": "Specifies a file path for the test report, applying only to the first reporter. To configure output files for multiple reporters, use the tuple format `['reporter-name', { outputFile: '...' }]` within the `reporters` option. When not provided, output is written to the console." + "description": "Specifies a file path for the test report. This path is used by every configured reporter that writes to a file. To write a separate file for each reporter, use the tuple format `['reporter-name', { outputFile: '...' }]` within the `reporters` option. When not provided, output is written to the console." }, { "name": "progress",