@types/rgrove__parse-xml/index.d.ts

TypeScript definitions for @rgrove/parse-xml

declare function parseXml(name: string, options?: parseXml.ParseOptions): parseXml.Document;

declare namespace parseXml {
    interface NodeBase {
        parent?: NodeBase | undefined;
        type: string;
    }

    interface Document extends NodeBase {
        type: "document";
        children: NodeBase[];
    }

    interface CData extends NodeBase {
        type: "cdata";
        text: string;
    }

    interface Comment extends NodeBase {
        type: "comment";
        content: string;
    }

    interface Text extends NodeBase {
        type: "text";
        text: string;
    }

    interface Element extends NodeBase {
        type: "element";
        attributes: { [key: string]: string };
        children: NodeBase[];
        name: string;
        preserveWhitespace?: string | undefined;
    }

    type Node = CData | Comment | Element | Text;

    interface ParseOptions {
        ignoreUndefinedEntities?: boolean | undefined;
        preserveCdata?: boolean | undefined;
        preserveComments?: boolean | undefined;
        resolveUndefinedEntity?: ((ref: string) => string) | undefined;
    }
}

export = parseXml;