TSComment

​

Inherits from

Comment, Statement, Expression, Editable

​

Attributes

​

comment_type

​

extended

​

extended_source

​

file

​

file_node_id

​

filepath

​

function_calls

​

index

​

nested_code_blocks

​

nested_statements

​

node_type

​

parent

​

parent_class

​

parent_function

​

parent_statement

​

resolved_value

​

source

​

statement_type

​

text

​

ts_node

​

variable_usages

​

Methods

​

ancestors

Find all ancestors of the node of the given type. Does not return itself

​

clean_comment

Cleans comment markers and whitespace from a comment string.

​

edit

Replace the source of this Editable with new_src.

​

edit_text

Replace the text of a comment with new text.

​

find

Find and return matching nodes or substrings within an Editable instance.

​

find_string_literals

Returns a list of string literals within this node’s source that match any of the given

​

flag

Adds a visual flag comment to the end of this Editable’s source text.

​

generate_comment

Generates a TypeScript comment block from the given text content.

​

get_variable_usages

Returns Editables for all TreeSitter nodes corresponding to instances of variable usage

​

insert_after

Inserts code after this node.

​

insert_before

Inserts text before this node’s source with optional indentation and newline handling.

​

is_wrapped_in

Check if this node is contained another node of the given class

​

parent_of_type

Find the first ancestor of the node of the given type. Does not return itself

​

reduce_condition

Reduces an editable to the following condition

​

remove

Deletes this Node and its related extended nodes (e.g. decorators, comments).

​

replace

Search and replace occurrences of text within this node’s source and its extended nodes.

​

search

Returns a list of all regex match of regex_pattern, similar to python’s re.search().