@squareys/webdecks-sdk - v0.0.0
    Preparing search index...

    Class Comment

    A comment, addressed by its engine id. Its body, resolved state, threading parent, anchored paragraph, and anchored byte range are read live from the model; its author is not exposed by the engine's read seam, so Comment.author reflects the value this SDK authored.

    Hierarchy (View Summary)

    Index
    • get isValid(): boolean

      Whether this wrapper still refers to a live engine object.

      Returns boolean

    • set _index(value: number): void

      Parameters

      • value: number

      Returns void

    • get body(): string

      The comment's body text, read live from the model.

      Returns string

    • get author(): string

      The comment's author as authored through the SDK (not exposed by the engine read seam).

      Returns string

    • get isResolved(): boolean

      Whether the comment is resolved, read live from the model.

      Returns boolean

    • get parentId(): number

      The id of the comment this one replies to, or -1 if it is a top-level comment.

      Returns number

    • get paragraph(): number

      The index of the paragraph this comment is anchored to, or -1 if unknown.

      Returns number

    • get range(): { start: number; end: number }

      The comment's anchored byte range [start, end) within its paragraph, read live.

      Returns { start: number; end: number }

    • Reference equality is the identity test — prefer a === b. This is retained only for the rare cross-realm case where two wrappers describe the same handle by value. Reads the raw index so comparing a stale wrapper never throws.

      Parameters

      • other: Handle<unknown> | null

      Returns boolean

    • A readable identity for logs and diagnostics, never [object Object].

      Returns string

    • Mark the comment resolved or unresolved.

      Parameters

      • resolved: boolean

      Returns this

    • Reply to this comment; returns the reply as a new Comment.

      Parameters

      • body: string
      • author: string = ""

      Returns Comment