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.Cache.Adapter.html
Raw

priv/dist/doc/IndieWeb.Cache.Adapter.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.Cache.Adapter — IndieWeb v0.0.31</title>

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

      <link rel="canonical" href="https://hexdocs.pm/indieweb/IndieWeb.Cache.Adapter.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.Cache.Adapter <small>behaviour</small>        

          <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>This provides the interface that adapters should implement if they&#39;d like

IndieWeb to use it for caching values. Check <a href="IndieWeb.html"><code class="inline">IndieWeb</code></a> for more information

and <a href="IndieWeb.Cache.Adapters.Cachex.html"><code class="inline">IndieWeb.Cache.Adapters.Cachex</code></a> for more information.</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-callbacks summary">

    <h2>

      <a href="#callbacks">Callbacks</a>

    </h2>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#c:delete/1">delete(key)</a>

  </div>

    <div class="summary-synopsis"><p>Defines the method of deleting a cached value</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#c:get/1">get(key)</a>

  </div>

    <div class="summary-synopsis"><p>Defines the method for obtaining a cached value</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#c:set/3">set(key, value, options)</a>

  </div>

    <div class="summary-synopsis"><p>Defines the method of setting of a cached value</p>

</div>

</div>

  </div>

        </section>



        <section id="callbacks" class="details-list">

          <h1 class="section-heading">

            <a class="hover-link" href="#callbacks">

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

              <span class="sr-only">Link to this section</span>

            </a>

Callbacks          </h1>

          <div class="callbacks-list">

<section class="detail" id="c:delete/1">

    <div class="detail-header">

    <a href="#c:delete/1" class="detail-link" title="Link to this callback">

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

      <span class="sr-only">Link to this callback</span>

    </a>

    <h1 class="signature">delete(key)</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>delete(key :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>()) :: :ok | :error</pre>

      </div>

  </div>

  <section class="docstring">

<p>Defines the method of deleting a cached value.</p>

  </section>

</section>

<section class="detail" id="c:get/1">

    <div class="detail-header">

    <a href="#c:get/1" class="detail-link" title="Link to this callback">

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

      <span class="sr-only">Link to this callback</span>

    </a>

    <h1 class="signature">get(key)</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>get(key :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>()) :: {:ok, <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()} | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()}</pre>

      </div>

  </div>

  <section class="docstring">

<p>Defines the method for obtaining a cached value.</p>

  </section>

</section>

<section class="detail" id="c:set/3">

    <div class="detail-header">

    <a href="#c:set/3" class="detail-link" title="Link to this callback">

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

      <span class="sr-only">Link to this callback</span>

    </a>

    <h1 class="signature">set(key, value, options)</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>set(key :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(), value :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>(), options :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">keyword</a>()) :: :ok | :error</pre>

      </div>

  </div>

  <section class="docstring">

<p>Defines the method of setting of a cached value.</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.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>