Class ComponentHarnessSuperclass

Protected ReadonlylocatorFactory

ProtecteddocumentRootLocatorFactory

• documentRootLocatorFactory(): LocatorFactory

  Gets a LocatorFactory for the document root element. This factory can be used to create locators for elements that a component creates outside of its own root element. (e.g. by appending to document.body).

  Returns LocatorFactory

ProtectedforceStabilize

• forceStabilize(): Promise<void>

  Flushes change detection and async tasks 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.

  Returns Promise<void>

ProtectedgetRootHarnessLoader

• getRootHarnessLoader(): Promise<HarnessLoader>

  Gets the root harness loader from which to start searching for content contained by this harness.

  Returns Promise<HarnessLoader>

ProtectedlocatorFor

• locatorFor<T extends (string | HarnessQuery<any>)[]>(
      ...queries: T,
  ): () => Promise<LocatorFnResult<T>>

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

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

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

  then we expect:

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

  Type Parameters

  • T extends (string | HarnessQuery<any>)[]

  Parameters

  • ...queries: T

    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>>

  An asynchronous locator function that searches for and returns a Promise for the first element or harness matching the given search criteria. Matches are ordered first by order in the DOM, and second by order in the queries list. If no matches are found, the Promise rejects. The type that the Promise resolves to is a union of all result types for each query.

ProtectedlocatorForAll

• locatorForAll<T extends (string | HarnessQuery<any>)[]>(
      ...queries: T,
  ): () => Promise<LocatorFnResult<T>[]>

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

  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>
  Copy

  then we expect:

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

  Type Parameters

  • T extends (string | HarnessQuery<any>)[]

  Parameters

  • ...queries: T

    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>[]>

  An asynchronous locator function that searches for and returns a Promise for all elements and harnesses matching the given search criteria. Matches are ordered first by order in the DOM, and second by order in the queries list. If an element matches more than one ComponentHarness class, the locator gets an instance of each for the same element. If an element matches multiple string selectors, only one TestElement instance is returned for that element. The type that the Promise resolves to is an array where each element is the union of all result types for each query.

ProtectedlocatorForOptional

• locatorForOptional<T extends (string | HarnessQuery<any>)[]>(
      ...queries: T,
  ): () => Promise<null | LocatorFnResult<T>>

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

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

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

  then we expect:

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

  Type Parameters

  • T extends (string | HarnessQuery<any>)[]

  Parameters

  • ...queries: T

    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<null | LocatorFnResult<T>>

  An asynchronous locator function that searches for and returns a Promise for the first element or harness matching the given search criteria. Matches are ordered first by order in the DOM, and second by order in the queries list. If no matches are found, the Promise is resolved with null. The type that the Promise resolves to is a union of all result types for each query or null.

ProtectedwaitForTasksOutsideAngular

• waitForTasksOutsideAngular(): Promise<void>

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

  Returns Promise<void>