> ## Documentation Index
> Fetch the complete documentation index at: https://codegeninc-codegen-bot-sdk-docs-2-0.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# TSParameter
> A class representing a TypeScript function parameter with extensive type analysis capabilities. This class provides functionality to inspect and manipulate TypeScript function parameters, including support for destructured parameters, optional parameters, variadic parameters, default values, and type annotations.
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
[Parameter](/api-reference/core/Parameter), [HasValue](/api-reference/core/HasValue), [Expression](/api-reference/core/Expression), [Typeable](/api-reference/core/Typeable), [Usable](/api-reference/core/Usable), [Editable](/api-reference/core/Editable), [Importable](/api-reference/core/Importable), [HasName](/api-reference/core/HasName)
## Attributes
### default
str | None } description="Returns the default value of a parameter." />
### 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
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 a list of all function calls contained within this expression." />
### index
int } description="Returns the 0-based index of this parameter within its parent function's parameter list." />
### is\_destructured
bool } description="Determines if a parameter is part of an object destructuring pattern." />
### is\_optional
bool } description="Determines if a parameter is marked as optional in TypeScript." />
### is\_typed
bool } description="Indicates if a node has an explicit type annotation." />
### is\_variadic
bool } description="Determines if a parameter is variadic (using the rest operator)." />
### 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
TSClass | None } description="Find the class this node is contained in" />
### 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." />
### source
str } description="Text representation of the Editable instance." />
### type
Type | TypePlaceholder [ TSParameter ] } description="The type annotation associated with this node" />
### value
Expression | None } description="Gets the value node of the object." />
### 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="" />
### convert\_to\_interface
Converts a parameter's inline type definition to an interface.
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 `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 [ TSParameter ]] } 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[ TSParameter ] } description="" />
### 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\_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 [ TSParameter ]] } 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 the parameter from the function definition and all its call sites.
bool, optional } description="Whether to delete formatting around the parameter. 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 removal operations. Defaults to True." defaultValue="True" />
None } description="" />
### rename
Renames a parameter in a function definition and updates all related references.
str } description="The new name for the parameter." defaultValue="" />
int, optional } description="The priority of the edit operation. Defaults to 0." defaultValue="0" />
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\_name
Sets the name of a code element.
str } description="The new name to set for the object." defaultValue="" />
None } description="" />
### set\_type\_annotation
Sets the type annotation for this parameter.
str } description="The type annotation to set for the parameter." defaultValue="" />
None } description="" />
### set\_value
Sets the value of the node's value Expression.
str } description="The new value to set." defaultValue="" />
None } description="" />
### 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." />