RoadmapShopEvents
Skip to main content

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

IApiInterfaceOptions interface

Constructor options for ApiInterface.

Signature:

export interface IApiInterfaceOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiTypeParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions 

Extends: IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiTypeParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions

Properties

PropertyModifiersTypeDescription
docCommenttsdoc.DocComment | undefined(Inherited from IApiDocumentedItemOptions)
excerptTokensIExcerptToken[](Inherited from IApiDeclaredItemOptions)
extendsTokenRangesIExcerptTokenRange[]
members?ApiItem[]

(Optional)

(Inherited from IApiItemContainerMixinOptions)

namestring(Inherited from IApiNameMixinOptions)
preserveMemberOrder?boolean

(Optional)

(Inherited from IApiItemContainerMixinOptions)

releaseTagReleaseTag(Inherited from IApiReleaseTagMixinOptions)
typeParametersIApiTypeParameterOptions[](Inherited from IApiTypeParameterListMixinOptions)