From 0e01c5d9eeb27ae00db5760961c9e50906aa197d Mon Sep 17 00:00:00 2001 From: Matt Lyons Date: Mon, 5 Feb 2024 12:25:13 -0600 Subject: [PATCH] Fix typedoc build problems (#751) --- lib/platform-bible-utils/package.json | 2 +- lib/platform-bible-utils/src/document-combiner-engine.ts | 4 +--- lib/platform-bible-utils/src/index.ts | 2 +- lib/platform-bible-utils/src/serialization.ts | 2 +- 4 files changed, 4 insertions(+), 6 deletions(-) diff --git a/lib/platform-bible-utils/package.json b/lib/platform-bible-utils/package.json index ba742bc71c..24de104028 100644 --- a/lib/platform-bible-utils/package.json +++ b/lib/platform-bible-utils/package.json @@ -31,7 +31,7 @@ "scripts": { "start": "vite --host --open", "build:basic": "tsc && vite build && dts-bundle-generator --config ./dts-bundle-generator.config.ts", - "build:docs": "typedoc", + "build:docs": "npm install && typedoc", "build": "npm run build:basic && npm run lint-fix", "watch": "tsc && vite build --watch", "lint": "npm run lint:scripts", diff --git a/lib/platform-bible-utils/src/document-combiner-engine.ts b/lib/platform-bible-utils/src/document-combiner-engine.ts index c7c90a1b75..28bdc6b228 100644 --- a/lib/platform-bible-utils/src/document-combiner-engine.ts +++ b/lib/platform-bible-utils/src/document-combiner-engine.ts @@ -31,9 +31,7 @@ export default abstract class DocumentCombinerEngine { * Create a DocumentCombinerEngine instance * * @param baseDocument This is the first document that will be used when composing the output - * @param copyDocuments If true, this instance will perform a deep copy of all provided documents - * before composing the output. If false, then changes made to provided documents after they are - * contributed will be reflected in the next time output is composed. + * @param options Options used by this object when combining documents */ protected constructor(baseDocument: JsonDocumentLike, options: DocumentCombinerOptions) { // Setting baseDocument redundantly because TS doesn't understand that updateBaseDocument does it diff --git a/lib/platform-bible-utils/src/index.ts b/lib/platform-bible-utils/src/index.ts index 9c4fbfdf2e..41788a80c6 100644 --- a/lib/platform-bible-utils/src/index.ts +++ b/lib/platform-bible-utils/src/index.ts @@ -42,7 +42,7 @@ export type { export type { PlatformEventHandler, PlatformEvent, PlatformEventAsync } from './platform-event'; export type { ScriptureReference, BookInfo } from './scripture.model'; export type { Unsubscriber, UnsubscriberAsync } from './unsubscriber'; -export type { JsonDocumentLike } from './document-combiner-engine'; +export type { DocumentCombinerOptions, JsonDocumentLike } from './document-combiner-engine'; export type { LocalizeKey, ReferencedItem, diff --git a/lib/platform-bible-utils/src/serialization.ts b/lib/platform-bible-utils/src/serialization.ts index 14264626f0..8d7fb7699b 100644 --- a/lib/platform-bible-utils/src/serialization.ts +++ b/lib/platform-bible-utils/src/serialization.ts @@ -41,7 +41,7 @@ export function serialize( * values, you should wrap them yourself in a string before using this function. Alternatively, you * can write your own replacer that will preserve `null` in a way that you can recover later. * - * @param text A valid JSON string. + * @param value A valid JSON string. * @param reviver A function that transforms the results. This function is called for each member of * the object. If a member contains nested objects, the nested objects are transformed before the * parent object is. Note that `null` values are converted into `undefined` values after the