numaflow-js/typedoc.json at main · numaproj/numaflow-js · 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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
{
  "$schema": "https://typedoc.org/schema.json",
  "entryPoints": ["./index.ts"],
  "out": "./docs",
  "name": "@numaproj/numaflow-js",
  "readme": "./README.md",
  "includeVersion": true,
  "excludePrivate": true,
  "excludeProtected": true,
  "excludeInternal": true,
  "excludeExternals": true,
  "externalPattern": ["**/binding.d.ts", "**/node_modules/**"],
  "skipErrorChecking": true,
  "treatWarningsAsErrors": false,
  "searchInComments": true,
  "navigationLinks": {
    "GitHub": "https://github.com/numaproj/numaflow-js",
    "Numaflow Docs": "https://numaflow.numaproj.io/"
  },
  "sidebarLinks": {},
  "customCss": "./docs-theme.css",
  "disableSources": false,
  "plugin": [],
  "externalSymbolLinkMappings": {
    "global": {
      "Buffer": "https://nodejs.org/api/buffer.html"
    },
    "typescript": {
      "Promise": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",
      "Date": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date",
      "Array": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array",
      "Record": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
      "Partial": "https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype",
      "Required": "https://www.typescriptlang.org/docs/handbook/utility-types.html#requiredtype",
      "Readonly": "https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype",
      "Pick": "https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys",
      "Omit": "https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys",
      "AsyncIterable": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncIterator",
      "AsyncIterableIterator": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncIterator",
      "IteratorResult": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Iterator"
    },
    "@types/node": {
      "Buffer": "https://nodejs.org/api/buffer.html",
      "__global.Buffer": "https://nodejs.org/api/buffer.html"
    }
  },
  "categorizeByGroup": true,
  "sort": ["kind", "alphabetical"],
  "kindSortOrder": [
    "Reference",
    "Project",
    "Module",
    "Namespace",
    "Enum",
    "EnumMember",
    "Class",
    "Interface",
    "TypeAlias",
    "Constructor",
    "Property",
    "Variable",
    "Function",
    "Accessor",
    "Method",
    "Parameter",
    "TypeParameter",
    "TypeLiteral",
    "CallSignature",
    "ConstructorSignature",
    "IndexSignature",
    "GetSignature",
    "SetSignature"
  ]
}