API TypeScript — обзор

Справочник собирается автоматически из исходников npm-пакета @dagstack/config через TypeDoc + markdown-плагин.

:::info Генерация отложена В первой версии страницы ещё не сгенерированы. Запуск — make api-typescript (в Makefile добавится после интеграции TypeDoc-pipeline). Содержимое пополнится в следующих коммитах, после стабилизации реализации. :::

Состав справочника (план)

Модуль	Что содержит
@dagstack/config	Публичный верхний уровень — Config, load, loadFrom, методы доступа, ошибки.
@dagstack/config — sources	интерфейс ConfigSource, YamlFileSource, JsonFileSource, InMemorySource.
@dagstack/config — errors	ConfigError, ConfigErrorReason.

Как сгенерировать локально

cd config-typescript
git submodule update --init
npm install
npm run docs      # после интеграции TypeDoc-pipeline

Пока справочник не сгенерирован

• JSDoc из исходников виден в IDE (VSCode / WebStorm / Neovim с LSP).
• .d.ts типы доступны после npm install @dagstack/config.
• Страницы руководств: Объявить секцию, Тестирование.
• Спецификация: ADR-0001.