Class JsdomAdaptor

The JsdomAdaptor class

Hierarchy (View Summary)

HTMLAdaptor<HTMLElement, Text, Document, this>
- JsdomAdaptor

Properties

canMeasureNodes

canMeasureNodes: boolean = true

The HTML adaptor can measure DOM node sizes

document

document: Document

The document in which the HTML nodes will be created

parser

parser: MinDOMParser<Document>

The DOMParser used to parse a string into a DOM tree

window

window: MinWindow<HTMLElement, Document>

The window object for this adaptor

Methods

addClass

addClass(node: HTMLElement, name: string): void
Parameters
- node: HTMLElement
- name: string
Returns void
Inherited from HTMLAdaptor.addClass
- Defined in ts/adaptors/HTMLAdaptor.ts:505

allAttributes

allAttributes(node: HTMLElement): AttributeData[]
Parameters
- node: HTMLElement
Returns AttributeData[]
Inherited from HTMLAdaptor.allAttributes
- Defined in ts/adaptors/HTMLAdaptor.ts:496

allClasses

allClasses(node: HTMLElement): string[]
Parameters
- node: HTMLElement
Returns string[]
Inherited from HTMLAdaptor.allClasses
- Defined in ts/core/DOMAdaptor.ts:720

allStyles

allStyles(node: HTMLElement): any
Parameters
- node: HTMLElement
Returns any
Inherited from HTMLAdaptor.allStyles
- Defined in ts/adaptors/HTMLAdaptor.ts:554

append

append(node: HTMLElement, child: HTMLElement | Text): HTMLElement | Text
Parameters
- node: HTMLElement
- child: HTMLElement | Text
Returns HTMLElement | Text
Inherited from HTMLAdaptor.append
- Defined in ts/adaptors/HTMLAdaptor.ts:336

body

body(doc?: Document): HTMLElement
Parameters
- doc: Document = ...
Returns HTMLElement
Inherited from HTMLAdaptor.body
- Defined in ts/adaptors/HTMLAdaptor.ts:260

childNode

childNode(node: HTMLElement, i: number): HTMLElement | Text
Parameters
- node: HTMLElement
- i: number
Returns HTMLElement | Text
Inherited from HTMLAdaptor.childNode
- Defined in ts/adaptors/HTMLAdaptor.ts:413

childNodes

childNodes(node: HTMLElement): (HTMLElement | Text)[]
Parameters
- node: HTMLElement
Returns (HTMLElement | Text)[]
Inherited from HTMLAdaptor.childNodes
- Defined in ts/adaptors/HTMLAdaptor.ts:406

clone

clone(node: HTMLElement, deep?: boolean): HTMLElement
Parameters
- node: HTMLElement
- deep: boolean = true
Returns HTMLElement
Inherited from HTMLAdaptor.clone
- Defined in ts/adaptors/HTMLAdaptor.ts:364

contains

contains(container: HTMLElement, node: HTMLElement | Text): boolean
Parameters
- container: HTMLElement
- node: HTMLElement | Text
Returns boolean
Inherited from HTMLAdaptor.contains
- Defined in ts/adaptors/HTMLAdaptor.ts:322

`Protected`create

create(kind: string, ns?: string): HTMLElement
Parameters
- kind: string
- Optionalns: string
Returns HTMLElement
Inherited from HTMLAdaptor.create
- Defined in ts/adaptors/HTMLAdaptor.ts:237

createWorker

createWorker(
listener: (event: any) => void,
options: OptionList,
): Promise<Worker>
Parameters
- listener: (event: any) => void
- options: OptionList
Returns Promise<Worker>
Inherited from HTMLAdaptor.createWorker
- Defined in ts/adaptors/HTMLAdaptor.ts:622

cssText

cssText(node: HTMLElement): string
Parameters
- node: HTMLElement
Returns string
Inherited from HTMLAdaptor.cssText
- Defined in ts/adaptors/HTMLAdaptor.ts:574

doctype

doctype(doc?: Document): string
Parameters
- doc: Document = ...
Returns string
Inherited from HTMLAdaptor.doctype
- Defined in ts/adaptors/HTMLAdaptor.ts:274

firstChild

firstChild(node: HTMLElement): HTMLElement | Text
Parameters
- node: HTMLElement
Returns HTMLElement | Text
Inherited from HTMLAdaptor.firstChild
- Defined in ts/adaptors/HTMLAdaptor.ts:392

fontFamily

fontFamily(node: HTMLElement): any
Parameters
- node: HTMLElement
Returns any
Inherited from HTMLAdaptor.fontFamily
- Defined in ts/adaptors/HTMLAdaptor.ts:594

getAttribute

getAttribute(node: HTMLElement, name: string): string
Parameters
- node: HTMLElement
- name: string
Returns string
Inherited from HTMLAdaptor.getAttribute
- Defined in ts/adaptors/HTMLAdaptor.ts:475

getElement

getElement(selector: string, node?: Document | HTMLElement): HTMLElement
Parameters
- selector: string
- node: Document | HTMLElement = ...
Returns HTMLElement
Inherited from HTMLAdaptor.getElement
- Defined in ts/adaptors/HTMLAdaptor.ts:315

getElements

getElements(
nodes: (string | HTMLElement | HTMLElement[])[],
_document: Document,
): HTMLElement[]
Parameters
- nodes: (string | HTMLElement | HTMLElement[])[]
- _document: Document
Returns HTMLElement[]
Inherited from HTMLAdaptor.getElements
- Defined in ts/adaptors/HTMLAdaptor.ts:291

getProperty

getProperty(node: HTMLElement, name: string): any
Parameters
- node: HTMLElement
- name: string
Returns any
Inherited from HTMLAdaptor.getProperty
- Defined in ts/core/DOMAdaptor.ts:498

getStyle

getStyle(node: HTMLElement, name: string): any
Parameters
- node: HTMLElement
- name: string
Returns any
Inherited from HTMLAdaptor.getStyle
- Defined in ts/adaptors/HTMLAdaptor.ts:547

hasAttribute

hasAttribute(node: HTMLElement, name: string): boolean
Parameters
- node: HTMLElement
- name: string
Returns boolean
Inherited from HTMLAdaptor.hasAttribute
- Defined in ts/adaptors/HTMLAdaptor.ts:489

hasClass

hasClass(node: HTMLElement, name: string): boolean
Parameters
- node: HTMLElement
- name: string
Returns boolean
Inherited from HTMLAdaptor.hasClass
- Defined in ts/adaptors/HTMLAdaptor.ts:530

head

head(doc?: Document): HTMLElement
Parameters
- doc: Document = ...
Returns HTMLElement
Inherited from HTMLAdaptor.head
- Defined in ts/adaptors/HTMLAdaptor.ts:253

innerHTML

innerHTML(node: HTMLElement): string
Parameters
- node: HTMLElement
Returns string
Inherited from HTMLAdaptor.innerHTML
- Defined in ts/adaptors/HTMLAdaptor.ts:442

insert

insert(nchild: HTMLElement | Text, ochild: HTMLElement | Text): void
Parameters
- nchild: HTMLElement | Text
- ochild: HTMLElement | Text
Returns void
Inherited from HTMLAdaptor.insert
- Defined in ts/adaptors/HTMLAdaptor.ts:343

insertRules

insertRules(node: HTMLElement, rules: string[]): void
Parameters
- node: HTMLElement
- rules: string[]
Returns void
Inherited from HTMLAdaptor.insertRules
- Defined in ts/adaptors/HTMLAdaptor.ts:561

kind

kind(node: HTMLElement | Text): string
Parameters
- node: HTMLElement | Text
Returns string
Inherited from HTMLAdaptor.kind
- Defined in ts/adaptors/HTMLAdaptor.ts:420

lastChild

lastChild(node: HTMLElement): HTMLElement | Text
Parameters
- node: HTMLElement
Returns HTMLElement | Text
Inherited from HTMLAdaptor.lastChild
- Defined in ts/adaptors/HTMLAdaptor.ts:399

next(node: HTMLElement | Text): HTMLElement | Text
Parameters
- node: HTMLElement | Text
Returns HTMLElement | Text
Inherited from HTMLAdaptor.next
- Defined in ts/adaptors/HTMLAdaptor.ts:378

node

node(
    kind: string,
    def?: OptionList,
    children?: (HTMLElement | Text)[],
    ns?: string,
): HTMLElement
Parameters
- kind: string
- def: OptionList = {}
- children: (HTMLElement | Text)[] = []
- Optionalns: string
Returns HTMLElement
Inherited from HTMLAdaptor.node
- Defined in ts/core/DOMAdaptor.ts:462

nodeBBox

nodeBBox(
node: HTMLElement,
): { bottom: number; left: number; right: number; top: number }
Parameters
- node: HTMLElement
Returns { bottom: number; left: number; right: number; top: number }
Inherited from HTMLAdaptor.nodeBBox
- Defined in ts/adaptors/HTMLAdaptor.ts:613

nodeSize

nodeSize(node: HTMLElement, em?: number, local?: boolean): [number, number]
Parameters
- node: HTMLElement
- em: number = 1
- local: boolean = false
Returns [number, number]
Inherited from HTMLAdaptor.nodeSize
- Defined in ts/adaptors/HTMLAdaptor.ts:602

outerHTML

outerHTML(node: HTMLElement): string
Parameters
- node: HTMLElement
Returns string
Inherited from HTMLAdaptor.outerHTML
- Defined in ts/adaptors/HTMLAdaptor.ts:449

parent

parent(node: HTMLElement | Text): HTMLElement
Parameters
- node: HTMLElement | Text
Returns HTMLElement
Inherited from HTMLAdaptor.parent
- Defined in ts/adaptors/HTMLAdaptor.ts:329

parse

parse(text: string, format?: string): Document
Parameters
- text: string
- format: string = 'text/html'
Returns Document
Inherited from HTMLAdaptor.parse
- Defined in ts/adaptors/HTMLAdaptor.ts:230

previous(node: HTMLElement | Text): HTMLElement | Text
Parameters
- node: HTMLElement | Text
Returns HTMLElement | Text
Inherited from HTMLAdaptor.previous
- Defined in ts/adaptors/HTMLAdaptor.ts:385

remove

remove(child: HTMLElement | Text): HTMLElement | Text
Parameters
- child: HTMLElement | Text
Returns HTMLElement | Text
Inherited from HTMLAdaptor.remove
- Defined in ts/adaptors/HTMLAdaptor.ts:350

removeAttribute

removeAttribute(node: HTMLElement, name: string): void
Parameters
- node: HTMLElement
- name: string
Returns void
Inherited from HTMLAdaptor.removeAttribute
- Defined in ts/adaptors/HTMLAdaptor.ts:482

removeClass

removeClass(node: HTMLElement, name: string): void
Parameters
- node: HTMLElement
- name: string
Returns void
Inherited from HTMLAdaptor.removeClass
- Defined in ts/adaptors/HTMLAdaptor.ts:516

replace

replace(
nnode: HTMLElement | Text,
onode: HTMLElement | Text,
): HTMLElement | Text
Parameters
- nnode: HTMLElement | Text
- onode: HTMLElement | Text
Returns HTMLElement | Text
Inherited from HTMLAdaptor.replace
- Defined in ts/adaptors/HTMLAdaptor.ts:357

root

root(doc?: Document): HTMLElement
Parameters
- doc: Document = ...
Returns HTMLElement
Inherited from HTMLAdaptor.root
- Defined in ts/adaptors/HTMLAdaptor.ts:267

serializeXML

serializeXML(node: HTMLElement): string
Parameters
- node: HTMLElement
Returns string
Inherited from HTMLAdaptor.serializeXML
- Defined in ts/adaptors/HTMLAdaptor.ts:456

setAttribute

setAttribute(node: HTMLElement, name: string, value: string, ns?: string): void
Parameters
- node: HTMLElement
- name: string
- value: string
- ns: string = null
Returns void
Inherited from HTMLAdaptor.setAttribute
- Defined in ts/adaptors/HTMLAdaptor.ts:464

setAttributes

setAttributes(node: HTMLElement, def: OptionList): void
Parameters
- node: HTMLElement
  The HTML element whose attributes are to be set
- def: OptionList
  The attributes to set on that node
Returns void
Inherited from HTMLAdaptor.setAttributes
- Defined in ts/core/DOMAdaptor.ts:506

setProperty

setProperty(node: HTMLElement, name: string, value: any): void
Parameters
- node: HTMLElement
- name: string
- value: any
Returns void
Inherited from HTMLAdaptor.setProperty
- Defined in ts/core/DOMAdaptor.ts:491

setStyle

setStyle(node: HTMLElement, name: string, value: string): void
Parameters
- node: HTMLElement
- name: string
- value: string
Returns void
Inherited from HTMLAdaptor.setStyle
- Defined in ts/adaptors/HTMLAdaptor.ts:540

split

split(node: Text, n: number): Text
Parameters
- node: Text
- n: number
Returns Text
Inherited from HTMLAdaptor.split
- Defined in ts/adaptors/HTMLAdaptor.ts:371

text

text(text: string): Text
Parameters
- text: string
Returns Text
Inherited from HTMLAdaptor.text
- Defined in ts/adaptors/HTMLAdaptor.ts:246

textContent

textContent(node: HTMLElement): string
Parameters
- node: HTMLElement
Returns string
Inherited from HTMLAdaptor.textContent
- Defined in ts/adaptors/HTMLAdaptor.ts:435

value

value(node: HTMLElement | Text): string
Parameters
- node: HTMLElement | Text
Returns string
Inherited from HTMLAdaptor.value
- Defined in ts/adaptors/HTMLAdaptor.ts:428

Class JsdomAdaptor

Hierarchy (View Summary)

Index

Properties

Methods

Properties

canMeasureNodes

document

parser

window

Methods

addClass

Parameters

Returns void

allAttributes

Parameters

Returns AttributeData[]

allClasses

Parameters

Returns string[]

allStyles

Parameters

Returns any

append

Parameters

Returns HTMLElement | Text

body

Parameters

Returns HTMLElement

childNode

Parameters

Returns HTMLElement | Text

childNodes

Parameters

Returns (HTMLElement | Text)[]

clone

Parameters

Returns HTMLElement

contains

Parameters

Returns boolean

Protectedcreate

Parameters

Returns HTMLElement

createWorker

Parameters

Returns Promise<Worker>

cssText

Parameters

Returns string

doctype

Parameters

Returns string

firstChild

Parameters

Returns HTMLElement | Text

fontFamily

Parameters

Returns any

fontSize

Parameters

Returns number

getAttribute

Parameters

Returns string

getElement

Parameters

Returns HTMLElement

getElements

Parameters

Returns HTMLElement[]

getProperty

Parameters

Returns any

getStyle

Parameters

Returns any

hasAttribute

Parameters

Returns boolean

`Protected`create