Improve this page

api-extractor-task.json

Supported file paths

  • common/config/heft/api-extractor-task.json
  • <project folder>/.heft/api-extractor-task.json

Template

/**
 * Configures the API Extractor task for the Heft build system.
 *
 * This optional additional file customizes how the Heft task is invoked. The main analysis is
 * controlled by API Extractor's own "api-extractor.json" config file.
 */
{
  "$schema": "https://developer.microsoft.com/json-schemas/heft/api-extractor-task.schema.json"

  /**
   * If set to true, use the project's TypeScript compiler version for API Extractor's
   * analysis. API Extractor's included TypeScript compiler can generally correctly
   * analyze typings generated by older compilers, and referencing the project's compiler
   * can cause issues. If issues are encountered with API Extractor's included compiler,
   * set this option to true.
   *
   * This corresponds to API Extractor's "--typescript-compiler-folder" CLI option and
   * "IExtractorInvokeOptions.typescriptCompilerFolder" API option. This option defaults to false.
   */
  // "useProjectTypescriptVersion": true
}