API Reference

The HTML library provides the following core components:

Component	Description	Documentation
Package Functions	Convenience functions for one-time calls	Functions
Processor	Processor instance for reusing resources and cache	Processor
Config	Configuration struct and presets	Config
Output Formats	Markdown, JSON output	Output Formats
Link Extraction	Standalone link extraction API	Link Extraction
Batch Processing	Concurrent batch extraction	Batch Processing
Interfaces	Extractor, StatsProvider, etc.	Interfaces
Types	Result, ImageInfo, etc.	Types
Constants & Errors	Defaults, sentinel errors	Constants & Errors
Audit System	Audit pipeline and Sinks	Audit System

API Overview

Two Calling Modes

┌─────────────────────────────────────────┐
│         Package Functions (Convenience)  │
│  html.Extract(data) → *Result, error    │
│  Uses sync.Pool internally              │
└─────────────────────────────────────────┘

┌─────────────────────────────────────────┐
│         Processor (Instance Mode)        │
│  p, _ := html.New(cfg)                  │
│  defer p.Close()                        │
│  result, err := p.Extract(data)         │
│  ✓ Cache reuse  ✓ Statistics  ✓ Audit   │
└─────────────────────────────────────────┘

Function Naming Convention

Pattern	Naming	Example
Basic	Extract*	Extract, ExtractText
From file	Extract*FromFile	ExtractFromFile
With context	Extract*WithContext	ExtractWithContext
From file + context	Extract*FromFileWithContext	ExtractFromFileWithContext

Module Information

• Module path: github.com/cybergodev/html
• Go version: 1.25+
• Dependencies: golang.org/x/net, golang.org/x/text