Home > @nabh/ts-api-extractor > APIEntity
APIEntity class
Root class for all API metadata objects that defines common properties
Signature:
export declare class APIEntity
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(name, kind) | Constructs a new instance of the APIEntity class |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
comment? | string | (Optional) Summary part of the TSDoc comment for the object | |
isDeprecated? | boolean | string | (Optional) Is this type deprecated. string value specifies TSDoc comment for at-deprecated tag |
|
kind | APIKind | Kind of API object | |
name | string | Name of the class, interface, type, method, etc. |