From ca99180008203d7a41d9c5e6d2292eb1654f51fc Mon Sep 17 00:00:00 2001
From: Sam Erickson <samericksn@gmail.com>
Date: Thu, 31 Oct 2024 15:13:39 -0700
Subject: [PATCH] feat: return created comment in add functions

---
 src/index.ts | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/index.ts b/src/index.ts
index 4adb0b9..d9bf3b5 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -179,6 +179,7 @@ export class CommentPlugin<Schemes extends ExpectedSchemes, K = BaseArea<Schemes
    * @param text Comment text
    * @param position Comment position
    * @param link Node ID the comment is linked with
+   * @returns comment that was created
    */
   public addInline(text: string, [x, y]: [number, number], link?: string) {
     const comment = new InlineComment(text, this.area, {
@@ -195,6 +196,7 @@ export class CommentPlugin<Schemes extends ExpectedSchemes, K = BaseArea<Schemes
     if (link) comment.linkTo([link])
 
     this.add(comment)
+    return comment
   }
 
   /**
@@ -203,6 +205,7 @@ export class CommentPlugin<Schemes extends ExpectedSchemes, K = BaseArea<Schemes
    * When user drops a node on a comment, the node will be linked to the comment.
    * @param text Comment text
    * @param links List of node IDs the comment is linked with
+   * @returns comment that was created
    */
   public addFrame(text: string, links: string[] = []) {
     const comment = new FrameComment(text, this.area, this.editor, {
@@ -218,6 +221,7 @@ export class CommentPlugin<Schemes extends ExpectedSchemes, K = BaseArea<Schemes
 
     this.add(comment)
     this.area.area.content.reorder(comment.element, this.area.area.content.holder.firstChild)
+    return comment
   }
 
   public add(comment: Comment) {