TestbedHarnessEnvironment

Flushes change detection and async tasks captured in the Angular zone. In most cases it should not be necessary to call this manually. However, there may be some edge cases where it is needed to fully flush animation events.

Waits for all scheduled or running async tasks to complete. This allows harness authors to wait for async tasks outside of the Angular zone.

This only works when Zone.js is present and patches are applied to the test framework by zone.js/testing (Jasmine and Jest only) or another script.

Gets the root element for the document.

Creates a TestElement from a raw element.

Creates a HarnessLoader rooted at the given raw element.

Gets a list of all elements matching the given selector under this environment's root element.

Gets a locator factory rooted at the document root.

Creates an asynchronous locator function that can be used to find a ComponentHarness instance or element under the root element of this HarnessEnvironment.

For example, given the following DOM and assuming DivHarness.hostSelector is 'div'

<div id="d1"></div><div id="d2"></div>

then we expect:

await lf.locatorFor(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1
await lf.locatorFor('div', DivHarness)() // Gets a `TestElement` instance for #d1
await lf.locatorFor('span')()            // Throws because the `Promise` rejects

Creates an asynchronous locator function that can be used to find a ComponentHarness instance or element under the root element of this HarnessEnvironmnet.

For example, given the following DOM and assuming DivHarness.hostSelector is 'div'

<div id="d1"></div><div id="d2"></div>

then we expect:

await lf.locatorForOptional(DivHarness, 'div')() // Gets a `DivHarness` instance for #d1
await lf.locatorForOptional('div', DivHarness)() // Gets a `TestElement` instance for #d1
await lf.locatorForOptional('span')()            // Gets `null`

Creates an asynchronous locator function that can be used to find ComponentHarness instances or elements under the root element of this HarnessEnvironment.

For example, given the following DOM and assuming DivHarness.hostSelector is 'div' and IdIsD1Harness.hostSelector is '#d1'

<div id="d1"></div><div id="d2"></div>

then we expect:

// Gets [DivHarness for #d1, TestElement for #d1, DivHarness for #d2, TestElement for #d2]
await lf.locatorForAll(DivHarness, 'div')()
// Gets [TestElement for #d1, TestElement for #d2]
await lf.locatorForAll('div', '#d1')()
// Gets [DivHarness for #d1, IdIsD1Harness for #d1, DivHarness for #d2]
await lf.locatorForAll(DivHarness, IdIsD1Harness)()
// Gets []
await lf.locatorForAll('span')()

Gets a HarnessLoader instance for an element under the root of this HarnessEnvironment.

Gets a HarnessLoader instance for an element under the root of this HarnessEnvironment.

Gets a list of HarnessLoader instances, one for each matching element.

Searches for an instance of the component corresponding to the given harness type under the HarnessEnvironment's root element, and returns a ComponentHarness for that instance. If multiple matching components are found, a harness for the first one is returned. If no matching component is found, an error is thrown.

Searches for an instance of the component corresponding to the given harness type under the HarnessEnvironment's root element, and returns a ComponentHarness for that instance. If multiple matching components are found, a harness for the first one is returned. If no matching component is found, null is returned.

Searches for an instance of the component corresponding to the given harness type and index under the HarnessEnvironment's root element, and returns a ComponentHarness for that instance. The index specifies the offset of the component to find. If no matching component is found at that index, an error is thrown.

Searches for all instances of the component corresponding to the given harness type under the HarnessEnvironment's root element, and returns a list ComponentHarness for each instance.

Searches for all instance of the component corresponding to the given harness type under the HarnessEnvironment's root element, and returns the number that were found.

Searches for an instance of the component corresponding to the given harness type under the HarnessEnvironment's root element, and returns a boolean indicating if any were found.

Searches for an element with the given selector under the evironment's root element, and returns a HarnessLoader rooted at the matching element. If multiple elements match the selector, the first is used. If no elements match, an error is thrown.

Searches for all elements with the given selector under the environment's root element, and returns an array of HarnessLoaders, one for each matching element, rooted at that element.

Creates a ComponentHarness for the given harness type with the given raw host element.

Creates a HarnessLoader rooted at the given fixture's root element.

Creates a HarnessLoader at the document root. This can be used if harnesses are located outside of a fixture (e.g. overlays appended to the document body).

Gets the native DOM element corresponding to the given TestElement.

Creates an instance of the given harness type, using the fixture's root element as the harness's host element. This method should be used when creating a harness for the root element of a fixture, as components do not have the correct selector when they are created as the root of the fixture.