ts-api-extractor package
Generates API metadata from Typescript type definitions
Remarks
Version 1.2.6
Classes
Class | Description |
---|---|
APIClass | Describes Typescript class public signature |
APIEntity | Root class for all API metadata objects that defines common properties |
APIEnum | Describes enum definition |
APIEnumMember | enum member |
APIExtractor | Main class that provides methods for extracting API metadata |
APIInterface | Describes Typescript class public signature |
APIMetadata | Encapsulates package types metadata |
APIMethod | Class or interface method |
APIPackage | Package information |
APIParam | Class or interface property |
APIProperty | Class or interface property |
APIType | Qualified type reference that specifies the object type and package it is exported by |
APITypeAlias | Type alias |
Enumerations
Enumeration | Description |
---|---|
APIKind | Defines possible values for API metadata object “kind” property |