py2ts.data.TSEnumType

class py2ts.data.TSEnumType(name: str, elements: Dict[str, str | int], *, not_required: bool = False, comment: str | None = None)

Represents a TypeScript enum type.

Attributes

comment
not_required
elements
name

Methods

__init__(name, elements, *[, not_required, ...])
exclude(exclude)	Exclude fields from the enum type.
referenced_types()	Get all TypeScript types required for the current type.

__init__(name: str, elements: Dict[str, str | int], *, not_required: bool = False, comment: str | None = None) → None

exclude(exclude: set[str]) → TSEnumType

Exclude fields from the enum type.

Parameters:

exclude (set[str]) – A set of field names to exclude from the TypeScript enum.

Returns:

The modified enum type with the excluded fields.

Return type:

TypescriptType

referenced_types() → set[TypescriptType]

Get all TypeScript types required for the current type.

This method should gather all the necessary types and dependencies related to the current type, aiding in understanding and organizing generated code where multiple type inter-dependencies exist.