Griffe TypeDoc package.
Signatures for entire TypeScript programs using TypeDoc.
dataclass ¤
Accessor(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
get_signature: GetSignature | None = None,
set_signature: SetSignature | None = None,
overwrites: Type | None = None,
implementation_of: Type | None = None,
inherited_from: Type | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
dataclass ¤
BlockTagContent(
*,
kind: BlockTagContentKind,
text: str,
target: int | str | None = None,
ts_link_text: str | None = None,
)
dataclass ¤
CallSignature(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type,
parameters: list[Parameter] | None = None,
type_parameters: list[TypeParameter] | None = None,
overwrites: Type | None = None,
implementation_of: Type | None = None,
inherited_from: Type | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
class-attribute instance-attribute ¤
type_parameters: list[TypeParameter] | None = None
dataclass ¤
Class(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
extended_types: list[Type] | None = None,
extended_by: list[Type] | None = None,
implemented_types: list[Type] | None = None,
index_signatures: list[IndexSignature] | None = None,
type_parameters: list[TypeParameter] | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
class-attribute instance-attribute ¤
index_signatures: list[IndexSignature] | None = None
class-attribute instance-attribute ¤
type_parameters: list[TypeParameter] | None = None
dataclass ¤
dataclass ¤
Constructor(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
signatures: list[ConstructorSignature] | None = None,
overwrites: Type | None = None,
inherited_from: Type | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
class-attribute instance-attribute ¤
signatures: list[ConstructorSignature] | None = None
dataclass ¤
ConstructorSignature(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
parameters: list[Parameter] | None = None,
overwrites: Type | None = None,
inherited_from: Type | None = None,
type_parameters: list[TypeParameter] | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
class-attribute instance-attribute ¤
type_parameters: list[TypeParameter] | None = None
dataclass ¤
Enum(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
dataclass ¤
EnumMember(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
dataclass ¤
dataclass ¤
Function(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
signatures: list[CallSignature],
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
dataclass ¤
GetSignature(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
overwrites: Type | None = None,
implementation_of: Type | None = None,
inherited_from: Type | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
dataclass ¤
Group(*, title: str, children: list[int | Reflection])
dataclass ¤
IndexSignature(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type,
parameters: list[Parameter] | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
dataclass ¤
Interface(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
extended_types: list[Type] | None = None,
extended_by: list[Type] | None = None,
type_parameters: list[TypeParameter] | None = None,
index_signature: IndexSignature | None = None,
implemented_by: list[Type] | None = None,
index_signatures: list[IndexSignature] | None = None,
signatures: list[CallSignature] | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
class-attribute instance-attribute ¤
index_signatures: list[IndexSignature] | None = None
class-attribute instance-attribute ¤
type_parameters: list[TypeParameter] | None = None
dataclass ¤
Method(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
signatures: list[CallSignature],
overwrites: Type | None = None,
implementation_of: Type | None = None,
inherited_from: Type | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
dataclass ¤
Module(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
package_version: str | None = None,
readme: str | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
dataclass ¤
Namespace(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
dataclass ¤
Parameter(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
default_value: str | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
dataclass ¤
Project(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
package_name: str,
readme: list[BlockTagContent] | None = None,
symbol_id_map: dict[int, Reflection] = dict(),
package_version: str | None = None,
files: FileRegistry | None = None,
)
Bases: Reflection
dataclass ¤
Property(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type,
inherited_from: Type | None = None,
overwrites: Type | None = None,
default_value: str | None = None,
implementation_of: Type | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
dataclass ¤
Reference(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
target: int,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
dataclass ¤
Reflection(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
)
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
dataclass ¤
SetSignature(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
parameters: list[Parameter] | None = None,
overwrites: Type | None = None,
implementation_of: Type | None = None,
inherited_from: Type | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
dataclass ¤
dataclass ¤
dataclass ¤
Type(
*,
type: TypeKind,
name: str | None = None,
target: int | Target | None = None,
package: str | None = None,
type_arguments: list[Type] | None = None,
qualified_name: str | None = None,
element_type: Type | None = None,
refers_to_type_parameter: bool | None = None,
value: str | None = None,
types: list[Type] | None = None,
declaration: TypeLiteral | None = None,
elements: list[Type] | None = None,
prefer_values: bool | None = None,
query_type: Type | None = None,
operator: str | None = None,
parameter: str | None = None,
parameter_type: Type | None = None,
template_type: Type | None = None,
)
dataclass ¤
TypeAlias(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type,
type_parameters: list[TypeParameter] | None = None,
implemented_by: list[Type] | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
class-attribute instance-attribute ¤
type_parameters: list[TypeParameter] | None = None
dataclass ¤
TypeLiteral(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
signatures: list[CallSignature] | None = None,
index_signatures: list[IndexSignature] | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
class-attribute instance-attribute ¤
index_signatures: list[IndexSignature] | None = None
dataclass ¤
TypeParameter(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type | None = None,
default: Type | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
Bases: JSONDecoder
JSON decoder.
Parameters:
-
*args(Any, default:()) –Arguments passed to parent init method.
-
*kwargs(Any, default:{}) –Keyword arguments passed to parent init method.
dataclass ¤
Variable(
*,
id: int,
name: str,
variant: str,
comment: Comment | None = None,
children: list[Reflection] = list(),
flags: dict = dict(),
groups: list[Group] = list(),
sources: list[Source] = list(),
parent: Reflection | None = None,
type: Type,
default_value: str | None = None,
)
Bases: Reflection
class-attribute instance-attribute ¤
children: list[Reflection] = field(default_factory=list)
get_logger(name: str) -> _Logger
Create and return a new logger instance.
Parameters:
-
name(str) –The logger name.
Returns:
-
_Logger–The logger.
get_parser() -> ArgumentParser