Home > @nabh/ts-api-extractor > APIMethod
APIMethod class
Class or interface method
Signature:
export declare class APIMethod
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 method marked as protected? | |
| isStatic? | boolean | (Optional) Is this a static method? | |
| name | string | Method name | |
| params | Array<APIParam> | Method parameters | |
| returns | APIParam | Qualified return type | |
| returnType | APIType | Method return type |