GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing next.angular.dev — SeleniumWebDriverHarnessEnvironment • Angular

API

    
      class SeleniumWebDriverHarnessEnvironment extends HarnessEnvironment<  () => webdriver.WebElement> {}

@paramrawRootElement() => webdriver.WebElement

@paramoptionsWebDriverHarnessEnvironmentOptions | undefined

@returnsSeleniumWebDriverHarnessEnvironment

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.

@returnsPromise<void>

Gets the root element for the document.

@returns() => webdriver.WebElement

Creates a TestElement from a raw element.

@paramelement() => webdriver.WebElement

@returnsTestElement

Creates a HarnessLoader rooted at the given raw element.

@paramelement() => webdriver.WebElement

@returnsHarnessEnvironment<() => webdriver.WebElement>

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

@paramselectorstring

@returnsPromise<(() => webdriver.WebElement)[]>

The native root element of this HarnessEnvironment.

The root element of this HarnessEnvironment as a TestElement.

Gets a locator factory rooted at the document root.

@returnsLocatorFactory

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

@paramqueriesT

A list of queries specifying which harnesses and elements to search for:

A string searches for elements matching the CSS selector specified by the string.
A ComponentHarness constructor searches for ComponentHarness instances matching the given class.
A HarnessPredicate searches for ComponentHarness instances matching the given predicate.

@returns() => Promise<LocatorFnResult<T>>

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`

@paramqueriesT

A list of queries specifying which harnesses and elements to search for:

A string searches for elements matching the CSS selector specified by the string.
A ComponentHarness constructor searches for ComponentHarness instances matching the given class.
A HarnessPredicate searches for ComponentHarness instances matching the given predicate.

@returns() => Promise<LocatorFnResult<T> | 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')()

@paramqueriesT

A list of queries specifying which harnesses and elements to search for:

A string searches for elements matching the CSS selector specified by the string.
A ComponentHarness constructor searches for ComponentHarness instances matching the given class.
A HarnessPredicate searches for ComponentHarness instances matching the given predicate.

@returns() => Promise<LocatorFnResult<T>[]>

@returnsPromise<HarnessLoader>

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

@paramselectorstring

The selector for the root element.

@returnsPromise<HarnessLoader>

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

@paramselectorstring

The selector for the root element.

@returnsPromise<HarnessLoader | null>

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

@paramselectorstring

The selector for the root element.

@returnsPromise<HarnessLoader[]>

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.

@paramqueryHarnessQuery<T>