Skip to content

cupertino-files / buildComment

Function: buildComment() ​

buildComment(store, component, text, options?): object

Defined in: src/tswp/comments.ts:194

Build the comment-storage and highlight objects for one comment.

Returns both, because the caller has to anchor the highlight in a text table and only it knows where.

Parameters ​

store ​

ObjectStore

component ​

Component

text ​

string

options? ​

AddCommentOptions = {}

Returns ​

object

author ​

author: IwaObject

commentStorage ​

commentStorage: IwaObject

highlight ​

highlight: IwaObject

MIT licensed. Independently made — not by Apple in California. Not affiliated with or endorsed by Apple Inc.