RoadmapShopEvents
Skip to main content

Home > @microsoft/api-extractor-model > IApiMethodOptions

IApiMethodOptions interface

Constructor options for ApiMethod.

Signature:

export interface IApiMethodOptions extends IApiNameMixinOptions, IApiOptionalMixinOptions, IApiParameterListMixinOptions, IApiProtectedMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiStaticMixinOptions, IApiTypeParameterListMixinOptions, IApiDeclaredItemOptions 

Extends: IApiNameMixinOptions, IApiOptionalMixinOptions, IApiParameterListMixinOptions, IApiProtectedMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiStaticMixinOptions, IApiTypeParameterListMixinOptions, IApiDeclaredItemOptions

Properties

PropertyModifiersTypeDescription
docCommenttsdoc.DocComment | undefined(Inherited from IApiDocumentedItemOptions)
excerptTokensIExcerptToken[](Inherited from IApiDeclaredItemOptions)
isOptionalboolean(Inherited from IApiOptionalMixinOptions)
isProtectedboolean(Inherited from IApiProtectedMixinOptions)
isStaticboolean(Inherited from IApiStaticMixinOptions)
namestring(Inherited from IApiNameMixinOptions)
overloadIndexnumber(Inherited from IApiParameterListMixinOptions)
parametersIApiParameterOptions[](Inherited from IApiParameterListMixinOptions)
releaseTagReleaseTag(Inherited from IApiReleaseTagMixinOptions)
returnTypeTokenRangeIExcerptTokenRange(Inherited from IApiReturnTypeMixinOptions)
typeParametersIApiTypeParameterOptions[](Inherited from IApiTypeParameterListMixinOptions)