> ## Documentation Index
> Fetch the complete documentation index at: https://codegeninc-tawsif-change-additional-tools-to-tools.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# FunctionCall
> Abstract representation of a function invocation, e.g. in Python: ``` def f(): g() # FunctionCall ```
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
[Expression](/api-reference/core/Expression), [HasName](/api-reference/core/HasName), [Editable](/api-reference/core/Editable)
## Attributes
### args
Collection[ Argument , FunctionCall ] } description="Returns a list of arguments passed into the function invocation." />
### attribute\_chain
list[ FunctionCall | Name ] } description="Returns a list of elements in the chainedAttribute that the function call belongs in." />
### base
Editable | None } description="Returns the base object of this function call chain." />
### call\_chain
list[ FunctionCall ] } description="Returns a list of all function calls in this function call chain, including this call. Does not include calls made after this one." />
### 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." />
### file
SourceFile } 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 a list of all function calls contained within this function call." />
### function\_definition
Callable | None } description="Returns the resolved function definition that is being called." />
### function\_definitions
list[ Callable ] } description="Returns a list of callable objects that could potentially be the target of this function" />
### is\_awaited
bool } description="Determine if this function call is ultimately awaited in the TypeScript AST." />
### name
str | None } description="Retrieves the base name of the object without namespace prefixes." />
### parent
Editable } description="The parent node of this Editable instance." />
### parent\_class
Class | None } description="Find the class this node is contained in" />
### parent\_function
Function | None } description="Retrieves the parent function of the current function call." />
### parent\_statement
Statement | None } description="Find the statement this node is contained in" />
### predecessor
FunctionCall [ Editable ] | None } description="Returns the previous function call in a function call chain." />
### promise\_chain
TSPromiseChain | None } description="Return the promise chain associated with this function call, if a then call is found." />
### resolved\_value
Expression | list[ Expression ] } description="Returns the resolved type of an Expression." />
### source
str } description="Gets the source code representation of this FunctionCall." />
### successor
FunctionCall [ Editable ] | None } description="Returns the next function call in a function call chain." />
### variable\_usages
list[ Editable ] } description="Returns Editables for all TreeSitter node instances of variable usages within this node's" />
## Methods
### ancestors
Find all ancestors of the node of the given type. Does not return itself
list[ Editable ] } description="" />
### asyncify
Converts the function call to an async function call by wrapping it with 'await'.
None } description="" />
### convert\_args\_to\_kwargs
Converts positional arguments in a function call to keyword arguments.
int } description="Number of leading positional arguments to exclude from conversion. Defaults to 0." defaultValue="0" />
None } 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\_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 [ FunctionCall ]] } 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[ FunctionCall ] } description="" />
### from\_usage
Creates a FunctionCall object from an Editable instance that represents a function call.
Editable [ Editable ] } description="The Editable node that potentially represents a function call." defaultValue="" />
Editable | None } description="The parent node for the new FunctionCall. If None, uses the parent from the input node." defaultValue="None" />
FunctionCall | None } description="A new FunctionCall object if the input node represents a function call, None otherwise." />
### get\_arg\_by\_index
Returns the Argument with the given index from the function call's argument list.
int } description="The index of the argument to retrieve." defaultValue="" />
Argument | None } description="The Argument object at the specified index, or None if the index is out of bounds." />
### get\_arg\_by\_parameter\_name
Returns an argument by its parameter name.
str } description="The name of the parameter to search for." defaultValue="" />
Argument | None } description="The matching argument 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\_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 [ FunctionCall ]] } 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 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\_child\_of
Checks if this node is a descendant of the given editable instance in the AST.
bool } 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="" />
### 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
Removes a node and optionally its related extended nodes.
bool, optional } description="Whether to delete associated formatting nodes. Defaults to True." defaultValue="True" />
int, optional } description="Priority level for the removal operation. Defaults to 0." defaultValue="0" />
bool, optional } description="Whether to deduplicate identical removals. Defaults to True." defaultValue="True" />
None } description="" />
### rename
Sets the name of an object and updates all its usages.
str } description="The new name to assign to the object." defaultValue="" />
None } description="" />
### 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\_kwarg
Set a keyword argument in a function call.
str } description="The name of the parameter/argument to set." defaultValue="" />
str } description="The value to set the argument to." defaultValue="" />
bool, optional } description="If True, creates a new keyword argument if it doesn't exist. Defaults to True." defaultValue="True" />
bool, optional } description="If True, modifies the value of existing argument. Defaults to True." defaultValue="True" />
None } description="" />
### set\_name
Sets the name of a code element.
str } description="The new name to set for the object." defaultValue="" />
None } description="" />