---
sidebar_label: "Обзор"
title: "Справочник API - CyberGo html | функции и типы"
description: "Полный индекс API CyberGo html: функции пакета и Processor — извлечение, форматы вывода, ссылки, пакетная обработка, конфигурация, аудит и типы."
sidebar_position: 1
---

# Справочник API

Библиотека HTML предоставляет следующие ключевые компоненты:

| Компонент | Описание | Документация |
|------|------|------|
| Функции пакета | Удобные функции для однократных вызовов | [Функции пакета](./core/functions) |
| Processor | Экземпляр процессора с повторным использованием ресурсов и кэша | [Processor](./core/processor) |
| Config | Структура конфигурации и предустановки | [Конфигурация](./core/config) |
| Форматы вывода | Вывод в Markdown, JSON | [Форматы вывода](./modules/output) |
| Извлечение ссылок | Независимый API извлечения ссылок | [Извлечение ссылок](./modules/links) |
| Пакетная обработка | Параллельное пакетное извлечение | [Пакетная обработка](./modules/batch) |
| Интерфейсы | Extractor, StatsProvider и др. | [Определение интерфейсов](./types/interfaces) |
| Типы | Result, ImageInfo и др. | [Определения типов](./types/type-defs) |
| Константы и ошибки | Значения по умолчанию, сигнатурные ошибки | [Константы и ошибки](./types/constants) |
| Система аудита | Конвейер аудита и Sink | [Система аудита](./modules/audit) |

## Обзор API

### Два режима вызова

```text
┌─────────────────────────────────────────┐
│      Функции пакета (удобный режим)       │
│  html.Extract(data) → *Result, error    │
│  Внутренне используют sync.Pool          │
│  для повторного использования Processor  │
└─────────────────────────────────────────┘

┌─────────────────────────────────────────┐
│       Processor (режим экземпляра)        │
│  p, _ := html.New(cfg)                  │
│  defer p.Close()                        │
│  result, err := p.Extract(data)         │
│  ✓ Повторное использование кэша          │
│  ✓ Сбор статистики  ✓ Журнал аудита      │
└─────────────────────────────────────────┘
```

### Правила именования функций

| Паттерн | Именование | Пример |
|------|------|------|
| Базовый | `Extract*` | `Extract`, `ExtractText` |
| Из файла | `Extract*FromFile` | `ExtractFromFile` |
| С контекстом | `Extract*WithContext` | `ExtractWithContext` |
| Из файла + контекст | `Extract*FromFileWithContext` | `ExtractFromFileWithContext` |

### Информация о модуле

- **Путь к модулю**: `github.com/cybergodev/html`
- **Версия Go**: 1.25+
- **Зависимости**: `golang.org/x/net`, `golang.org/x/text`