@lazyconfig/api-extractor

Shared API Extractor base configuration for generating rolled-up .d.ts declaration files.

Installation

npm install --save-dev @lazyconfig/api-extractor @microsoft/api-extractor

Usage

Create an api-extractor.json in your package and extend the base config:

{
	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
	"extends": "@lazyconfig/api-extractor/base.json",
	"projectFolder": ".",
	"mainEntryPointFilePath": "<projectFolder>/out-tsc/index.d.ts",
	"dtsRollup": {
		"enabled": true,
		"untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.index.d.ts",
		"alphaTrimmedFilePath": "",
		"betaTrimmedFilePath": "",
		"publicTrimmedFilePath": ""
	}
}

Base configuration

The base config sets the following defaults:

| Setting | Value | Description | | --------------------------- | --------------------------------------------- | ------------------------------------------------- | | newlineKind | lf | Consistent line endings across platforms. | | enumMemberOrder | preserve | Keeps enum member order as declared in source. | | compiler.overrideTsconfig | moduleResolution: Bundler, target: ES2022 | Aligns with modern bundler output. | | apiReport | disabled | API report file generation is off by default. | | docModel | disabled | Doc model generation is off by default. | | dtsRollup | enabled | Produces a single rolled-up .d.ts file. | | tsdocMetadata | disabled | TSDoc metadata file generation is off by default. | | ae-missing-release-tag | suppressed | Release tag annotations are not required. | | ae-undocumented | suppressed | Undocumented public members do not raise errors. |

License

MIT