Trilium Backend API
    Preparing search index...

    Class Document

    The root node of the document.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    children endIndex next parent prev sourceCodeLocation? startIndex type x-mode?

    Accessors

    childNodes firstChild lastChild nextSibling nodeType parentNode previousSibling

    Methods

    cloneNode

    Constructors

    Properties

    children: ChildNode[]
    endIndex: number

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

    next: ChildNode

    Next sibling

    parent: ParentNode

    Parent of the node

    prev: ChildNode

    Previous sibling

    sourceCodeLocation?: SourceCodeLocation

    parse5 source code location info.

    Available if parsing with parse5 and location info is enabled.

    startIndex: number

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

    type: Root

    The type of the node.

    "x-mode"?: "no-quirks" | "quirks" | "limited-quirks"

    Document mode (parse5 only).

    Accessors

    • get childNodes(): ChildNode[]

      Same as children. DOM spec-compatible alias.

      Returns ChildNode[]

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

      Parameters

      Returns void

    • get firstChild(): ChildNode

      First child of the node.

      Returns ChildNode

    • get lastChild(): ChildNode

      Last child of the node.

      Returns ChildNode

    • get nextSibling(): ChildNode

      Same as next. DOM spec-compatible alias.

      Returns ChildNode

    • set nextSibling(next: ChildNode): void

      Parameters

      Returns void

    • get nodeType(): 9

      DOM spec-compatible node type.

      Returns 9

    • get parentNode(): ParentNode

      Same as parent. DOM spec-compatible alias.

      Returns ParentNode

    • set parentNode(parent: ParentNode): void

      Parameters

      Returns void

    • get previousSibling(): ChildNode

      Same as prev. DOM spec-compatible alias.

      Returns ChildNode

    • set previousSibling(prev: ChildNode): void

      Parameters

      Returns void

    Methods

    • Clone this node, and optionally its children.

      Type Parameters

      Parameters

      • this: T
      • Optionalrecursive: boolean

        Clone child nodes as well.

      Returns T

      A clone of the node.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods