TypeInfo

A documented export: a class, interface, enum, type alias, function or variable.

Import:

import type { TypeInfo } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-doc-types';

Signature:

export interface TypeInfo

Properties

Property	Type	Description
baseTypes	string[]
constructorInfo?	MemberInfo \| undefined	For classes: the constructor (public/protected), if any
description	string
enumMembers	EnumMemberInfo[]	For enums: the enum members
examples	string[]
implementsTypes	string[]	For classes: types in the `implements` clause
kind	'class' \| 'enum' \| 'function' \| 'interface' \| 'type' \| 'variable'
methods	MemberInfo[]
name	string
namespace	string
properties	MemberInfo[]
remarks	string
typeAliasText?	string	For type aliases: the right-hand-side type text
typeParameters	string[]
variableKeyword?	string	For variables: the declaration keyword (let/const/var)
variableType?	string	For variables: the type annotation

Links to this page: