Class URLMetadataExtractorAction

Action that extracts comprehensive metadata from web pages including OpenGraph, Twitter Cards, Schema.org structured data, and standard HTML meta tags

Example

// Extract all metadata from a webpage
await runAction({
  ActionName: 'URL Metadata Extractor',
  Params: [{
    Name: 'URL',
    Value: 'https://example.com/article'
  }]
});

// Extract specific metadata types
await runAction({
  ActionName: 'URL Metadata Extractor',
  Params: [{
    Name: 'URL',
    Value: 'https://news.site.com/story'
  }, {
    Name: 'IncludeOpenGraph',
    Value: true
  }, {
    Name: 'IncludeSchemaOrg',
    Value: false
  }]
});

Hierarchy (view full)

Constructors

constructor

Properties

MAX_CONTENT_SIZE TIMEOUT

Methods

InternalRunAction Run cleanText extractAllMetadata extractBasicMetadata extractFaviconMetadata extractImages extractLanguage extractLinks extractOpenGraphMetadata extractSchemaOrgMetadata extractTwitterCardMetadata extractViewport resolveUrl

Constructors

constructor

Properties

Private Readonly MAX_CONTENT_SIZE

MAX_CONTENT_SIZE: number = ...

Private Readonly TIMEOUT

TIMEOUT: 10000 = 10000

Methods

Protected InternalRunAction

  • InternalRunAction(params): Promise<ActionResultSimple>

  • Executes metadata extraction from the specified URL

    Parameters

    • params: RunActionParams<any>

      The action parameters containing:

      • URL: Web page URL to extract metadata from (required)
      • IncludeOpenGraph: Extract OpenGraph metadata (default: true)
      • IncludeTwitterCards: Extract Twitter Card metadata (default: true)
      • IncludeSchemaOrg: Extract Schema.org JSON-LD data (default: true)
      • IncludeBasicMeta: Extract standard HTML meta tags (default: true)
      • IncludeFavicon: Extract favicon information (default: true)

    Returns Promise<ActionResultSimple>

    Comprehensive metadata extracted from the webpage

Run

  • Run(params): Promise<ActionResultSimple>

  • Executes the action with the provided parameters.

    Parameters

    • params: RunActionParams<any>

      The action execution parameters including context

    Returns Promise<ActionResultSimple>

    Promise resolving to the action result

Private cleanText

Private extractAllMetadata

  • extractAllMetadata(html, baseUrl, includeOpenGraph, includeTwitterCards, includeSchemaOrg, includeBasicMeta, includeFavicon): Promise<any>

  • Extracts all types of metadata from HTML content

    Parameters

    • html: string
    • baseUrl: URL
    • includeOpenGraph: boolean
    • includeTwitterCards: boolean
    • includeSchemaOrg: boolean
    • includeBasicMeta: boolean
    • includeFavicon: boolean

    Returns Promise<any>

Private extractBasicMetadata

Private extractFaviconMetadata

Private extractImages

Private extractLanguage

Private extractLinks

Private extractOpenGraphMetadata

Private extractSchemaOrgMetadata

Private extractTwitterCardMetadata

Private extractViewport

Private resolveUrl

Settings

Member Visibility

Theme

On This Page

constructorMAX_CONTENT_SIZETIMEOUTInternalRunActionRuncleanTextextractAllMetadataextractBasicMetadataextractFaviconMetadataextractImagesextractLanguageextractLinksextractOpenGraphMetadataextractSchemaOrgMetadataextractTwitterCardMetadataextractViewportresolveUrl