Current section
Files
Jump to
Current section
Files
doc/Furlex.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.20.2">
<meta name="project" content="Furlex v0.4.2">
<title>Furlex — Furlex v0.4.2</title>
<link rel="stylesheet" href="dist/html-d9f58a6320b5bfa6dd77.css" />
<link rel="canonical" href="https://hexdocs.pm/furlex/Furlex.html" />
<script src="dist/sidebar_items-404aa78846.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-d9f58a6320b5bfa6dd77.js"></script>
</head>
<body data-type="modules">
<script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script>
<div class="main">
<button class="sidebar-button sidebar-toggle">
<span class="icon-menu" title="Collapse/expand sidebar"></span>
</button>
<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button">
<span class="icon-search" aria-hidden="true"></span>
</button>
<button type="button" tabindex="-1" class="search-close-button">
<span class="icon-cross" title="Cancel search"></span>
</button>
<label class="search-label">
<input name="q" type="text" id="search-list" class="search-input" placeholder="Search..." aria-label="Search" autocomplete="off" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<div class="sidebar-projectDetails">
<a href="Furlex.html" class="sidebar-projectName">
Furlex </a>
<h2 class="sidebar-projectVersion">
v0.4.2
</h2>
</div>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>
<li><a id="modules-list" href="#full-list">Modules</a></li>
</ul>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<small class="app-vsn">Furlex v0.4.2</small>
Furlex
<a href="https://github.com/claytongentry/furlex/blob/master/lib/furlex.ex#L1" title="View Source" class="view-source" rel="help">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</h1>
<section id="moduledoc">
<p>Furlex is a structured data extraction tool written in Elixir.</p>
<p>It currently supports unfurling oEmbed, Twitter Card, Facebook Open Graph,
JSON-LD and plain ole' HTML <code class="inline"><meta /></code> data out of any url you supply.</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Summary
</h1>
<div class="summary-types summary">
<h2>
<a href="#types">Types</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:t/0">t()</a>
</div>
</div>
</div>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#unfurl/2">unfurl(url, opts \\ [])</a>
</div>
<div class="summary-synopsis"><p>Unfurls a url</p></div>
</div>
</div>
</section>
<section id="types" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#types">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Types </h1>
<div class="types-list">
<section class="detail" id="t:t/0">
<div class="detail-header">
<a href="#t:t/0" class="detail-link" title="Link to this type">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature">t()</span>
<a href="https://github.com/claytongentry/furlex/blob/master/lib/furlex.ex#L18" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
<div class="specs">
<pre>t() :: %Furlex{
canonical_url: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>(),
facebook: <a href="https://hexdocs.pm/elixir/Map.html#t:t/0">Map.t</a>(),
json_ld: <a href="https://hexdocs.pm/elixir/List.html#t:t/0">List.t</a>(),
oembed: nil | <a href="https://hexdocs.pm/elixir/Map.html#t:t/0">Map.t</a>(),
other: <a href="https://hexdocs.pm/elixir/Map.html#t:t/0">Map.t</a>(),
status_code: <a href="https://hexdocs.pm/elixir/Integer.html#t:t/0">Integer.t</a>(),
twitter: <a href="https://hexdocs.pm/elixir/Map.html#t:t/0">Map.t</a>()
}</pre>
</div>
</div>
<section class="docstring">
</section>
</section>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Functions </h1>
<div class="functions-list">
<section class="detail" id="unfurl/2">
<span id="unfurl/1"></span>
<div class="detail-header">
<a href="#unfurl/2" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature">unfurl(url, opts \\ [])</span>
<a href="https://github.com/claytongentry/furlex/blob/master/lib/furlex.ex#L49" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
<div class="specs">
<pre>unfurl(<a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>(), <a href="https://hexdocs.pm/elixir/Keyword.html#t:t/0">Keyword.t</a>()) :: {:ok, <a href="Furlex.html#t:t/0">Furlex.t</a>()} | {:error, <a href="https://hexdocs.pm/elixir/Atom.html#t:t/0">Atom.t</a>()}</pre>
</div>
</div>
<section class="docstring">
<p>Unfurls a url</p>
<p>unfurl/1 fetches oembed data if applicable to the given url's host,
in addition to Twitter Card, Open Graph, JSON-LD and other HTML meta tags.</p>
<p>unfurl/2 also accepts a keyword list that will be passed to HTTPoison.</p>
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener">ExDoc</a> (v0.20.2),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" rel="noopener" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</p>
<p>
<button class="line footer-button night-mode-toggle">
Toggle night mode
</button>
<button class="line footer-button display-shortcuts-help">
Display keyboard shortcuts
</button>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>