fix(docs-gen): drop non default overloads from docs (#1138)

Author: lukasIO

.changeset/tame-turkeys-joke.md

@@ -0,0 +1,5 @@
+---
+"@livekit/api-documenter": patch
+---
+
+fix(docs-gen): drop non default overloads from docs

tooling/api-documenter/src/documenters/MarkdownDocumenter.ts

@@ -72,6 +72,7 @@ import {
   getCategorySubfolder,
   getFunctionType,
   getLinkToSourceOnGitHub,
+  isNonDefaultOverload,
 } from '../livekitUtils/classifiers';
 import { MarkDocTag } from '../nodes/MarkDocTag';
 import { ParameterList } from '../nodes/ParameterList';
@@ -137,6 +138,11 @@ export class MarkdownDocumenter {
     const output: DocSection = new DocSection({ configuration });
     const category: LkType = getFunctionType(apiItem);
 
+    if (isNonDefaultOverload(apiItem)) {
+      console.log('isNonDefaultOverload', apiItem.displayName);
+      return;
+    }
+
     // this._writeBreadcrumb(output, apiItem);
 
     const scopedName: string = apiItem.getScopedNameWithinPackage();

tooling/api-documenter/src/livekitUtils/classifiers.ts

@@ -19,6 +19,13 @@ function isPrefab(apiItem: ApiItem): boolean {
   return false;
 }
 
+export function isNonDefaultOverload(apiItem: ApiItem): boolean {
+  if (apiItem instanceof ApiFunction) {
+    return apiItem.overloadIndex !== undefined && apiItem.overloadIndex > 1;
+  }
+  return false;
+}
+
 function isConstDeclarationComponent(apiItem: ApiItem): boolean {
   return (
     apiItem instanceof ApiVariable &&