RoadmapShopEvents
Skip to main content

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

IApiMethodSignatureOptions interface

Signature:

export interface IApiMethodSignatureOptions extends IApiNameMixinOptions, IApiTypeParameterListMixinOptions, IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiOptionalMixinOptions, IApiDeclaredItemOptions 

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

Properties

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