Function extractLinks

extractLinks(
    input: DocumentInput,
    baseUrl?: string | URL | null,
    options?: LinksExtractionOptions,
): LinksMetadata
Extract links from HTML.
Parameters
- input: DocumentInput
  Parsed HTML document or raw HTML string
- OptionalbaseUrl: string | URL | null
  Base URL for resolving relative links and determining internal/external
- options: LinksExtractionOptions = {}
  Extraction options for filtering and categorization
Returns LinksMetadata
Links metadata with categorized links
Remarks
Extracts all <a href> links with comprehensive metadata and filtering options. Perfect for crawlers, SEO analysis, and link discovery.

Features:
- Internal/external link categorization
- Rel attribute filtering (nofollow, ugc, sponsored, etc.)
- Automatic URL normalization
- Hash link filtering
- Scheme filtering (only http/https)
- Deduplication
- Link text extraction
Example
```
// With parsed document (recommended for multiple extractions)
const doc = parseHTML(htmlString);
const links = extractLinks(doc, 'https://example.com');

// Or directly with HTML string
const links = extractLinks(htmlString, 'https://example.com');

// Get all internal links (same origin)
console.log(links.internal);

// Get external links excluding nofollow
const linksNoFollow = extractLinks(htmlString, 'https://example.com', {
  scope: 'external',
  excludeRel: ['nofollow']
});
```
Example
```
// Crawler use case - get follow-able links
const links = extractLinks(html, baseUrl, {
  excludeRel: ['nofollow', 'ugc', 'sponsored'],
  includeHashLinks: false
});
```
- Defined in src/metadata/links/extract.ts:74

Function extractLinks

Parameters

Returns LinksMetadata

Remarks

Example

Example

Settings