docx
    Preparing search index...

    Type Alias ICommentOptions

    Options for creating a single comment.

    type ICommentOptions = {
        author?: string;
        children: readonly FileChild[];
        date?: Date;
        durableId?: string;
        id: number;
        initials?: string;
        parentId?: number;
        resolved?: boolean;
    }
    Index

    Properties

    author? children date? durableId? id initials? parentId? resolved?

    Properties

    author?: string

    Name of the comment author

    children: readonly FileChild[]

    Content of the comment (typically paragraphs)

    date?: Date

    Date and time the comment was created

    durableId?: string

    Stable comment id written to word/commentsIds.xml (w16cid:durableId). Preserved by Word across edits, unlike w:id.

    id: number

    Unique identifier for the comment

    initials?: string

    Initials of the comment author

    parentId?: number

    ID of the parent comment for reply threading

    resolved?: boolean

    Whether the comment thread is marked as resolved

    Settings

    Member Visibility

    On This Page

    Properties