TSExport

Represents a single exported symbol. There is a 1:M relationship between an ExportStatement and an Export

Inherits from

HasValue, Export, Editable, Exportable, Usable, Importable, Expression, HasName

Attributes

declared_symbol

descendant_symbols

export

export_statement

exported_name

exported_symbol

extended

extended_source

file

filepath

full_name

function_calls

is_exported

is_external_export

is_reexported

name

parent

parent_class

parent_function

parent_statement

resolved_symbol

resolved_value

source

value

variable_usages

Methods

ancestors

Find all ancestors of the node of the given type. Does not return itself

dependencies

Returns a list of symbols that this symbol depends on.

edit

Replace the source of this Editable with new_src.

find

Find and return matching nodes or substrings within an Editable instance.

find_string_literals

Returns a list of string literals within this node’s source that match any of the given

flag

Adds a visual flag comment to the end of this Editable’s source text.

get_import_string

Returns the import string for this export.

get_name

Returns the name node of the object.

get_variable_usages

Returns Editables for all TreeSitter nodes corresponding to instances of variable usage

insert_after

Inserts code after this node.

insert_before

Inserts text before this node’s source with optional indentation and newline handling.

is_aliased

Determines if the Export object is aliased.

is_child_of

Checks if this node is a descendant of the given editable instance in the AST.

is_default_export

Determines if an export is the default export for a file.

is_default_symbol_export

Returns True if this is exporting a default symbol, as opposed to a default object export.

is_module_export

Determines if the export is exporting a module rather than a symbol.

is_named_export

Determines whether this export is a named export.

is_reexport

Returns whether the export is re-exporting an import or export.

is_type_export

Determines if this export is exclusively exporting a type.

is_wildcard_export

Determines if the export is a wildcard export.

is_wrapped_in

Check if this node is contained another node of the given class

make_non_default

Converts the export to a named export.

parent_of_type

Find the first ancestor of the node of the given type. Does not return itself

parent_of_types

Find the first ancestor of the node of the given type. Does not return itself

reduce_condition

Reduces an editable to the following condition

reexport_symbol

Returns the import object that is re-exporting this symbol.

remove

Deletes this Node and its related extended nodes (e.g. decorators, comments).

rename

Renames a symbol and updates all its references in the codebase.

replace

Search and replace occurrences of text within this node’s source and its extended nodes.

search

Returns a list of all regex match of regex_pattern, similar to python’s re.search().

set_name

Sets the name of a code element.

set_value

Sets the value of the node’s value Expression.

symbol_usages

Returns a list of symbols that use or import the exportable object.

to_import_string

Converts this export into its equivalent import string representation.

usages

Returns a list of usages of the exportable object.