OpenGraph (ogp v1.1.0)

Summary

Types

t()
url()
value()

Functions

fetch(url, req_options \\ [])

Fetch URL and parse Open Graph protocol.

fetch!(url, req_options \\ [])

Similar to fetch/2 but raises an OpenGraph.Error if request failed.

parse(html)

Parse Open Graph protocol.

Types

Link to this type

t()

@type t() :: %OpenGraph{
  audio: value(),
  description: value(),
  determiner: value(),
  image: value(),
  locale: value(),
  site_name: value(),
  title: value(),
  type: value(),
  url: value(),
  video: value()
}
Link to this type

url()

@type url() :: URI.t() | String.t()
Link to this type

value()

@type value() :: String.t() | nil

Functions

Link to this function

fetch(url, req_options \\ [])

@spec fetch(url(), req_options :: keyword()) ::
  {:ok, t()} | {:error, OpenGraph.Error.t()}

Fetch URL and parse Open Graph protocol.

Returns {:ok, %OpenGraph{}} for succussful request, otherwise, returns {:error, %OpenGraph.Error{}}.

Link to this function

fetch!(url, req_options \\ [])

@spec fetch!(url(), req_options :: keyword()) :: t()

Similar to fetch/2 but raises an OpenGraph.Error if request failed.

Returns %OpenGraph{}.

Link to this function

parse(html)

@spec parse(String.t()) :: t()

Parse Open Graph protocol.

Returns %OpenGraph{}.

Examples 

iex> OpenGraph.parse("<meta property='og:title' content='GitHub' />")
%OpenGraph{title: "GitHub"}