aboutsummaryrefslogtreecommitdiff
path: root/scripts/apidoc/apiDocsWriter.ts
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/apidoc/apiDocsWriter.ts')
-rw-r--r--scripts/apidoc/apiDocsWriter.ts22
1 files changed, 12 insertions, 10 deletions
diff --git a/scripts/apidoc/apiDocsWriter.ts b/scripts/apidoc/apiDocsWriter.ts
index 8bb9df5c..fe8f48c5 100644
--- a/scripts/apidoc/apiDocsWriter.ts
+++ b/scripts/apidoc/apiDocsWriter.ts
@@ -40,14 +40,14 @@ editLink: false
* @param deprecated The deprecation message.
* @param methods The methods of the module.
*/
-export function writeApiDocsModule(
+export async function writeApiDocsModule(
moduleName: string,
lowerModuleName: string,
comment: string,
deprecated: string | undefined,
methods: Method[]
-): ModuleSummary {
- writeApiDocsModulePage(
+): Promise<ModuleSummary> {
+ await writeApiDocsModulePage(
moduleName,
lowerModuleName,
comment,
@@ -85,13 +85,13 @@ export function writeApiDocsModule(
* @param comment The module comments.
* @param methods The methods of the module.
*/
-function writeApiDocsModulePage(
+async function writeApiDocsModulePage(
moduleName: string,
lowerModuleName: string,
comment: string,
deprecated: string | undefined,
methods: Method[]
-): void {
+): Promise<void> {
// Write api docs page
let content = `
<script setup>
@@ -131,7 +131,7 @@ function writeApiDocsModulePage(
.join('')}
`.replace(/\n +/g, '\n');
- content = vitePressInFileOptions + formatMarkdown(content);
+ content = vitePressInFileOptions + (await formatMarkdown(content));
writeFileSync(resolve(pathOutputDir, `${lowerModuleName}.md`), content);
}
@@ -164,7 +164,7 @@ function writeApiDocsModuleData(
*
* @param pages The pages to write into the index.
*/
-export function writeApiPagesIndex(pages: Page[]): void {
+export async function writeApiPagesIndex(pages: Page[]): Promise<void> {
// Write api-pages.ts
console.log('Updating api-pages.ts');
pages.splice(0, 0, { text: 'Overview', link: '/api/' });
@@ -174,7 +174,7 @@ export function writeApiPagesIndex(pages: Page[]): void {
export const apiPages = ${JSON.stringify(pages)};
`.replace(/\n +/, '\n');
- apiPagesContent = formatTypescript(apiPagesContent);
+ apiPagesContent = await formatTypescript(apiPagesContent);
writeFileSync(pathDocsApiPages, apiPagesContent);
}
@@ -217,7 +217,9 @@ export function writeApiSearchIndex(pages: ModuleSummary[]): void {
*
* @param project The typedoc project.
*/
-export function writeSourceBaseUrl(project: ProjectReflection): void {
+export async function writeSourceBaseUrl(
+ project: ProjectReflection
+): Promise<void> {
const baseUrl = extractSourceBaseUrl(
project.getChildrenByKind(ReflectionKind.Class)[0]
);
@@ -228,7 +230,7 @@ export function writeSourceBaseUrl(project: ProjectReflection): void {
export const sourceBaseUrl = '${baseUrl}';
`.replace(/\n +/, '\n');
- content = formatTypescript(content);
+ content = await formatTypescript(content);
writeFileSync(resolve(pathOutputDir, 'source-base-url.ts'), content);
}