> ## Documentation Index
> Fetch the complete documentation index at: https://codegeninc-jay-docs-fixes-24.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# TSFile
> Extends the SourceFile class to provide TypeScript-specific functionality.
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
[Exportable](/api-reference/core/Exportable), [TSHasBlock](/api-reference/typescript/TSHasBlock), [SourceFile](/api-reference/core/SourceFile), [Usable](/api-reference/core/Usable), [HasBlock](/api-reference/core/HasBlock), [File](/api-reference/core/File), [Importable](/api-reference/core/Importable), [Expression](/api-reference/core/Expression), [Editable](/api-reference/core/Editable), [HasName](/api-reference/core/HasName)
## Attributes
### classes
list[ Class ] } description="Returns all Classes in the file." />
### code\_block
CodeBlock }
description="
"
/>
### content
str } description="Returns the content of the file as a UTF-8 encoded string." />
### decorators
list[ TSDecorator ] } description="Returns a list of decorators associated with this symbol." />
### default\_exports
list[ TSExport ] } description="Returns all default export symbols from the file." />
### dependencies
list[Union[ Symbol , Import ]] } description="Returns a list of symbols that this symbol depends on." />
### directory
Directory | None } description="Returns the directory that contains this file." />
### docstring
TSCommentGroup | None } description="Retrieves the docstring of a function or class." />
### export
Export | None } description="Returns the export object that exports this symbol." />
### export\_statements
list[ ExportStatement [ TSExport ]] } description="Returns a list of all export statements in the file." />
### exported\_name
str | None } description="Retrieves the exported name of a symbol from its file." />
### exports
list[ TSExport ] } description="Returns all Export symbols in the file." />
### extended
SymbolGroup } description="Returns a SymbolGroup of all extended nodes associated with this element." />
### extended\_source
str } description="Returns the source text representation of all extended nodes." />
### extension
str } description="Returns the file extension." />
### file
TSFile } description="A property that returns the file object for non-source files." />
### file\_node\_id
NodeId }
description="
"
/>
### file\_path
str }
description="
"
/>
### filepath
str } description="Retrieves 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." />
### functions
list[ Function ] } description="Returns all Functions in the file." />
### global\_vars
list[ Assignment ] } description="Returns all GlobalVars in the file." />
### import\_module\_name
str } description="Returns the module name that this file gets imported as." />
### import\_statements
list[ ImportStatement ] } description="Returns all ImportStatements in the file, where each import statement can contain" />
### importers
list[ Import ] } description="Returns all imports that directly imports this file as a module." />
### imports
list[ Import ] } description="List of all Imports in this file." />
### inbound\_imports
list[ Import ] } description="Returns all imports that are importing symbols contained in this file." />
### interfaces
list[ TSInterface ] } description="Returns all Interfaces in the file." />
### is\_binary
bool } description="Indicates whether the file contains binary data." />
### 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\_reexported
bool } description="Determines if the symbol is re-exported from a different file." />
### jsx\_elements
list[ JSXElement [ TSFile ]] } 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." />
### named\_exports
list[ TSExport ] } description="Returns the named exports declared in the file." />
### node\_type
Literal[NodeType.FILE] }
description="
"
/>
### owners
set[str] } description="Returns the CODEOWNERS of the file." />
### parent
Editable }
description="
"
/>
### parent\_class
Class | None } description="Find the class this node is contained in" />
### parent\_function
Function | None } description="Find the function this node is contained in" />
### parent\_statement
Statement | None } description="Find the statement this node is contained in" />
### path
Path }
description="
"
/>
### programming\_language
}
description="
"
/>
### resolved\_value
Expression | list[ Expression ] } description="Returns the resolved type of an Expression." />
### source
str } description="Text representation of the Editable instance." />
### start\_byte
int } description="Returns the starting byte position of a file in its content." />
### symbols\_sorted\_topologically
list[ Symbol ] } description="Returns all Symbols in the file, sorted topologically (parents first). Robust to" />
### ts\_config
TSConfig | None }
description="
"
/>
### ts\_node
TSNode }
description="
"
/>
### types
list[ TSTypeAlias ] } description="Returns all type aliases in the file." />
### variable\_usages
list[ Editable ] } description="Returns Editables for all TreeSitter node instances of variable usages within this node's" />
## Methods
### 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\_export\_to\_symbol
Adds an export keyword to a symbol in a TypeScript file.
TSSymbol } description="The TypeScript symbol (function, class, interface, etc.) to be exported." defaultValue="" />
None } description="" />
### add\_import\_from\_import\_string
Adds import to the file from a string representation of an import statement.
str } description="The string representation of the import statement to add." defaultValue="" />
None } description="" />
### add\_symbol
Adds `symbol` to the file.
Symbol } description="The symbol to add to the file." defaultValue="" />
bool, optional } description="Whether to export the symbol. Defaults to True." defaultValue="True" />
Symbol | None } description="The existing symbol if it already exists in the file or None if it was added." />
### add\_symbol\_from\_source
Adds a symbol to a file from a string representation.
str } description="String representation of the symbol to be added. This should be valid source code for" defaultValue="" />
None } description="The symbol is added directly to the file's content." />
### add\_symbol\_import
Adds an import to a file for a given symbol.
Symbol } description="The symbol to import." defaultValue="" />
str | None } description="Optional alias for the imported symbol. Defaults to None." defaultValue="None" />
ImportType } description="The type of import to use. Defaults to ImportType.UNKNOWN." defaultValue="ImportType.UNKNOWN" />
bool } description="Whether this is a type-only import. Defaults to False." defaultValue="False" />
Import | None } description="The existing import for the symbol or None if it was added." />
### ancestors
Find all ancestors of the node of the given type. Does not return itself
list[ Editable ] } description="" />
### edit
Replace the source of this `Editable` with `new_src`.
str } description="The new source text to replace the current text with." defaultValue="" />
bool } description="If True, adjusts the indentation of `new_src` to match the current text's indentation level. Defaults to False." defaultValue="False" />
int } description="The priority of the edit transaction. Higher priority edits are applied first. Defaults to 0." defaultValue="0" />
bool } description="If True, deduplicates identical transactions. 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\_by\_byte\_range
Finds all editable objects that overlap with the given byte range in the file.
Range } description="The byte range to search within the file." defaultValue="" />
list[ Editable ] } description="A list of all Editable objects that overlap with the given range." />
### 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 ] } description="A list of Editable objects representing the matching string literals." />
### flag
Adds a visual flag comment to the end of this Editable's source text.
CodeFlag[ TSFile ] } description="" />
### get\_class
Returns a specific Class by full name. Returns None if not found.
str } description="The full name of the class to search for." defaultValue="" />
Class | None } description="The matching Class object if found, None otherwise." />
### 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 [ TSFile ] | None } description="The matching JSX element if found, None otherwise." />
### get\_config
Returns the nearest tsconfig.json applicable to this file.
TSConfig | None } description="The TypeScript configuration object if found, None otherwise." />
### get\_export
Returns an export object with the specified name from the file.
str } description="The name of the export to find." defaultValue="" />
TSExport | None } description="The export object if found, None otherwise." />
### get\_export\_statement\_for\_path
Gets the first export of specified type that contains the given path in single or double quotes.
str } description="The path to check for in export statements" defaultValue="" />
str } description="Type of export to get - "WILDCARD", "TYPE", or "EXPORT" (default)" defaultValue=""EXPORT"" />
ExportStatement | None } description="The first matching export if found, None otherwise." />
### get\_extensions
Returns a list of file extensions that this class can parse.
list[str] } description="A list of file extensions including '.tsx', '.ts', '.jsx', and '.js'." />
### get\_function
Returns a specific Function by name.
str } description="The name of the function to find." defaultValue="" />
Function | None } description="The matching Function object if found, None otherwise." />
### get\_global\_var
Returns a specific global var by name. Returns None if not found.
str } description="The name of the global variable to find." defaultValue="" />
Assignment | None } description="The global variable if found, None otherwise." />
### get\_import
Returns the import with matching alias. Returns None if not found.
str } description="The alias name to search for. This can match either the direct import name or the aliased name." defaultValue="" />
Import | None } description="The import statement with the matching alias if found, None otherwise." />
### get\_import\_string
Generates and returns an import statement for the file.
str | None } description="Alternative name for the imported module. Defaults to None." defaultValue="None" />
str | None } description="Module path to import from. If None, uses file's default module name." defaultValue="None" />
ImportType } description="The type of import statement. Defaults to ImportType.UNKNOWN." defaultValue="ImportType.UNKNOWN" />
bool } description="Whether this is a type-only import. Defaults to False." defaultValue="False" />
str } description="A formatted import statement string importing all exports from the module." />
### get\_interface
Retrieves a specific interface from the file by its name.
str } description="The name of the interface to find." defaultValue="" />
TSInterface | None } description="The interface with the specified name if found, None otherwise." />
### get\_name
Returns the name node of the object.
Name | ChainedAttribute | 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\_namespace
Returns a specific namespace by name from the file's namespaces.
str } description="The name of the namespace to find." defaultValue="" />
TSNamespace | None } description="The namespace with the specified name if found, None otherwise." />
### get\_symbol
Gets a symbol by its name from the file.
str } description="The name of the symbol to find." defaultValue="" />
Symbol | None } description="The found symbol, or None if not found." />
### get\_type
Returns a specific Type by name from the file's types.
str } description="The name of the type alias to retrieve." defaultValue="" />
TSTypeAlias | None } description="The TypeScript type alias with the matching name, or None if not 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" />
list[ Editable ] } description="List of Editable objects representing variable usage nodes matching the given name." />
### has\_export\_statement\_for\_path
Checks if the file has exports of specified type that contains the given path in single or double quotes.
str } description="The path to check for in export statements" defaultValue="" />
str } description="Type of export to check for - "WILDCARD", "TYPE", or "EXPORT" (default)" defaultValue=""EXPORT"" />
bool } description="True if there exists an export of specified type with the exact relative path (quoted) in its source, False otherwise." />
### has\_import
Returns True if the file has an import with the given alias.
str } description="The alias to check for in the import statements." defaultValue="" />
bool } description="True if an import with the given alias exists, False otherwise." />
### 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 this node's source with optional indentation and newline handling.
str } description="The text to insert before this node." defaultValue="" />
bool } description="Whether to fix the indentation of new_src to match the current node. Defaults to False." defaultValue="False" />
bool } description="Whether to add a newline after new_src. Defaults to True." defaultValue="True" />
int } description="Transaction priority for managing multiple edits. Defaults to 0." defaultValue="0" />
bool } description="Whether to deduplicate identical transactions. Defaults to True." defaultValue="True" />
None } description="" />
### is\_wrapped\_in
Check if this node is contained another node of the given class
bool } description="" />
### parent\_of\_type
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
Removes the file from the file system and graph.
None } description="" />
### remove\_unused\_exports
Removes unused exports from the file.
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\_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\_name
Sets the name of a code element.
str } description="The new name to set for the object." defaultValue="" />
None } description="" />
### symbol\_can\_be\_added
Determines if a TypeScript symbol can be added to this file based on its type and JSX compatibility.
TSSymbol } description="The TypeScript symbol to be checked." defaultValue="" />
bool } description="True if the symbol can be added to this file, False otherwise." />
### 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[ Import | Symbol | Export ] } description="A list of symbols that use or import the exportable object." />
### symbols
Returns all Symbols in the file, sorted by position in the file.
list[ Symbol | Class | Function | Assignment | TInterface] } description="A list of all top-level symbols in the file, sorted by their position in the file. Symbols can be one of the following types: - Symbol: Base symbol class - TClass: Class definition - TFunction: Function definition - TGlobalVar: Global variable assignment - TInterface: Interface definition" />
### update\_filepath
Updates the file path of the current file and all associated imports.
str } description="The new file path to move the file to." defaultValue="" />
None } description="" />
### 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." />