docxml/types/src/components/Comment.d.ts

TypeScript (component) library for building and parsing a DOCX file

import { type ComponentAncestor, Component } from '../classes/Component.js';
/**
 * A type describing the components accepted as children of {@link Comment}.
 */
export declare type CommentChild = never;
/**
 * A type describing the props accepted by {@link Comment}.
 */
export declare type CommentProps = {
    id: number;
};
/**
 * The start of a range associated with a comment.
 */
export declare class Comment extends Component<CommentProps, CommentChild> {
    static readonly children: string[];
    static readonly mixed: boolean;
    /**
     * Creates an XML DOM node for this component instance.
     */
    toNode(ancestry: ComponentAncestor[]): Node;
    /**
     * Asserts whether or not a given XML node correlates with this component.
     */
    static matchesNode(node: Node): boolean;
    /**
     * Instantiate this component from the XML in an existing DOCX file.
     */
    static fromNode(node: Node): Comment;
}