RoadmapShopEvents
Skip to main content

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

IApiIndexSignatureOptions interface

Constructor options for ApiIndexSignature.

Signature:

export interface IApiIndexSignatureOptions extends IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiReadonlyMixinOptions, IApiDeclaredItemOptions 

Extends: IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiReadonlyMixinOptions, IApiDeclaredItemOptions

Properties

PropertyModifiersTypeDescription
docCommenttsdoc.DocComment | undefined(Inherited from IApiDocumentedItemOptions)
excerptTokensIExcerptToken[](Inherited from IApiDeclaredItemOptions)
isReadonlyboolean(Inherited from IApiReadonlyMixinOptions)
overloadIndexnumber(Inherited from IApiParameterListMixinOptions)
parametersIApiParameterOptions[](Inherited from IApiParameterListMixinOptions)
releaseTagReleaseTag(Inherited from IApiReleaseTagMixinOptions)
returnTypeTokenRangeIExcerptTokenRange(Inherited from IApiReturnTypeMixinOptions)