Type Alias DocumentCommentPayload

Payload for creating a document comment

type DocumentCommentPayload = {
    content: string;
    from?: number;
    path: string;
    to?: number;
    variant?: string;
}

Index

Properties

content from? path to? variant?

Properties

content

content: string

Comment body

`Optional`from

from?: number

Comment start position

path

path: string

Target document path

`Optional`to

to?: number

Comment end position

`Optional`variant

variant?: string

Variant the comment belongs to