mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
3c9fd4a692
* Added new types for domelementtype * Modify existing types for htmlparser2 * Updating PULL_REQUEST_TEMPLATE.md * Revert changes to .github/PULL_REQUEST_TEMPLATE.md * Fixed missing optional * Adding DomUtils * Update dependencies * Removed requirement for TypeScript 2.1 and updated test * Updated test to include DomUtils and DomHandlerOptions. * Updated domhandler tests * Remove incorrect constructor in Parser * Remove incorrect constructor in WritableStream * Change way of importing in tests * Adding deprecated fallback to Options * Add deprecated Options as a fallback to sanitize-html * Add ParserOptions * Use the deprecated Options
127 lines
4.9 KiB
TypeScript
127 lines
4.9 KiB
TypeScript
// Type definitions for domutils 1.7
|
|
// Project: https://github.com/FB55/domutils#readme
|
|
// Definitions by: Johan Davidsson <https://github.com/johandavidson>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
import { DomElement } from "domhandler";
|
|
/***
|
|
* Append an element after another
|
|
*
|
|
* @argument elem The element to append to
|
|
* @argument next The element be added
|
|
*/
|
|
export function append(elem: DomElement, next: DomElement): void;
|
|
/***
|
|
* Append a child to an element
|
|
*
|
|
* @argument elem The element to append to
|
|
* @argument child The element to be added as a child
|
|
*/
|
|
export function appendChild(elem: DomElement, child: DomElement): void;
|
|
/***
|
|
* Compare the position of one node against another node in any other document.
|
|
* The return value is a bitmask with the following values:
|
|
*
|
|
* document order:
|
|
* > There is an ordering, document order, defined on all the nodes in the
|
|
* > document corresponding to the order in which the first character of the
|
|
* > XML representation of each node occurs in the XML representation of the
|
|
* > document after expansion of general entities. Thus, the document element
|
|
* > node will be the first node. Element nodes occur before their children.
|
|
* > Thus, document order orders element nodes in order of the occurrence of
|
|
* > their start-tag in the XML (after expansion of entities). The attribute
|
|
* > nodes of an element occur after the element and before its children. The
|
|
* > relative order of attribute nodes is implementation-dependent./
|
|
*
|
|
* Source:
|
|
* http://www.w3.org/TR/DOM-Level-3-Core/glossary.html#dt-document-order
|
|
* @argument nodaA The first node to use in the comparison
|
|
* @argument nodeB The second node to use in the comparison
|
|
*
|
|
* @return A bitmask describing the input nodes' relative position.
|
|
*
|
|
* See http://dom.spec.whatwg.org/#dom-node-comparedocumentposition for
|
|
* a description of these values.
|
|
*/
|
|
export function compareDocumentPosition(nodeA: DomElement, nodeB: DomElement): number;
|
|
export function existsOne(test: any, elems: DomElement[]): boolean;
|
|
export function filter(test: any, element: DomElement, recurse: boolean, limit: number): DomElement[];
|
|
export function find(test: any, elems: DomElement[], recurse: boolean, limit: number): DomElement[];
|
|
export function findAll(test: any, rootElems: DomElement[]): DomElement[];
|
|
export function findOne(test: any, elems: DomElement[]): DomElement;
|
|
export function findOneChild(test: any, elems: DomElement[]): DomElement;
|
|
export function getAttributeValue(elem: DomElement, name: string): string;
|
|
export function getChildren(elem: DomElement): DomElement[];
|
|
/***
|
|
* Legacy
|
|
*/
|
|
export function getElementById(id: any, element: any, recurse?: any): any;
|
|
/***
|
|
* Legacy
|
|
*/
|
|
export function getElements(options: any, element: any, recurse?: any, limit?: any): any;
|
|
/***
|
|
* Legacy
|
|
*/
|
|
export function getElementsByTagName(name: any, element: any, recurse?: any, limit?: any): any;
|
|
/***
|
|
* Legacy
|
|
*/
|
|
export function getElementsByTagType(type: any, element: any, recurse?: any, limit?: any): any;
|
|
export function getInnerHTML(elem: DomElement, opts: any): string;
|
|
/***
|
|
* Returns the name property of an element
|
|
*
|
|
* @argument elem The element to get the name for
|
|
*/
|
|
export function getName(elem: DomElement): string;
|
|
/***
|
|
* Returns a string representing the array of DomElements
|
|
*
|
|
* @argument dom An array of DomElement that should be stringified
|
|
* @argument [opts] Optional options object
|
|
*/
|
|
export function getOuterHTML(dom: DomElement[], opts?: { decodeEntities?: boolean, xmlMode?: boolean}): string;
|
|
export function getParent(elem: DomElement): DomElement;
|
|
export function getSiblings(elem: DomElement): DomElement[];
|
|
export function getText(elem: DomElement): string;
|
|
export function hasAttrib(elem: DomElement, name: string): boolean;
|
|
export function isTag(elem: DomElement): boolean;
|
|
/***
|
|
* Prepend an element before another
|
|
*
|
|
* @argument elem The element to append to
|
|
* @argument prev The element be added
|
|
*/
|
|
export function prepend(elem: DomElement, prev: DomElement): void;
|
|
/***
|
|
* Remove an element from the dom
|
|
*
|
|
* @argument elem The element to be removed
|
|
*/
|
|
export function removeElement(elem: DomElement): void;
|
|
/***
|
|
* Given an array of nodes, remove any member that is contained by another.
|
|
*/
|
|
export function removeSubsets(nodes: DomElement[]): DomElement[];
|
|
/***
|
|
* Replace an element in the dom
|
|
*
|
|
* @argument elem The element to be replaced
|
|
* @argument replacement The element to be added
|
|
*/
|
|
export function replaceElement(elem: DomElement, replacement: DomElement): void;
|
|
/***
|
|
* Legacy
|
|
*/
|
|
export function testElement(options: any, element: any): any;
|
|
/***
|
|
* Sort an array of nodes based on their relative position in the document and
|
|
* remove any duplicate nodes. If the array contains nodes that do not belong
|
|
* to the same document, sort order is unspecified.
|
|
*
|
|
* @argument nodes Array of DOM nodes
|
|
* @returns collection of unique nodes, sorted in document order
|
|
*/
|
|
export function uniqueSort(nodes: DomElement[]): DomElement[];
|