RoadmapShopEvents
Skip to main content

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

IApiPackageOptions interface

Constructor options for ApiPackage.

Signature:

export interface IApiPackageOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiDocumentedItemOptions 

Extends: IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiDocumentedItemOptions

Properties

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

(Optional)

(Inherited from IApiItemContainerMixinOptions)

namestring(Inherited from IApiNameMixinOptions)
preserveMemberOrder?boolean

(Optional)

(Inherited from IApiItemContainerMixinOptions)

tsdocConfigurationTSDocConfiguration