@iocium/domhash - v0.2.0
    Preparing search index...

    Interface DomHashResult

    Represents the result of a DOM hashing operation, encapsulating various properties that describe the structure and characteristics of the Document Object Model (DOM) tree.

    The DomHashResult interface provides detailed information about the hash of the DOM, its shape, statistics, and various resilience and structural scores. This is useful for analyzing and comparing different DOM structures in applications such as web performance analysis, optimization, or validation.

    DomHashResult

    interface DomHashResult {
        canonical: string;
        hash: string;
        layoutCanonical?: string;
        layoutHash?: string;
        layoutShape?: string[];
        resilienceBreakdown?: any;
        resilienceEmoji?: string;
        resilienceLabel?: string;
        resilienceScore?: number;
        shape?: string[];
        stats: { depth: number; tagCount: number };
        structuralBreakdown?: any;
        structuralEmoji?: string;
        structuralLabel?: string;
        structuralScore?: number;
        structureTree?: any;
    }
    Index

    Properties

    canonical hash layoutCanonical? layoutHash? layoutShape? resilienceBreakdown? resilienceEmoji? resilienceLabel? resilienceScore? shape? stats structuralBreakdown? structuralEmoji? structuralLabel? structuralScore? structureTree?

    Properties

    canonical: string

    A canonical representation of the DOM, which may serve as a standardized format for comparison or storage.

    hash: string

    A unique string representing the hash of the DOM structure. This can be used to identify or compare different DOM trees.

    layoutCanonical?: string

    An optional canonical representation of the layout, similar to the canonical property but focused on layout aspects.

    layoutHash?: string

    An optional hash value representing the layout of the DOM. This can be used to track changes in layout over time.

    layoutShape?: string[]

    An optional array representing the shape of the layout, detailing how elements are arranged visually.

    resilienceBreakdown?: any

    An optional breakdown of factors contributing to the resilience score, providing insights into the structural integrity of the DOM.

    resilienceEmoji?: string

    An optional emoji representing the resilience level visually.

    resilienceLabel?: string

    An optional label describing the resilience level (e.g., "High", "Medium", "Low").

    resilienceScore?: number

    An optional score indicating the resilience of the DOM structure against potential disruptions or changes.

    shape?: string[]

    An optional array of strings representing the shape of the DOM. This may include specific patterns or arrangements of elements within the DOM.

    stats: { depth: number; tagCount: number }

    An object containing statistical information about the DOM structure.

    structuralBreakdown?: any

    An optional breakdown of components contributing to the structural score, offering detailed insights into potential weaknesses or strengths.

    structuralEmoji?: string

    An optional emoji symbolizing the structural quality.

    structuralLabel?: string

    An optional label that categorizes the structural quality (e.g., "Good", "Needs Improvement").

    structuralScore?: number

    An optional score reflecting the overall structural quality of the DOM, potentially based on best practices or standards.

    structureTree?: any

    An optional representation of the hierarchical structure of the DOM, which may provide a visual or programmatic depiction of the nodes and their relationships.

    Settings

    Member Visibility

    On This Page

    Properties