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
| Property | Modifiers | Type | Description |
|---|---|---|---|
| docComment | tsdoc.DocComment | undefined | (Inherited from IApiDocumentedItemOptions) | |
| excerptTokens | IExcerptToken[] | (Inherited from IApiDeclaredItemOptions) | |
| isReadonly | boolean | (Inherited from IApiReadonlyMixinOptions) | |
| overloadIndex | number | (Inherited from IApiParameterListMixinOptions) | |
| parameters | IApiParameterOptions[] | (Inherited from IApiParameterListMixinOptions) | |
| releaseTag | ReleaseTag | (Inherited from IApiReleaseTagMixinOptions) | |
| returnTypeTokenRange | IExcerptTokenRange | (Inherited from IApiReturnTypeMixinOptions) |