Packages

indieweb

0.0.35
0.0.66 0.0.65 0.0.64 0.0.63 0.0.62 0.0.61 0.0.60 0.0.59 0.0.58 0.0.56 0.0.55 0.0.54 0.0.53 0.0.51 0.0.50 0.0.49 0.0.48 0.0.47 0.0.46 0.0.42 0.0.41 0.0.40 0.0.39 0.0.38 0.0.37 0.0.36 0.0.35 0.0.34 0.0.33 0.0.32 0.0.31 0.0.30 0.0.29 0.0.28 0.0.27 0.0.26 0.0.25 0.0.24 0.0.23 0.0.22 0.0.21 0.0.20 0.0.19 0.0.17 0.0.16 0.0.15 0.0.14 0.0.13 0.0.12 0.0.10 0.0.9 0.0.8 0.0.7 0.0.6 0.0.5 0.0.3 0.0.2 0.0.1

Collection of common IndieWeb utilites like authorship resolution, Webmention, post type discovery and IndieAuth.

HexDocs

Current section

Files

Jump to
Readme
58 Versions
2 Dependencies
Dependants
Files
Activity
indieweb priv dist doc IndieWeb.Http.html
Raw

priv/dist/doc/IndieWeb.Http.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.19.3">

    <title>IndieWeb.Http — IndieWeb v0.0.31</title>

    <link rel="stylesheet" href="dist/html-399e30b9b028e3059575.css" />

      <link rel="canonical" href="https://hexdocs.pm/indieweb/IndieWeb.Http.html" />

    <script src="dist/sidebar_items-23b3c70799.js"></script>

    <script async src="dist/html-399e30b9b028e3059575.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" aria-hidden="true"></span>

  <span class="sr-only">Toggle Sidebar</span>

</button>

<button class="sidebar-button night-mode-toggle">

  <span class="icon-theme" aria-hidden="true"></span>

  <span class="sr-only">Toggle Theme</span>

</button>

<section class="sidebar">



  <a href="https://indieweb.org/" class="sidebar-projectLink">

    <div class="sidebar-projectDetails">

      <h1 class="sidebar-projectName">

IndieWeb      </h1>

      <h2 class="sidebar-projectVersion">

        v0.0.31

      </h2>

    </div>

      <img src="assets/logo.png" alt="IndieWeb" class="sidebar-projectImage">

  </a>



  <form class="sidebar-search" action="search.html">

    <button type="submit" class="search-button">

      <span class="icon-search" aria-hidden="true"></span>

    </button>

    <input name="q" type="text" id="search-list" class="search-input" placeholder="Search" aria-label="Search" autocomplete="off" />

  </form>



  <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="visible-xs">IndieWeb v0.0.31</small>

IndieWeb.Http        

          <a href="https://git.jacky.wtf/indieweb/elixir" 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>Provides a facade for handling HTTP actions.</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-functions summary">

    <h2>

      <a href="#functions">Functions</a>

    </h2>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#adapter/0">adapter()</a>

  </div>

    <div class="summary-synopsis"><p>Obtains an implementation of a <a href="IndieWeb.Http.Adapter.html"><code class="inline">IndieWeb.Http.Adapter</code></a> module</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#delete/2">delete(uri, opts \\ [])</a>

  </div>

    <div class="summary-synopsis"><p>Sends a DELETE request to the specified URI</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#extract_link_header_values/1">extract_link_header_values(headers)</a>

  </div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#get/2">get(uri, opts \\ [])</a>

  </div>

    <div class="summary-synopsis"><p>Sends a GET request to the specified URI</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#head/2">head(uri, opts \\ [])</a>

  </div>

    <div class="summary-synopsis"><p>Sends a HEAD request to the specified URI</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#make_absolute_uri/2">make_absolute_uri(path, base_uri)</a>

  </div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#options/2">options(uri, opts \\ [])</a>

  </div>

    <div class="summary-synopsis"><p>Sends a OPTIONS request to the specified URI</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#patch/2">patch(uri, opts \\ [])</a>

  </div>

    <div class="summary-synopsis"><p>Sends a PATCH request to the specified URI</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#post/2">post(uri, opts \\ [])</a>

  </div>

    <div class="summary-synopsis"><p>Sends a POST request to the specified URI</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#put/2">put(uri, opts \\ [])</a>

  </div>

    <div class="summary-synopsis"><p>Sends a PUT request to the specified URI</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#request/3">request(uri, method \\ :get, opts \\ [])</a>

  </div>

    <div class="summary-synopsis"><p>Sends a HTTP request to the URI <code class="inline">uri</code> with the provided options</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#timeout/0">timeout()</a>

  </div>

</div>

  </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="adapter/0">

    <div class="detail-header">

    <a href="#adapter/0" 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">adapter()</span>

      <a href="https://git.jacky.wtf/indieweb/elixir" 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>adapter() :: IndieWeb.HTTP.Adapter.t()</pre>

      </div>

  </div>

  <section class="docstring">

<p>Obtains an implementation of a <a href="IndieWeb.Http.Adapter.html"><code class="inline">IndieWeb.Http.Adapter</code></a> module.</p>

  </section>

</section>

<section class="detail" id="delete/2">

  

    <span id="delete/1"></span>

  <div class="detail-header">

    <a href="#delete/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">delete(uri, opts \\ [])</span>

      <a href="https://git.jacky.wtf/indieweb/elixir" 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>

  <section class="docstring">

<p>Sends a DELETE request to the specified URI.</p>

<p>See <a href="#request/3"><code class="inline">request/3</code></a> for more information about making requests.</p>

  </section>

</section>

<section class="detail" id="extract_link_header_values/1">

    <div class="detail-header">

    <a href="#extract_link_header_values/1" 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">extract_link_header_values(headers)</span>

      <a href="https://git.jacky.wtf/indieweb/elixir" 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>

  <section class="docstring">

  </section>

</section>

<section class="detail" id="get/2">

  

    <span id="get/1"></span>

  <div class="detail-header">

    <a href="#get/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">get(uri, opts \\ [])</span>

      <a href="https://git.jacky.wtf/indieweb/elixir" 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>

  <section class="docstring">

<p>Sends a GET request to the specified URI.</p>

<p>See <a href="#request/3"><code class="inline">request/3</code></a> for more information about making requests.</p>

  </section>

</section>

<section class="detail" id="head/2">

  

    <span id="head/1"></span>

  <div class="detail-header">

    <a href="#head/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">head(uri, opts \\ [])</span>

      <a href="https://git.jacky.wtf/indieweb/elixir" 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>

  <section class="docstring">

<p>Sends a HEAD request to the specified URI.</p>

<p>See <a href="#request/3"><code class="inline">request/3</code></a> for more information about making requests.</p>

  </section>

</section>

<section class="detail" id="make_absolute_uri/2">

    <div class="detail-header">

    <a href="#make_absolute_uri/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">make_absolute_uri(path, base_uri)</span>

      <a href="https://git.jacky.wtf/indieweb/elixir" 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>

  <section class="docstring">

  </section>

</section>

<section class="detail" id="options/2">

  

    <span id="options/1"></span>

  <div class="detail-header">

    <a href="#options/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">options(uri, opts \\ [])</span>

      <a href="https://git.jacky.wtf/indieweb/elixir" 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>

  <section class="docstring">

<p>Sends a OPTIONS request to the specified URI.</p>

<p>See <a href="#request/3"><code class="inline">request/3</code></a> for more information about making requests.</p>

  </section>

</section>

<section class="detail" id="patch/2">

  

    <span id="patch/1"></span>

  <div class="detail-header">

    <a href="#patch/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">patch(uri, opts \\ [])</span>

      <a href="https://git.jacky.wtf/indieweb/elixir" 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>

  <section class="docstring">

<p>Sends a PATCH request to the specified URI.</p>

<p>See <a href="#request/3"><code class="inline">request/3</code></a> for more information about making requests.</p>

  </section>

</section>

<section class="detail" id="post/2">

  

    <span id="post/1"></span>

  <div class="detail-header">

    <a href="#post/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">post(uri, opts \\ [])</span>

      <a href="https://git.jacky.wtf/indieweb/elixir" 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>

  <section class="docstring">

<p>Sends a POST request to the specified URI.</p>

<p>See <a href="#request/3"><code class="inline">request/3</code></a> for more information about making requests.</p>

  </section>

</section>

<section class="detail" id="put/2">

  

    <span id="put/1"></span>

  <div class="detail-header">

    <a href="#put/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">put(uri, opts \\ [])</span>

      <a href="https://git.jacky.wtf/indieweb/elixir" 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>

  <section class="docstring">

<p>Sends a PUT request to the specified URI.</p>

<p>See <a href="#request/3"><code class="inline">request/3</code></a> for more information about making requests.</p>

  </section>

</section>

<section class="detail" id="request/3">

  

    <span id="request/1"></span>



    <span id="request/2"></span>

  <div class="detail-header">

    <a href="#request/3" 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">request(uri, method \\ :get, opts \\ [])</span>

      <a href="https://git.jacky.wtf/indieweb/elixir" 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>request(<a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">keyword</a>()) ::

  {:ok, <a href="IndieWeb.Http.Response.html#t:t/0">IndieWeb.Http.Response.t</a>()} | {:error, <a href="IndieWeb.Http.Error.html#t:t/0">IndieWeb.Http.Error.t</a>()}</pre>

      </div>

  </div>

  <section class="docstring">

<p>Sends a HTTP request to the URI <code class="inline">uri</code> with the provided options.</p>

  </section>

</section>

<section class="detail" id="timeout/0">

    <div class="detail-header">

    <a href="#timeout/0" 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">timeout()</span>

      <a href="https://git.jacky.wtf/indieweb/elixir" 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>

  <section class="docstring">

  </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.19.3),

          </span>

          <span class="line">

            designed by

            <a href="https://twitter.com/dignifiedquire" target="_blank" rel="noopener" title="@dignifiedquire">Friedel Ziegelmayer</a>.

            </span>

        </p>

      </footer>

    </div>

  </div>

</section>

</div>

  

  </body>

</html>