convex/api-api-extractor.json

Client for the Convex Cloud

{
  "extends": "./api-extractor-base.json",
  "mainEntryPointFilePath": "<projectFolder>/dist/types/api/index.d.ts",
  "dtsRollup": {
    "untrimmedFilePath": "<projectFolder>/dist/types/api/api-internal.d.ts",
    "publicTrimmedFilePath": "<projectFolder>/dist/types/api/api.d.ts"
  },
  /**
   * Enable the apiReport but use the same reportFolder and tempFolder to make it a no-op.
   * This way forgotten exports are a warning instead of an error.
   */
  "apiReport": {
    "enabled": true,
    "reportFileName": "api-tmp.api.md",
    "reportFolder": "temp",
    "reportTempFolder": "temp"
  }
}