Interface HTMLElement

The representation of a HTML tag.

interface HTMLElement {
    index: number;
    name: string;
    request: Request;
    response: Response;
    text: string;
    attr(selector: string): undefined | string;
    childAttr(selector: string, aname: string): undefined | string;
    childAttrs(selector: string, aname: string): undefined | string[];
    childText(selector: string): string;
    childTexts(selector: string): string[];
    forEach(selector: string, cb: ForEachCallback): void;
    forEachWithBreak(selector: string, cb: ForEachWithBreakCallback): void;
}

Properties

index name request response text

Methods

attr childAttr childAttrs childText childTexts forEach forEachWithBreak

Properties

index

index: number

Stores the position of the current element within all the elements matched by an onHTML callback.

name

name: string

The name of the tag.

request

request: Request

The request object of the element's HTML document.

response

response: Response

The Response object of the element's HTML document.

text

text: string

The text content of the element.

Methods

attr

  • attr(selector: string): undefined | string

  • Returns the selected attribute of a HTMLElement or empty string if no attribute found.

    Parameters

    • selector: string

      attribure selector

    Returns undefined | string

childAttr

  • childAttr(selector: string, aname: string): undefined | string

  • Returns the stripped text content of the first matching element's attribute.

    Parameters

    • selector: string

      element selector

    • aname: string

      attribute name

    Returns undefined | string

childAttrs

  • childAttrs(selector: string, aname: string): undefined | string[]

  • Returns the stripped text content of all the matching element's attributes.

    Parameters

    • selector: string

      element selector

    • aname: string

      attribute name

    Returns undefined | string[]

childText

  • childText(selector: string): string

  • Returns the concatenated and stripped text content of the matching elements.

    Parameters

    • selector: string

      element selector

    Returns string

childTexts

  • childTexts(selector: string): string[]

  • Returns the stripped text content of all the matching elements.

    Parameters

    • selector: string

      element selector

    Returns string[]

forEach

  • forEach(selector: string, cb: ForEachCallback): void

  • Iterates over the elements matched by the first argument and calls the callback function on every HTMLElement match.

    Parameters

    Returns void

forEachWithBreak

  • forEachWithBreak(selector: string, cb: ForEachWithBreakCallback): void

  • Iterates over the elements matched by the first argument and calls the callback function on every HTMLElement match. It is identical to forEach except that it is possible to break out of the loop by returning false in the callback function.

    Parameters

    Returns void

Settings

On This Page

Properties
Methods