Skip to content

Commit b7dcec4

Browse files
committed
docs: add JSDoc to LLMProviderPreset interface and provider presets constant
1 parent 141c6e0 commit b7dcec4

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

src/services/llm.providers.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,30 @@
11
import type { LLMProvider } from '../types/index.js';
22

3+
/**
4+
* Describes a known LLM provider with its default base URL,
5+
* supported model list, and optional configuration flags.
6+
*
7+
* Used by the interactive setup wizard and the `doctor` command
8+
* to present provider choices and validate connection settings.
9+
*/
310
export interface LLMProviderPreset {
11+
/** Human-readable provider name shown in the UI. */
412
name: string;
13+
/** Internal identifier matching the {@link LLMProvider} union type. */
514
value: LLMProvider;
15+
/** Default API base URL for this provider. */
616
baseUrl: string;
17+
/** Known model identifiers with display names. */
718
models: Array<{ name: string; value: string }>;
19+
/** Whether the user may specify a custom model name. */
820
allowCustomModel?: boolean;
21+
/** Whether the user may override the base URL. */
922
allowCustomBaseUrl?: boolean;
23+
/** Extra headers required by this provider (e.g. custom auth schemes). */
1024
apiHeaders?: Record<string, string>;
1125
}
1226

27+
/** Built-in LLM provider presets with default endpoints and model lists. */
1328
export const LLM_PROVIDER_PRESETS: LLMProviderPreset[] = [
1429
{
1530
name: 'OpenAI',

0 commit comments

Comments
 (0)