puppeteer/docs/api/puppeteer.elementhandle.toelement.md
jrandolf c7a063a152
feat: add element validation (#9352)
This PR adds a method to ElementHandle that validates the tag type of
that handle and returns it.

Fixed: #8579, #9280
2022-12-19 13:25:56 +01:00

1.0 KiB

sidebar_label
ElementHandle.toElement

ElementHandle.toElement() method

Converts the current handle to the given element type.

Signature:

class ElementHandle {
  toElement<K extends keyof HTMLElementTagNameMap | keyof SVGElementTagNameMap>(
    tagName: K
  ): Promise<HandleFor<ElementFor<K>>>;
}

Parameters

Parameter Type Description
tagName K The tag name of the desired element type.

Returns:

Promise<HandleFor<ElementFor<K>>>

Exceptions

An error if the handle does not match. The handle will not be automatically disposed.

Example

const element: ElementHandle<Element> = await page.$('.class-name-of-anchor');
// DO NOT DISPOSE `element`, this will be always be the same handle.
const anchor: ElementHandle<HTMLAnchorElement> = await element.toElement('a');