Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Element

Re-exporting all of the node types.

Hierarchy

  • NodeWithChildren
    • Element

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Element(name: string, attribs: {}, children?: ChildNode[], type?: Script | Style | Tag): Element

  • Parameters

    • name: string

      Name of the tag, eg. div, span.

    • attribs: {}

      Object mapping attribute names to attribute values.

      • [name: string]: string
    • Optional children: ChildNode[]

      Children of the node.

    • Optional type: Script | Style | Tag

    Returns Element

Properties

attribs

attribs: {}

Type declaration

  • [name: string]: string

children

children: ChildNode[]

endIndex

endIndex: null | number

The end index of the node. Requires withEndIndices on the handler to be `true.

name

name: string

Optional namespace

namespace?: string

Element namespace (parse5 only).

next

next: null | ChildNode

Next sibling

parent

parent: null | ParentNode

Parent of the node

prev

prev: null | ChildNode

Previous sibling

Optional sourceCodeLocation

sourceCodeLocation?: null | TagSourceCodeLocation

parse5 source code location info, with start & end tags.

Available if parsing with parse5 and location info is enabled.

startIndex

startIndex: null | number

The start index of the node. Requires withStartIndices on the handler to be `true.

type

type: Script | Style | Tag

Optional x-attribsNamespace

x-attribsNamespace?: Record<string, string>

Element attribute namespaces (parse5 only).

Optional x-attribsPrefix

x-attribsPrefix?: Record<string, string>

Element attribute namespace-related prefixes (parse5 only).

Accessors

attributes

  • get attributes(): Attribute[]

  • Returns Attribute[]

childNodes

  • get childNodes(): ChildNode[]
  • set childNodes(children: ChildNode[]): void

  • Same as children. DOM spec-compatible alias.

    Returns ChildNode[]

  • Same as children. DOM spec-compatible alias.

    Parameters

    • children: ChildNode[]

    Returns void

firstChild

  • get firstChild(): null | ChildNode

  • First child of the node.

    Returns null | ChildNode

lastChild

  • get lastChild(): null | ChildNode

  • Last child of the node.

    Returns null | ChildNode

nextSibling

  • get nextSibling(): null | ChildNode
  • set nextSibling(next: null | ChildNode): void

  • Same as next. DOM spec-compatible alias.

    Returns null | ChildNode

  • Same as next. DOM spec-compatible alias.

    Parameters

    • next: null | ChildNode

    Returns void

nodeType

  • get nodeType(): 1

  • Returns 1

parentNode

  • Same as parent. DOM spec-compatible alias.

    Returns null | ParentNode

  • Same as parent. DOM spec-compatible alias.

    Parameters

    Returns void

previousSibling

  • get previousSibling(): null | ChildNode
  • set previousSibling(prev: null | ChildNode): void

  • Same as prev. DOM spec-compatible alias.

    Returns null | ChildNode

  • Same as prev. DOM spec-compatible alias.

    Parameters

    • prev: null | ChildNode

    Returns void

tagName

  • get tagName(): string
  • set tagName(name: string): void

  • Same as name. DOM spec-compatible alias.

    Returns string

  • Same as name. DOM spec-compatible alias.

    Parameters

    • name: string

    Returns void

Methods

cloneNode

  • cloneNode<T>(this: T, recursive?: boolean): T

  • Clone this node, and optionally its children.

    Type parameters

    Parameters

    • this: T
    • Optional recursive: boolean

      Clone child nodes as well.

    Returns T

    A clone of the node.