View Source on Github
Inherits from
HasName, TSHasBlock, TSSymbol, HasBlock, Exportable, Symbol, Expression, Usable, Editable, ImportableAttributes
classes
code_block
comment
decorators
dependencies
docstring
export
exported_name
extended
extended_nodes
extended_source
file
file_node_id
filepath
full_name
function_calls
functions
has_semicolon
inline_comment
is_decorated
is_exported
is_reexported
jsx_elements
name
node_type
parent
parent_class
parent_function
parent_statement
resolved_value
semicolon_node
source
symbol_type
symbols
ts_node
variable_usages
Methods
add_comment
Adds a new comment to the symbol.View Source on Github
Parameters
add_decorator
Adds a decorator to a function or method.View Source on Github
Parameters
add_keyword
Insert a keyword in the appropriate place before this symbol if it doesn’t already exist.View Source on Github
Parameters
ancestors
Find all ancestors of the node of the given type. Does not return itselfView Source on Github
edit
Replace the source of this node with new_src.View Source on Github
Parameters
find
Find and return matching nodes or substrings within an Editable instance.View Source on Github
Parameters
find_string_literals
Returns a list of string literals within this node’s source that match any of the givenView Source on Github
Parameters
flag
Adds a visual flag comment to the end of this Editable’s source text.View Source on Github
get_class
Get a class by name from this namespace.View Source on Github
get_component
Returns a specific JSX element from within this symbol’s JSX elements.View Source on Github
Parameters
get_enum
Get an enum by name from this namespace.View Source on Github
get_function
Get a function by name from this namespace.View Source on Github
get_import_string
Generates the appropriate import string for a symbol.View Source on Github
Parameters
get_interface
Get an interface by name from this namespace.View Source on Github
get_name
Returns the name node of the object.View Source on Github
get_namespace
Get a namespace by name from this namespace.View Source on Github
get_nested_namespaces
Get all nested namespaces within this namespace.View Source on Github
get_symbol
Get a symbol by name from this namespace.View Source on Github
get_type
Get a type alias by name from this namespace.View Source on Github
get_variable_usages
Returns Editables for all TreeSitter nodes corresponding to instances of variable usageView Source on Github
Parameters
insert_after
Inserts code after this node.View Source on Github
Parameters
insert_before
Inserts text before the current symbol node in the Abstract Syntax Tree.View Source on Github
Parameters
is_wrapped_in
Check if this node is contained another node of the given classView Source on Github
move_to_file
Moves the given symbol to a new file and updates its imports and references.View Source on Github
Parameters
parent_of_type
Find the first ancestor of the node of the given type. Does not return itselfView Source on Github
reduce_condition
Reduces an editable to the following conditionView Source on Github
remove
Deletes this Node and its related extended nodes (e.g. decorators, comments).View Source on Github
Parameters
rename
Sets the name of an object and updates all its usages.View Source on Github
Parameters
replace
Search and replace occurrences of text within this node’s source and its extended nodes.View Source on Github
Parameters
search
Returns a list of all regex match ofregex_pattern, similar to python’s re.search().
View Source on Github
Parameters
set_comment
Sets a comment to the symbol.View Source on Github
Parameters
set_docstring
Sets or updates a docstring for a code element.View Source on Github
Parameters
set_inline_comment
Sets an inline comment to the symbol.View Source on Github
Parameters
set_name
Sets the name of a code element.View Source on Github
Parameters
symbol_usages
Returns a list of symbols that use or import the exportable object.View Source on Github
Parameters
usages
Returns a list of usages of the exportable object.View Source on Github