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
Property | Modifiers | Type | Description |
---|---|---|---|
docComment | tsdoc.DocComment | undefined | (Inherited from IApiDocumentedItemOptions) | |
members? | ApiItem[] | (Optional) (Inherited from IApiItemContainerMixinOptions) | |
name | string | (Inherited from IApiNameMixinOptions) | |
preserveMemberOrder? | boolean | (Optional) (Inherited from IApiItemContainerMixinOptions) | |
tsdocConfiguration | TSDocConfiguration |