CommentStore

Defined in: comments/store.ts:61

Constructors

Constructor

new CommentStore(options?): CommentStore;

Defined in: comments/store.ts:73

Parameters

Parameter	Type
options	CommentStoreOptions

Returns

CommentStore

Properties

Property	Modifier	Type	Defined in
actor	readonly	string	comments/store.ts:62

Methods

addComment()

addComment(threadId, input): string;

Defined in: comments/store.ts:115

Append a reply to an existing thread. Returns the new comment id.

Parameters

Parameter	Type
threadId	string
input	AddCommentInput

Returns

string

---

createThread()

createThread(input): {
  commentId: string;
  threadId: string;
};

Defined in: comments/store.ts:98

Open a new thread with its first comment. Returns the ids so the caller can stamp the matching commentMark onto the document range.

Parameters

Parameter	Type
input	CreateThreadInput

Returns

{
  commentId: string;
  threadId: string;
}

commentId

commentId: string;

threadId

threadId: string;

---

deleteComment()

deleteComment(commentId): void;

Defined in: comments/store.ts:133

Parameters

Parameter	Type
commentId	string

Returns

void

---

deleteThread()

deleteThread(threadId): void;

Defined in: comments/store.ts:145

Parameters

Parameter	Type
threadId	string

Returns

void

---

editComment()

editComment(commentId, body): void;

Defined in: comments/store.ts:129

Parameters

Parameter	Type
commentId	string
body	string

Returns

void

---

getThread()

getThread(threadId):
  | CommentThread
  | undefined;

Defined in: comments/store.ts:85

Parameters

Parameter	Type
threadId	string

Returns

| CommentThread | undefined

---

ingest()

ingest(events): void;

Defined in: comments/store.ts:159

Merge remote events. Idempotent (dedupes by event id) and echo-free (does NOT notify onLocalEvents). Notifies UI subscribers if anything actually changed.

Parameters

Parameter	Type
events	readonly CommentEvent[]

Returns

void

---

onLocalEvents()

onLocalEvents(listener): Unsubscribe;

Defined in: comments/store.ts:179

Subscribe to locally authored events only (for fan-out by CommentSync). Remote events ingested via ingest do NOT fire this — prevents echo loops.

Parameters

Parameter	Type
listener	(events) => void

Returns

Unsubscribe

---

openThreadIds()

openThreadIds(): Set<string>;

Defined in: comments/store.ts:90

Thread ids that currently have at least one visible (non-deleted) comment.

Returns

Set<string>

---

reopenThread()

reopenThread(threadId, by?): void;

Defined in: comments/store.ts:141

Parameters

Parameter	Type
threadId	string
by?	CommentAuthor

Returns

void

---

resolveThread()

resolveThread(threadId, by?): void;

Defined in: comments/store.ts:137

Parameters

Parameter	Type
threadId	string
by?	CommentAuthor

Returns

void

---

snapshot()

snapshot(): CommentEvent[];

Defined in: comments/store.ts:152

The full event log — send to a freshly-joined peer.

Returns

CommentEvent[]

---

subscribe()

subscribe(listener): Unsubscribe;

Defined in: comments/store.ts:172

Subscribe to materialized-state changes (for UI re-render).

Parameters

Parameter	Type
listener	() => void

Returns

Unsubscribe

---

threads()

threads(): CommentThread[];

Defined in: comments/store.ts:80

All non-deleted threads, newest first.

Returns

CommentThread[]