aboutsummaryrefslogtreecommitdiff
path: root/scripts/apidoc/apiDocsWriter.ts
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2023-02-01 22:33:15 +0100
committerGitHub <[email protected]>2023-02-01 22:33:15 +0100
commit9c3618d66550b7a72cade402b035ecdbcb485625 (patch)
tree0f6792026c965c745f6763b9ba1b14a3d26f828e /scripts/apidoc/apiDocsWriter.ts
parentde7ed2e3b823131345995da6ec52c2b0c40c8d6e (diff)
downloadfaker-9c3618d66550b7a72cade402b035ecdbcb485625.tar.xz
faker-9c3618d66550b7a72cade402b035ecdbcb485625.zip
infra(docs): add docs diff script (#1755)
Diffstat (limited to 'scripts/apidoc/apiDocsWriter.ts')
-rw-r--r--scripts/apidoc/apiDocsWriter.ts8
1 files changed, 6 insertions, 2 deletions
diff --git a/scripts/apidoc/apiDocsWriter.ts b/scripts/apidoc/apiDocsWriter.ts
index f18b7cd9..d40dec34 100644
--- a/scripts/apidoc/apiDocsWriter.ts
+++ b/scripts/apidoc/apiDocsWriter.ts
@@ -9,8 +9,8 @@ import {
selectApiMethods,
selectApiModules,
} from './typedoc';
-import type { PageIndex } from './utils';
-import { pathDocsDir, pathOutputDir } from './utils';
+import type { DocsApiDiffIndex, PageIndex } from './utils';
+import { pathDocsDiffIndexFile, pathDocsDir, pathOutputDir } from './utils';
const pathDocsApiPages = resolve(pathDocsDir, '.vitepress', 'api-pages.ts');
const pathDocsApiSearchIndex = resolve(
@@ -120,6 +120,10 @@ export function writeApiPagesIndex(pages: PageIndex): void {
writeFileSync(pathDocsApiPages, apiPagesContent);
}
+export function writeApiDiffIndex(diffIndex: DocsApiDiffIndex): void {
+ writeFileSync(pathDocsDiffIndexFile, JSON.stringify(diffIndex));
+}
+
export function writeApiSearchIndex(project: ProjectReflection): void {
const apiIndex: APIGroup[] = [];