@nelsonrc/nrc-phoenix-xml - v1.0.3
    Preparing search index...

    Class XmlSummarizer

    Index

    Constructors

    Methods

    • Processes a raw XML string using a structured IXmlSummary object to compute grouped and formatted summary data. Supports numeric aggregations like sum, count, average, min, max, standard deviation, and optional output formatting.

      Example: const summary = getSummaryFromXml(xmlData, summarySpec, false, { roundDecimals: 2 });

      Parameters

      • xmlFile: string

        The raw XML string to parse and summarize.

      • summarySpecs: IXmlSummary

        Parsed summary specification, including target node, grouping field, and fields to aggregate.

      • debug: boolean = false

        Enables verbose logging or diagnostic output (optional, default: false).

      • formatOptions: IXmlSummaryFormatOptions = ...

        Optional formatting and output behavior (e.g., decimal rounding, currency).

      Returns string | SummaryDictionary

      A dictionary grouping summary results by key, or a JSON string if asJson is enabled.

      If the XML is invalid or aggregation encounters malformed values.

    • Processes an XML string using a separated summary spec and optional formatting config.

      Parameters

      • xmlFile: string

        The raw XML string to summarize.

      • summaryString: string

        The summary definition string.

      • debug: boolean = false

        Enables debug output (optional, default: false).

      • formatOptions: IXmlSummaryFormatOptions = {}

        Optional formatting configuration.

      Returns string | SummaryDictionary

      Summary output grouped by key or JSON string (based on formatting).

    • Extended XML summary processor that accepts a single string containing both the summary specification and formatting options.

      Parameters

      • xmlFile: string

        The raw XML string to summarize.

      • combinedSpec: string

        A string containing summary + formatting, separated by a delimiter.

      • debug: boolean = false

        Enables debug output (optional, default: false).

      • delimiter: string = ';'

        Delimiter to split summary and format sections (default: ";").

      Returns string | SummaryDictionary

      Summary output grouped by key or JSON string.