Exoplanet.Config (Exoplanet v0.2.0)

View Source

Exoplanet configuration

In this section we expect the following attributees:

  • name - your planet's name
  • link - link to the main page
  • owner_name - your name
  • owner_email - your e-mail address
  • about - information about your Planet
  • feed_timeout - time in seconds the request to any given feed should timeout
  • related_sites - map of links to related sites, like other Planets or Feed Aggregators

Summary

Functions

Creates Exoplanet.Config from the given file

Types

t()

@type t() :: %Exoplanet.Config{
  about: String.t(),
  activity_threshold: term(),
  cache_directory: term(),
  feed_timeout: pos_integer(),
  items: term(),
  link: String.t(),
  log_level: term(),
  name: String.t(),
  new_feed_items: pos_integer(),
  output_dir: term(),
  output_theme: term(),
  owner_email: String.t(),
  owner_name: String.t(),
  related_sites: map(),
  sources: map()
}

Functions

from_file(path)

@spec from_file(Path.t()) :: t()

Creates Exoplanet.Config from the given file