Rush StackShopBlogEvents
Skip to main content

Home > @microsoft/api-extractor > IConfigDtsRollup

IConfigDtsRollup interface

Configures how the .d.ts rollup file will be generated.

Signature:

export interface IConfigDtsRollup 

Remarks

This is part of the IConfigFile structure.

Properties

Property

Modifiers

Type

Description

alphaTrimmedFilePath?

string

(Optional) Specifies the output path for a .d.ts rollup file to be generated with trimming for an "alpha" release.

betaTrimmedFilePath?

string

(Optional) Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release.

enabled

boolean

Whether to generate the .d.ts rollup file.

omitTrimmingComments?

boolean

(Optional) When a declaration is trimmed, by default it will be replaced by a code comment such as "Excluded from this release type: exampleMember". Set "omitTrimmingComments" to true to remove the declaration completely.

publicTrimmedFilePath?

string

(Optional) Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release.

untrimmedFilePath?

string

(Optional) Specifies the output path for a .d.ts rollup file to be generated without any trimming.