> ## Documentation Index
> Fetch the complete documentation index at: https://codegeninc-fix-system-prompt-typo.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# TSClass
> A class representing a TypeScript/JavaScript class with enhanced functionality for class manipulation. The TSClass provides comprehensive functionality for working with TypeScript/JavaScript classes, including handling class methods, attributes, JSX components, and inheritance relationships. It supports operations like adding source code to class bodies, managing class attributes, and handling React JSX components.
export const Attribute = ({type, description}) => ;
export const GithubLinkNote = ({link}) =>
;
export const HorizontalDivider = ({light = false}) => ;
export const Return = ({return_type, description}) => ;
export const ParameterWrapper = ({children}) => ;
export const Parameter = ({name, type, description, defaultValue}) =>
{defaultValue ?
default:
{defaultValue}
:
required
}
{description}
;
### Inherits from
[TSHasBlock](/api-reference/typescript/TSHasBlock), [TSSymbol](/api-reference/typescript/TSSymbol), [Class](/api-reference/core/Class), [HasBlock](/api-reference/core/HasBlock), [Exportable](/api-reference/core/Exportable), [Symbol](/api-reference/core/Symbol), [Callable](/api-reference/core/Callable), [Expression](/api-reference/core/Expression), [Usable](/api-reference/core/Usable), [Editable](/api-reference/core/Editable), [Importable](/api-reference/core/Importable), [HasName](/api-reference/core/HasName)
## Attributes
### call\_sites
list[ FunctionCall ] } description="Returns all call sites (invocations) of this callable in the codebase." />
### code\_block
TSCodeBlock } description="The block of code associated with the code object." />
### comment
TSCommentGroup | None } description="Retrieves the comment group associated with the symbol." />
### constructor
TSFunction | None } description="Returns the constructor method for this class." />
### decorators
list[ TSDecorator ] } description="Returns a list of decorators associated with this symbol." />
### docstring
TSCommentGroup | None } description="Retrieves the docstring of a function or class." />
### export
TSExport | None } description="Returns the export object that exports this symbol." />
### exported\_name
str | None } description="Retrieves the exported name of a symbol from its file." />
### extended
SymbolGroup } description="Returns a SymbolGroup of all extended nodes associated with this element." />
### extended\_nodes
list[ Editable ] } description="Returns the list of nodes associated with this symbol including extended nodes." />
### extended\_source
str } description="Returns the source text representation of all extended nodes." />
### file
TSFile } description="The file object that this Editable instance belongs to." />
### filepath
str } description="The file path of the file that this Editable instance belongs to." />
### full\_name
str | None } description="Returns the full name of the object, including the namespace path." />
### function\_calls
list[ FunctionCall ] } description="Returns all function calls within the code block and its decorators." />
### has\_semicolon
bool } description="Checks whether the current symbol has a semicolon at the end." />
### inline\_comment
TSCommentGroup | None } description="Property that retrieves the inline comment group associated with the symbol." />
### is\_decorated
bool } description="Checks if the current symbol has a decorator." />
### is\_exported
bool } description="Indicates if the symbol is exported from its defining file." />
### is\_jsx
bool } description="Determine if the class is a React JSX component." />
### is\_reexported
bool } description="Determines if the symbol is re-exported from a different file." />
### is\_subclass
bool } description="Indicates whether the current class is a subclass of another class." />
### jsx\_elements
list[ JSXElement [ TSClass ]] } description="Returns a list of all JSX elements contained within this symbol." />
### name
str | None } description="Retrieves the base name of the object without namespace prefixes." />
### nested\_classes
list[ TSClass ] } description="Retrieves the nested classes defined within this class." />
### parameters
SymbolGroup [ TSParameter , TSClass ] | list[ TSParameter ] } description="Retrieves all parameters of a callable symbol." />
### parent
Editable } description="The parent node of this Editable instance." />
### parent\_class
TSClass | None } description="Find the class this node is contained in" />
### parent\_class\_names
list[ Name | TSChainedAttribute ] } description="Returns a list of the parent class names that this class inherits from." />
### parent\_classes
Parents[ Type , TSClass ] | None } description="The parent classes of this class, if any." />
### parent\_function
TSFunction | None } description="Find the function this node is contained in" />
### parent\_statement
Statement | None } description="Find the statement this node is contained in" />
### resolved\_value
Expression | list[ Expression ] } description="Returns the resolved type of an Expression." />
### return\_type
Type | Placeholder [ TSClass ] } description="The type of value returned by the callable, or a placeholder." />
### semicolon\_node
Editable | None } description="Retrieves the semicolon node associated with a TypeScript symbol." />
### source
str } description="Returns the source code of the symbol." />
### symbol\_type
} description="The type of symbol, set to SymbolType.Class." />
### type\_parameters
TypeParameters[ Type , TSClass ] | None } description="The type parameters of the symbol, if any." />
### variable\_usages
list[ Editable ] } description="Returns Editables for all TreeSitter node instances of variable usages within this node's" />
## Methods
### add\_attribute
Adds an attribute to a class from another class.
TSAttribute } description="The attribute to add to the class." defaultValue="" />
bool, optional } description="Whether to include the attribute's dependencies. If True, adds any necessary imports to the class's file. Defaults to False." defaultValue="False" />
None } description="" />
### add\_attribute\_from\_source
Adds a class attribute from source code to a TypeScript/JavaScript class.
str } description="The source code of the attribute to add to the class." defaultValue="" />
None } description="" />
### add\_comment
Adds a new comment to the symbol.
str } description="The comment text to be added." defaultValue="" />
bool } description="Whether to automatically format the text into a comment style. Defaults to True." defaultValue="True" />
bool } description="Whether to clean the format of the comment before inserting. Defaults to True." defaultValue="True" />
TSCommentType } description="Type of comment to add. Defaults to TSCommentType.DOUBLE_SLASH." defaultValue="TSCommentType.DOUBLE_SLASH" />
None } description="" />
### add\_decorator
Adds a decorator to a function or method.
str } description="The decorator to add, including the '@' symbol." defaultValue="" />
bool, optional } description="If True, skips adding if the decorator exists." defaultValue="False" />
bool } description="True if the decorator was added, False if skipped." />
### add\_keyword
Insert a keyword in the appropriate place before this symbol if it doesn't already exist.
str } description="The keyword to be inserted. Must be a valid keyword in the language context." defaultValue="" />
None } description="" />
### add\_source
Adds source code to a class body.
str } description="The source code to be added to the class body." defaultValue="" />
None } description="" />
### ancestors
Find all ancestors of the node of the given type. Does not return itself
list[ Editable ] } description="" />
### attributes
Retrieves all attributes from this Class including those from its superclasses up to a
int | None } description="The maximum depth of superclass traversal. None means no limit, 0 means only this class." defaultValue="0" />
bool } description="Whether to include private attributes. Defaults to True." defaultValue="True" />
list[ TSAttribute ] } description="A list of unique attributes from this class and its superclasses. If an attribute is defined in multiple classes, the first definition encountered is used." />
### class\_component\_to\_function\_component
Converts a class component to a function component.
None } description="" />
### convert\_props\_to\_interface
Converts React component props to TypeScript interfaces.
None } description="" />
### dependencies
Returns a list of symbols that this symbol depends on.
UsageType | None } description="The types of dependencies to search for. Defaults to UsageType.DIRECT." defaultValue="UsageType.DIRECT" />
int | None } description="Maximum depth to traverse in the dependency graph. If provided, will recursively collect" defaultValue="None" />
list[Union[ TSSymbol , TSImport ]] } description="A list of symbols and imports that this symbol depends on, sorted by file location." />
### edit
Replace the source of this node with new\_src.
str } description="The new source code to replace the current source with." defaultValue="" />
bool } description="If True, adjusts the indentation of new_src to match the current text's indentation. Defaults to False." defaultValue="False" />
int } description="The priority of this edit. Higher priority edits take precedence. Defaults to 0." defaultValue="0" />
bool } description="If True, prevents duplicate edits. Defaults to True." defaultValue="True" />
None } description="" />
### find
Find and return matching nodes or substrings within an Editable instance.
Union[list[str], str] } description="One or more strings to search for." defaultValue="" />
bool } description="If True, only return nodes whose source exactly matches one of the strings_to_match." defaultValue="False" />
list[ Editable ] } description="A list of Editable instances that match the search criteria." />
### find\_string\_literals
Returns a list of string literals within this node's source that match any of the given
list[str] } description="A list of strings to search for in string literals." defaultValue="" />
bool } description="If True, matches substrings within string literals. If False, only matches exact strings. Defaults to False." defaultValue="False" />
list[ Editable [ TSClass ]] } description="A list of Editable objects representing the matching string literals." />
### flag
Flags a TypeScript symbol by adding a flag comment and returning a CodeFlag.
CodeFlag[ TSClass ] } description="The code flag object for tracking purposes" />
### get\_attribute
Returns a specific attribute by name.
str } description="The name of the attribute to search for." defaultValue="" />
TSAttribute | None } description="The matching attribute if found, None otherwise. If multiple attributes with the same name exist in the inheritance hierarchy, returns the first one found." />
### get\_component
Returns a specific JSX element from within this symbol's JSX elements.
str } description="The name of the JSX component to find." defaultValue="" />
JSXElement [ TSClass ] | None } description="The matching JSX element if found, None otherwise." />
### get\_import\_string
Generates the appropriate import string for a symbol.
str | None, optional } description="The alias to use for the imported symbol. Defaults to None." defaultValue="None" />
str | None, optional } description="The module to import from. If None, uses the file's import module name." defaultValue="None" />
ImportType , optional } description="The type of import to generate (e.g., WILDCARD). Defaults to" defaultValue="ImportType.UNKNOWN" />
bool, optional } description="Whether this is a type-only import. Defaults to False." defaultValue="False" />
str } description="A formatted import statement string." />
### get\_method
Returns a specific method by name from the class or any of its superclasses.
str } description="The name of the method to find." defaultValue="" />
TSFunction | None } description="The method if found, None otherwise." />
### get\_name
Returns the name node of the object.
Name | TSChainedAttribute | None } description="The name node of the object. Can be a Name node for simple names, a ChainedAttribute for names with namespaces (e.g., a.b), or None if the object has no name." />
### get\_nested\_class
Returns a nested class by name from the current class.
str } description="The name of the nested class to find." defaultValue="" />
TSClass | None } description="The nested class if found, None otherwise." />
### get\_parameter
Gets a specific parameter from the callable's parameters list by name.
str } description="The name of the parameter to retrieve." defaultValue="" />
TSParameter | None } description="The parameter with the specified name, or None if no parameter with that name exists or if there are no parameters." />
### get\_parameter\_by\_index
Returns the parameter at the given index.
int } description="The index of the parameter to retrieve." defaultValue="" />
TSParameter | None } description="The parameter at the specified index, or None if the parameter list is empty or the index does not exist." />
### get\_parameter\_by\_type
Retrieves a parameter from the callable by its type.
TSSymbol } description="The type to search for." defaultValue="" />
TSParameter | None } description="The parameter with the specified type, or None if no parameter is found or if the callable has no parameters." />
### get\_parent\_class
Returns the parent class node with the specified name.
str } description="The name of the parent class to find." defaultValue="" />
Editable | None } description="The matching parent class node, or None if no match is found." />
### get\_variable\_usages
Returns Editables for all TreeSitter nodes corresponding to instances of variable usage
str } description="The variable name to search for." defaultValue="" />
bool } description="If True, matches variables where var_name is a substring. If False, requires exact match. Defaults to False." defaultValue="False" />
Sequence[ Editable [ TSClass ]] } description="List of Editable objects representing variable usage nodes matching the given name." />
### insert\_after
Inserts code after this node.
str } description="The source code to insert after this node." defaultValue="" />
bool, optional } description="Whether to adjust the indentation of new_src to match the current node. Defaults to False." defaultValue="False" />
bool, optional } description="Whether to add a newline before the new_src. Defaults to True." defaultValue="True" />
int, optional } description="Priority of the insertion transaction. Defaults to 0." defaultValue="0" />
bool, optional } description="Whether to deduplicate identical transactions. Defaults to True." defaultValue="True" />
None } description="" />
### insert\_before
Inserts text before the current symbol node in the Abstract Syntax Tree.
str } description="The source code text to insert." defaultValue="" />
bool } description="Whether to adjust the indentation of new_src to match current text. Defaults to False." defaultValue="False" />
bool } description="Whether to add a newline after insertion. Defaults to True." defaultValue="True" />
int } description="Priority of this edit operation. Higher priority edits are applied first. Defaults to 0." defaultValue="0" />
bool } description="Whether to remove duplicate insertions. Defaults to True." defaultValue="True" />
bool } description="Whether to insert before extended nodes like comments and decorators. Defaults to True." defaultValue="True" />
None } description="" />
### is\_child\_of
Checks if this node is a descendant of the given editable instance in the AST.
bool } description="" />
### is\_subclass\_of
Checks if the class inherits from a specified parent class.
str | TSClass } description="The parent class to check for. Can be specified either as a class name string or Class object." defaultValue="" />
int | None } description="Maximum inheritance depth to search. None means no limit." defaultValue="None" />
bool } description="True if this class inherits from the parent class, False otherwise." />
### is\_wrapped\_in
Check if this node is contained another node of the given class
bool } description="" />
### methods
Retrieves all methods that exist on this Class, including methods from superclasses, with
int | None, optional } description="Include parent classes up to max_depth. None means no limit, 0 means only current class. Defaults to 0." defaultValue="0" />
bool, optional } description="Whether to include private methods. Defaults to True." defaultValue="True" />
bool, optional } description="Whether to include magic methods. Defaults to False." defaultValue="True" />
list[ TSFunction ] | MultiLineCollection [ TSFunction , TSClass ] } description="" />
### move\_to\_file
Moves the given symbol to a new file and updates its imports and references.
TSFile } description="The destination file to move the symbol to." defaultValue="" />
bool } description="If True, moves all dependencies of the symbol to the new file. If False, adds imports for the dependencies. Defaults to True." defaultValue="True" />
str } description="The strategy to use for updating imports. Can be either 'add_back_edge' or 'update_all_imports'. Defaults to 'update_all_imports'." defaultValue=""update_all_imports"" />
None } description="" />
### parent\_of\_type
Find the first ancestor of the node of the given type. Does not return itself
Editable | None } description="" />
### parent\_of\_types
Find the first ancestor of the node of the given type. Does not return itself
Editable | None } description="" />
### reduce\_condition
Reduces an editable to the following condition
None } description="" />
### remove
Deletes this Node and its related extended nodes (e.g. decorators, comments).
bool } description="Whether to delete surrounding whitespace and formatting. Defaults to True." defaultValue="True" />
int } description="Priority of the removal transaction. Higher priority transactions are executed first. Defaults to 0." defaultValue="0" />
bool } description="Whether to deduplicate removal transactions at the same location. Defaults to True." defaultValue="True" />
None } description="" />
### rename
Renames a symbol and updates all its references in the codebase.
str } description="The new name for the symbol." defaultValue="" />
int } description="Priority of the edit operation. Defaults to 0." defaultValue="0" />
tuple[NodeId, NodeId] } description="A tuple containing the file node ID and the new node ID of the renamed symbol." />
### replace
Search and replace occurrences of text within this node's source and its extended nodes.
str } description="The text or pattern to search for." defaultValue="" />
str } description="The text to replace matches with." defaultValue="" />
int, optional } description="Maximum number of replacements to make. Defaults to -1 (replace all)." defaultValue="-1" />
bool, optional } description="Whether to treat 'old' as a regex pattern. Defaults to False." defaultValue="False" />
int, optional } description="Priority of the replacement operation. Defaults to 0." defaultValue="0" />
int } description="The total number of replacements made." />
### search
Returns a list of all regex match of `regex_pattern`, similar to python's re.search().
str } description="The regular expression pattern to search for." defaultValue="" />
bool } description="When False, excludes the contents of string literals from the search. Defaults to True." defaultValue="True" />
bool } description="When False, excludes the contents of comments from the search. Defaults to True." defaultValue="True" />
list[ Editable ] } description="A list of Editable objects corresponding to the matches found." />
### set\_comment
Sets a comment to the symbol.
str } description="The comment text to be added." defaultValue="" />
bool, optional } description="Whether to automatically format the text into a comment syntax." defaultValue="True" />
bool, optional } description="Whether to clean the format of the comment before inserting." defaultValue="True" />
TSCommentType , optional } description="The style of comment to add." defaultValue="TSCommentType.DOUBLE_SLASH" />
None } description="" />
### set\_docstring
Sets or updates a docstring for a code element.
str } description="The docstring text to be added or updated." defaultValue="" />
bool, optional } description="Whether to automatically format the text into a docstring format. Defaults to True." defaultValue="True" />
bool, optional } description="Whether to clean existing formatting from the docstring before inserting. Defaults to True." defaultValue="True" />
bool, optional } description="Whether to add leading "*" to each line of the comment block. Defaults to True." defaultValue="True" />
bool, optional } description="Whether to force single line comments to be multi-line. Defaults to False." defaultValue="False" />
None } description="" />
### set\_inline\_comment
Sets an inline comment to the symbol.
str } description="The inline comment text to be added." defaultValue="" />
bool, optional } description="Whether to automatically format the text as a comment." defaultValue="True" />
bool, optional } description="Whether to clean the comment format before inserting." defaultValue="True" />
TSNode | None, optional } description="The specific node to attach the comment to." defaultValue="None" />
None } description="" />
### set\_name
Sets the name of a code element.
str } description="The new name to set for the object." defaultValue="" />
None } description="" />
### subclasses
Returns all classes which subclass this class.
int | None, optional } description="Maximum inheritance depth to search. If None, searches all depths. Defaults to None." defaultValue="None" />
list[ TSClass ] } description="A list of Class objects that inherit from this class." />
### superclasses
Returns a list of all classes that this class extends, up to max\_depth.
int | None } description="The maximum depth to traverse up the inheritance tree. If None, traverses the entire tree." defaultValue="None" />
list[ TSClass | ExternalModule | TSInterface ] } description="A list of all superclass symbols in MRO order, up to max_depth. Returns an empty list if the class has no parent classes." />
### symbol\_usages
Returns a list of symbols that use or import the exportable object.
UsageType | None } description="The types of usages to search for. Defaults to any." defaultValue="None" />
list[ TSImport | TSSymbol | TSExport ] } description="A list of symbols that use or import the exportable object." />
### usages
Returns a list of usages of the exportable object.
UsageType | None } description="Specifies which types of usages to include in the results. Default is any usages." defaultValue="None" />
list[ Usage ] } description="A sorted list of Usage objects representing where this exportable is used, ordered by source location in reverse." />