@microsoft/api-extractor
Version:
Validatation, documentation, and auditing for the exported API of a TypeScript package
16 lines (15 loc) • 665 B
TypeScript
import { IApiItemOptions } from './ApiItem';
import ApiMember from './ApiMember';
import ApiParameter from './ApiParameter';
/**
* This class is part of the ApiItem abstract syntax tree. It represents functions that are members of
* classes, interfaces, or nested type literal expressions. Unlike ApiFunctions, ApiMethods can have
* access modifiers (public, private, etc.) or be optional, because they are members of a structured type
*
* @see ApiFunction for functions that are defined inside of a package
*/
export default class ApiMethod extends ApiMember {
returnType: string;
params: ApiParameter[];
constructor(options: IApiItemOptions);
}