RoadmapShopEvents
Skip to main content

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

IApiClassOptions interface

Constructor options for ApiClass.

Signature:

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

Extends: IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions, IApiTypeParameterListMixinOptions

Properties

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

(Optional)

(Inherited from IApiItemContainerMixinOptions)

namestring(Inherited from IApiNameMixinOptions)
preserveMemberOrder?boolean

(Optional)

(Inherited from IApiItemContainerMixinOptions)

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