Interface: CommentsStore
@roomful/svelte / CommentsStore
Interface: CommentsStore
Section titled “Interface: CommentsStore”Defined in: packages/svelte/src/index.ts:451
Readable store of collaborative comment threads augmented with the thread mutators.
Extends
Section titled “Extends”Readable<CommentThread[]>
Properties
Section titled “Properties”add: (
input) =>Promise<CommentThread>
Defined in: packages/svelte/src/index.ts:455
Opens a new thread authored by the local peer at an anchor.
Opens a new thread authored by the local peer at anchor. The thread id
and createdAt are generated.
Parameters
Section titled “Parameters”The thread anchor and root comment body.
anchor
Section titled “anchor”string
Returns
Section titled “Returns”Promise<CommentThread>
A promise resolving to the created thread.
getByElement()
Section titled “getByElement()”getByElement: (
elementId) =>CommentThread[]
Defined in: packages/svelte/src/index.ts:485
Returns the threads anchored to an element.
Returns the threads anchored to elementId (element or text-range
anchors).
Parameters
Section titled “Parameters”elementId
Section titled “elementId”string
The element id to filter by.
Returns
Section titled “Returns”The matching threads.
getOpen()
Section titled “getOpen()”getOpen: () =>
CommentThread[]
Defined in: packages/svelte/src/index.ts:490
Returns the unresolved threads.
Returns the unresolved threads.
Returns
Section titled “Returns”The open threads.
Methods
Section titled “Methods”reopen()
Section titled “reopen()”reopen(
threadId):Promise<CommentThread>
Defined in: packages/svelte/src/index.ts:480
Reopens a resolved thread.
Parameters
Section titled “Parameters”threadId
Section titled “threadId”string
The thread to reopen.
Returns
Section titled “Returns”Promise<CommentThread>
A promise resolving to the updated thread.
reply()
Section titled “reply()”reply(
threadId,text):Promise<CommentThread>
Defined in: packages/svelte/src/index.ts:464
Appends a reply authored by the local peer to a thread.
Parameters
Section titled “Parameters”threadId
Section titled “threadId”string
The thread to reply to.
string
The reply body.
Returns
Section titled “Returns”Promise<CommentThread>
A promise resolving to the updated thread.
resolve()
Section titled “resolve()”resolve(
threadId):Promise<CommentThread>
Defined in: packages/svelte/src/index.ts:472
Marks a thread resolved.
Parameters
Section titled “Parameters”threadId
Section titled “threadId”string
The thread to resolve.
Returns
Section titled “Returns”Promise<CommentThread>
A promise resolving to the updated thread.
subscribe()
Section titled “subscribe()”subscribe(
this,run,invalidate?):Unsubscriber
Defined in: node_modules/.pnpm/svelte@4.2.20/node_modules/svelte/types/index.d.ts:1619
Subscribe on value changes.
Parameters
Section titled “Parameters”void
Subscriber<CommentThread[]>
subscription callback
invalidate?
Section titled “invalidate?”Invalidator<CommentThread[]>
cleanup callback
Returns
Section titled “Returns”Unsubscriber
Inherited from
Section titled “Inherited from”Readable.subscribe