Class: Firecrawl::Models::MapOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/firecrawl/models/map_options.rb

Overview

Options for mapping (discovering URLs on) a website.

Constant Summary collapse

FIELDS = 
%i[
  search sitemap include_subdomains ignore_query_parameters
  limit timeout integration location
].freeze

Instance Method Summary collapse

Constructor Details

#initialize(**kwargs) ⇒ MapOptions

Returns a new instance of MapOptions.



14
15
16
 
# File 'lib/firecrawl/models/map_options.rb', line 14

def initialize(**kwargs)
  FIELDS.each { |f| instance_variable_set(:"@#{f}", kwargs[f]) }
end

Instance Method Details

#to_h ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/firecrawl/models/map_options.rb', line 18

def to_h
  {
    "search" => search,
    "sitemap" => sitemap,
    "includeSubdomains" => include_subdomains,
    "ignoreQueryParameters" => ignore_query_parameters,
    "limit" => limit,
    "timeout" => timeout,
    "integration" => integration,
    "location" => location.is_a?(Hash) ? location : location&.to_h,
  }.compact
end