Treat validation warnings as errors in typedoc (#125)

AmadeusITGroup · Jan 9, 2024 · 1f559ce · 1f559ce
1 parent d13f7f8
commit 1f559ce
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -949,15 +949,15 @@ export type StoresInputValues<S> = S extends StoreInput<infer T>
   ? T
   : { [K in keyof S]: S[K] extends StoreInput<infer T> ? T : never };
 
-type SyncDeriveFn<T, S> = (values: StoresInputValues<S>) => T;
-interface SyncDeriveOptions<T, S> extends Omit<StoreOptions<T>, 'onUse'> {
+export type SyncDeriveFn<T, S> = (values: StoresInputValues<S>) => T;
+export interface SyncDeriveOptions<T, S> extends Omit<StoreOptions<T>, 'onUse'> {
   derive: SyncDeriveFn<T, S>;
 }
-type AsyncDeriveFn<T, S> = (
+export type AsyncDeriveFn<T, S> = (
   values: StoresInputValues<S>,
   set: OnUseArgument<T>
 ) => Unsubscriber | void;
-interface AsyncDeriveOptions<T, S> extends Omit<StoreOptions<T>, 'onUse'> {
+export interface AsyncDeriveOptions<T, S> extends Omit<StoreOptions<T>, 'onUse'> {
   derive: AsyncDeriveFn<T, S>;
 }
 type DeriveFn<T, S> = SyncDeriveFn<T, S> | AsyncDeriveFn<T, S>;

diff --git 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": {}
 }