api-extractor.json

/**
 * Config file for API Extractor.  For more info, please visit: https://api-extractor.com
 */
{
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
  // "extends": "./shared/api-extractor-base.json"
  // "projectFolder": "<lookup>", // traverses parent folders until it finds a tsconfig.json file
  "mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts",
  "bundledPackages": [],
  // "newlineKind": "crlf",
  // "testMode": false,
  // "enumMemberOrder": "by-name",
  "compiler": {
    // "tsconfigFilePath": "<projectFolder>/tsconfig.json",
    // "overrideTsconfig": {
    // }
    // "skipLibCheck": true,
  },
  "apiReport": {
    "enabled": true,
    // "reportFileName": "<unscopedPackageName>.api.md",
    "reportFolder": "<projectFolder>/.tbdocs/reporter",
    // "reportTempFolder": "<projectFolder>/temp/",
    "includeForgottenExports": true
  },
  "docModel": {
    "enabled": true,
    "apiJsonFilePath": "<projectFolder>/.tbdocs/reporter/<unscopedPackageName>.api.json"
    // "includeForgottenExports": false,
    // "projectFolderUrl": "http://github.com/path/to/your/projectFolder"
  },
  "dtsRollup": {
    "enabled": true,
    "untrimmedFilePath": "<projectFolder>/.tbdocs/reporter/<unscopedPackageName>.d.ts",
    "alphaTrimmedFilePath": "<projectFolder>/.tbdocs/reporter/<unscopedPackageName>-alpha.d.ts",
    "betaTrimmedFilePath": "<projectFolder>/.tbdocs/reporter/<unscopedPackageName>-beta.d.ts",
    "publicTrimmedFilePath": "<projectFolder>/.tbdocs/reporter/<unscopedPackageName>-public.d.ts"
    // "omitTrimmingComments": true
  },

  "tsdocMetadata": {
    "enabled": true,
    "tsdocMetadataFilePath": "<projectFolder>/.tbdocs/reporter/tsdoc-metadata.json"
  },

  "messages": {
    "compilerMessageReporting": {
      "default": {
        "logLevel": "warning"
        // "addToApiReportFile": false
      }
    },
    "extractorMessageReporting": {
      "default": {
        "logLevel": "warning"
        // "addToApiReportFile": true
      },
      "ae-undocumented": {
        "logLevel": "warning"
      }
    },
    "tsdocMessageReporting": {
      "default": {
        "logLevel": "warning"
        // "addToApiReportFile": true
      }
    }
  }
}