node-av/typedoc.json at main · seydx/node-av · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{
  "plugin": [
    "typedoc-plugin-markdown",
    "typedoc-vitepress-theme"
  ],
  "entryPoints": [
    "./src/api/index.ts",
    "./src/api/utilities/index.ts",
    "./src/lib/index.ts",
    "./src/lib/native-types.ts",
    "./src/constants/index.ts",
    "./src/ffmpeg/index.ts"
  ],
  "exclude": [
    "**/*.test.ts",
    "**/examples/**",
    "**/examples/electron/**",
    "**/*.cc",
    "**/*.h"
  ],
  "externalPattern": [
    "**/*.test.ts",
    "**/examples/**",
    "**/*.cc",
    "**/*.h",
    "examples/*.ts",
    "**/examples/electron/**",
    "**/externals/**"
  ],
  "excludeExternals": true,
  "out": "./docs/api",
  "docsRoot": "./docs",
  "sidebar": {
    "autoConfiguration": true,
    "format": "vitepress",
    "pretty": false,
    "collapsed": true
  },
  "validation": {
    "notExported": true,
    "invalidLink": true,
    "rewrittenLink": true,
    "notDocumented": false,
    "unusedMergeModuleWith": true
  },
  "externalSymbolLinkMappings": {
    "global": {
      "SymbolConstructor.dispose": "https://tc39.es/proposal-explicit-resource-management/#sec-disposable-interface",
      "SymbolConstructor.asyncDispose": "https://tc39.es/proposal-explicit-resource-management/#table-asyncdisposable-interface-required-properties"
    },
    "typescript": {
      "SymbolConstructor.dispose": "https://tc39.es/proposal-explicit-resource-management/#sec-disposable-interface",
      "SymbolConstructor.asyncDispose": "https://tc39.es/proposal-explicit-resource-management/#table-asyncdisposable-interface-required-properties"
    }
  }
}