Class DomHandler

Event-based handler that builds a DOM tree from parser callbacks.

Index

Constructors

Properties

dom lastNode root tagStack

Methods

addNode handleCallback oncdataend oncdatastart onclosetag oncomment oncommentend onend onerror onopentag onparserinit onprocessinginstruction onreset ontext

Constructors

constructor

new DomHandler(
    callback?: Callback | null,
    options?: DomHandlerOptions | null,
    elementCB?: ElementCallback,
): DomHandler
Parameters
- Optionalcallback: Callback | null
  Called once parsing has completed.
- Optionaloptions: DomHandlerOptions | null
  Settings for the handler.
- OptionalelementCB: ElementCallback
  Callback whenever a tag is closed.
Returns DomHandler
- Defined in src/index.ts:94

Properties

dom

dom: ChildNode[] = []

The elements of the DOM

`Protected`lastNode

lastNode: DataNode | null = null

A data node that is still being written to.

root

root: Document = ...

The root element for the DOM

`Protected`tagStack

tagStack: ParentNode[] = ...

Stack of open tags.

Methods

`Protected`addNode

addNode(node: ChildNode): void
Parameters
- node: ChildNode
Returns void
- Defined in src/index.ts:216

`Protected`handleCallback

handleCallback(error: Error | null): void
Parameters
- error: Error | null
Returns void
- Defined in src/index.ts:208

oncdataend

oncdataend(): void
Returns void
- Defined in src/index.ts:199

oncdatastart

oncdatastart(): void
Returns void
- Defined in src/index.ts:189

onclosetag

onclosetag(): void
Returns void
- Defined in src/index.ts:140

oncomment

oncomment(data: string): void
Parameters
- data: string
Returns void
- Defined in src/index.ts:174

oncommentend

oncommentend(): void
Returns void
- Defined in src/index.ts:185

onend

onend(): void
Returns void
- Defined in src/index.ts:129

onerror

onerror(error: Error): void
Parameters
- error: Error
Returns void
- Defined in src/index.ts:136

onopentag

onopentag(name: string, attribs: { [key: string]: string }): void
Parameters
- name: string
- attribs: { [key: string]: string }
Returns void
- Defined in src/index.ts:152

onparserinit

onparserinit(parser: ParserInterface): void
Parameters
- parser: ParserInterface
Returns void
- Defined in src/index.ts:114

onprocessinginstruction

onprocessinginstruction(name: string, data: string): void
Parameters
- name: string
- data: string
Returns void
- Defined in src/index.ts:203

onreset

onreset(): void
Returns void
- Defined in src/index.ts:119

ontext

ontext(data: string): void
Parameters
- data: string
Returns void
- Defined in src/index.ts:159