CommentMutation | @sheetwrite/core

Serializable operation that creates or updates comment state.

Package: @sheetwrite/core
Source: packages/core/src/collaboration.ts#L386

Variants 3

{
  kind: "create";
  threadId: string;
  messageId: string;
  anchor: CommentAnchortype CommentAnchor =
  | {
      kind: "cell";
      address: { sheet: string; row: number; col: number };
    }
  | { kind: "range"; range: Range };type CommentAnchor =
  | {
      kind: "cell";
      address: { sheet: string; row: number; col: number };
    }
  | { kind: "range"; range: Range };type CommentAnchor =
  | {
      kind: "cell";
      address: {
        sheet: string;
        row: number;
        col: number;
      };
    }
  | {
      kind: "range";
      range: Range;
    };Document location to which a comment thread is attached.API reference →;
  body: string;
}

{
  kind: "reply";
  threadId: string;
  messageId: string;
  body: string;
}

{ kind: "resolve"; threadId: string; resolved: boolean }

Declaration

View full TypeScript declaration

export type CommentMutation =
  | {
      kind: "create";
      threadId: string;
      messageId: string;
      anchor: CommentAnchortype CommentAnchor =
  | {
      kind: "cell";
      address: { sheet: string; row: number; col: number };
    }
  | { kind: "range"; range: Range };type CommentAnchor =
  | {
      kind: "cell";
      address: { sheet: string; row: number; col: number };
    }
  | { kind: "range"; range: Range };type CommentAnchor =
  | {
      kind: "cell";
      address: {
        sheet: string;
        row: number;
        col: number;
      };
    }
  | {
      kind: "range";
      range: Range;
    };Document location to which a comment thread is attached.API reference →;
      body: string;
    }
  | {
      kind: "reply";
      threadId: string;
      messageId: string;
      body: string;
    }
  | {
      kind: "resolve";
      threadId: string;
      resolved: boolean;
    };