Interface Comment

interface Comment {
    authorUserId?: string;
    content: string;
    createdAt: string;
    dataField?: string;
    id: string;
    objectId: string;
    objectType: CommentObjectType;
    path?: string[];
    projectId: string;
    rangeEnd?: number[];
    rangeStart?: number[];
    updatedAt: string;
}

Index

Properties

authorUserId? content createdAt dataField? id objectId objectType path? projectId rangeEnd? rangeStart? updatedAt

Properties

`Optional`authorUserId

authorUserId?: string

content

content: string

createdAt

createdAt: string

`Optional`dataField

dataField?: string

For inline comments, the IO field (input, output, metadata)

id

id: string

objectId

objectId: string

objectType

objectType: CommentObjectType

`Optional`path

path?: string[]

JSON Path expressions for comment location

projectId

projectId: string

`Optional`rangeEnd

rangeEnd?: number[]

End character offsets (exclusive, UTF-16)

`Optional`rangeStart

rangeStart?: number[]

Start character offsets (inclusive, UTF-16)

updatedAt

updatedAt: string