From 1f559ce51df5f9f5b4d9abb89d9b1ae28cbf27a5 Mon Sep 17 00:00:00 2001 From: divdavem Date: Tue, 9 Jan 2024 09:56:04 +0100 Subject: [PATCH] Treat validation warnings as errors in typedoc (#125) --- src/index.ts | 8 ++++---- typedoc.json | 2 ++ 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/src/index.ts b/src/index.ts index 87f53aa..d4fb7a1 100644 --- a/src/index.ts +++ b/src/index.ts @@ -949,15 +949,15 @@ export type StoresInputValues = S extends StoreInput ? T : { [K in keyof S]: S[K] extends StoreInput ? T : never }; -type SyncDeriveFn = (values: StoresInputValues) => T; -interface SyncDeriveOptions extends Omit, 'onUse'> { +export type SyncDeriveFn = (values: StoresInputValues) => T; +export interface SyncDeriveOptions extends Omit, 'onUse'> { derive: SyncDeriveFn; } -type AsyncDeriveFn = ( +export type AsyncDeriveFn = ( values: StoresInputValues, set: OnUseArgument ) => Unsubscriber | void; -interface AsyncDeriveOptions extends Omit, 'onUse'> { +export interface AsyncDeriveOptions extends Omit, 'onUse'> { derive: AsyncDeriveFn; } type DeriveFn = SyncDeriveFn | AsyncDeriveFn; diff --git a/typedoc.json b/typedoc.json index af6781e..2d3afb1 100644 --- a/typedoc.json +++ b/typedoc.json @@ -4,6 +4,8 @@ "excludePrivate": true, "kindSortOrder": ["Function", "Class"], "out": "./dist/docs", + "treatValidationWarningsAsErrors": true, + "intentionallyNotExported": ["__global.SymbolConstructor.observable"], "tsconfig": "./tsconfig.d.json", "visibilityFilters": {} }