mutation-summary/dist/types/Summary.d.ts

Makes observing the DOM fast and easy

import { IStringMap } from "./IStringMap";
import { MutationProjection } from "./MutationProjection";
import { IQuery } from "./IQuery";
/**
 * Represents a set of changes made to the DOM.
 */
export declare class Summary {
    private projection;
    /**
     * All elements presently in the subtree and having the given attribute, but
     * that were not in the subtree, lacked the given attribute, or both.
     */
    added: Node[];
    /**
     * All elements previously in the subtree and having the given attribute, but
     * that now are not in the subtree, lack the given attribute or both
     */
    removed: Node[];
    /**
     * All nodes that were moved from one parent to another.
     */
    reparented: Node[] | undefined;
    /**
     * All nodes that are still in the subtree and still have their same
     * parent, but that have been reordered within the child list of their
     * parent.
     */
    reordered: Node[] | undefined;
    /**
     * All elements previously and presently in the subtree and previously and
     * presently having the given attribute, for whom the value of the given
     * attribute change.
     */
    valueChanged: Node[] | undefined;
    /**
     * An object reporting attribute value changes. The object contains one key
     * for each attribute name contained in `elementAttributes`. The value of
     * each key is an array of elements previously & presently in the subtree and
     * previously & presently matching at least one pattern for whom the
     * corresponding attribute changed value.
     */
    attributeChanged: IStringMap<Element[]> | undefined;
    /**
     * All characterData nodes previously & presently whose value changed.
     */
    characterDataChanged: Node[] | undefined;
    /**
     * Creates a new Summary instance given a [[MutationProjection]] and the
     * [[IQuery]] that was responsible for this summary being generated.
     *
     * @param projection The projection containing the changes.
     * @param query The query that cause the summary to be created.
     */
    constructor(projection: MutationProjection, query: IQuery);
    /**
     * Will retrieve the previous parentNode for and node. The node must be
     * contained in the removed element array, otherwise the function throws an
     * error.
     *
     * @param node The node to get the previous parent for.
     */
    getOldParentNode(node: Node): Node;
    /**
     * Retrieves the previous value of an attribute for an element. The Element
     * must be contained in the valueChanged element array, otherwise the
     * function throws an error.
     *
     * @param element The element to ge the old value for.
     * @param name The name off the attribute on the element to get the old value
     * for.
     */
    getOldAttribute(element: Node, name: string): string;
    /**
     * Retrieves the previous text of `node`. `node` must be  contained in the
     * `valueChanged` node array, otherwise the function throws an error.
     *
     * @param node The node to get the old character data for.
     */
    getOldCharacterData(node: Node): string;
    /**
     * Retrieves the previous previousSibling for a node. The node must be
     * contained in the reordered element array, otherwise the function throws
     * an error.
     *
     * @param node The node to get the previous sibling for.
     */
    getOldPreviousSibling(node: Node): Node;
}