Class Comments

Comments is an API module for managing thread/block comments

Comments are added as blocks in a thread, which target another block, usually a file(s).

extends: API

Hierarchy

API
- Comments

Index

Constructors

constructor

Methods

Constructors

constructor

new Comments(opts?: ApiOptions): Comments

Inherited from API.__constructor
- Defined in core/api.ts:68
Parameters
- Default value opts: ApiOptions = DEFAULT_API_OPTIONS
Returns Comments

Methods

add

add(block: string, body: string): Promise<Comment>

- Defined in modules/comments.ts:19
Adds a comment to a block

Parameters
- block: string
  
  Target block ID. Usually a file(s) block.
- body: string
  
  Comment body
Returns Promise<Comment>

The generated comment block

get

get(id: string): Promise<Comment>

- Defined in modules/comments.ts:32
Retrieves a comment by ID

Parameters
- id: string
  
  ID of the target comment
Returns Promise<Comment>

The target comment block

ignore

ignore(id: string): Promise<Block>

- Defined in modules/comments.ts:57
Ignores a block comment by its ID

This adds an 'ignore' thread block targeted at the comment. Ignored blocks are by default not returned when listing.

Parameters
- id: string
  
  ID of the comment
Returns Promise<Block>

The ignored block

list

list(block: string): Promise<CommentList>

- Defined in modules/comments.ts:43
Retrieves a list of comments on a target block

Parameters
- block: string
  
  ID of the target block
Returns Promise<CommentList>

An array of comment blocks