Home > @nabh/ts-api-extractor > APIProperty
APIProperty class
Class or interface property
Signature:
export declare class APIProperty
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| comment? | string | (Optional) Summary section of TSDoc comment on this property | |
| isDeprecated? | boolean | string | (Optional) Is this type deprecated. string value specifies TSDoc comment for at-deprecated tag |
|
| isOptional? | boolean | (Optional) Is the parameter optional | |
| isProtected? | boolean | (Optional) Is this property marked as protected? | |
| isReadOnly? | boolean | (Optional) Is this property read only? | |
| isStatic? | boolean | (Optional) Is this a static property? | |
| name | string | Property name | |
| package? | string | (Optional) Package that exported this property type. Applicable for non-primitive properties | |
| type | string | Property type |