Released version 0.4.0

railsmechanic · Jul 13, 2018 · 21790de · 21790de
1 parent 3476d95
commit 21790de
Show file tree

Hide file tree

Showing 19 changed files with 165 additions and 97 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ To use Sidewalk you need to create a `%Sidewalk.Job{}` and enqueue it with one o
 
   ```elixir
   def deps do
-    [{:sidewalk, "~> 0.3.4"}]
+    [{:sidewalk, "~> 0.4.0"}]
   end
   ```
 

diff --git a/doc/.build b/doc/.build
@@ -1,10 +1,10 @@
-dist/app-5b9e160cec.css
-dist/app-da04b39d0c.js
+dist/app-480ffdc169.css
+dist/app-9bd040e5e5.js
 fonts/icomoon.eot
 fonts/icomoon.svg
 fonts/icomoon.ttf
 fonts/icomoon.woff
-dist/sidebar_items-0aadb755c3.js
+dist/sidebar_items-7c46a62e60.js
 api-reference.html
 search.html
 404.html

diff --git a/doc/404.html b/doc/404.html
@@ -4,24 +4,30 @@
     <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.16.4">
-    <title>404 – sidewalk v0.3.4</title>
+    <meta name="generator" content="ExDoc v0.18.3">
+    <title>404 – sidewalk v0.4.0</title>
     <link rel="stylesheet" href="dist/app-091c05798a.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/sidewalk/404.html" />
 
+    <script src="dist/sidebar_items-7c46a62e60.js"></script>
+
+
 
-    <script src="dist/sidebar_items-0aadb755c3.js"></script>
 
   </head>
   <body data-type="extras">
     <script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script>
 
 <div class="main">
-<button class="sidebar-toggle">
+<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">
 
 
@@ -31,7 +37,7 @@ <h1 class="sidebar-projectName">
         sidewalk
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.3.4
+        v0.4.0
       </h2>
     </div>
 
@@ -41,7 +47,7 @@ <h2 class="sidebar-projectVersion">
     <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" />
+    <input name="q" type="text" id="search-list" class="search-input" placeholder="Search" aria-label="Search" autocomplete="off" />
   </form>
 
   <ul class="sidebar-listNav">
@@ -54,8 +60,6 @@ <h2 class="sidebar-projectVersion">
 
 
 
-
-
   </ul>
   <div class="gradient"></div>
   <ul id="full-list" class="sidebar-fullList"></ul>
@@ -77,21 +81,23 @@ <h2>Page not found</h2>
         <p>
           <span class="line">
             Built using
-            <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.16.4),
+            <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.18.3),
           </span>
           <span class="line">
             designed by
             <a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.
             </span>
         </p>
-        <button class="night-mode-toggle"><span class="sr-only">Switch theme</span></button>
       </footer>
     </div>
   </div>
 </section>
 </div>
   <script src="dist/app-574613960f.js"></script>
 
+
+
+
   </body>
 </html>
 
diff --git a/doc/Sidewalk.Client.html b/doc/Sidewalk.Client.html
@@ -4,24 +4,30 @@
     <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.16.4">
-    <title>Sidewalk.Client – sidewalk v0.3.4</title>
+    <meta name="generator" content="ExDoc v0.18.3">
+    <title>Sidewalk.Client – sidewalk v0.4.0</title>
     <link rel="stylesheet" href="dist/app-091c05798a.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/sidewalk/Sidewalk.Client.html" />
 
+    <script src="dist/sidebar_items-7c46a62e60.js"></script>
+
+
 
-    <script src="dist/sidebar_items-0aadb755c3.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-toggle">
+<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">
 
 
@@ -31,7 +37,7 @@ <h1 class="sidebar-projectName">
         sidewalk
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.3.4
+        v0.4.0
       </h2>
     </div>
 
@@ -41,7 +47,7 @@ <h2 class="sidebar-projectVersion">
     <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" />
+    <input name="q" type="text" id="search-list" class="search-input" placeholder="Search" aria-label="Search" autocomplete="off" />
   </form>
 
   <ul class="sidebar-listNav">
@@ -54,8 +60,6 @@ <h2 class="sidebar-projectVersion">
 
 
 
-
-
   </ul>
   <div class="gradient"></div>
   <ul id="full-list" class="sidebar-fullList"></ul>
@@ -67,7 +71,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">sidewalk v0.3.4</small>
+        <small class="visible-xs">sidewalk v0.4.0</small>
         Sidewalk.Client
 
       </h1>
@@ -196,7 +200,7 @@ <h1 class="section-heading">
 
       <div class="specs">
 
-          <pre>enqueue_delay() :: integer</pre>
+          <pre>enqueue_delay() :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">integer</a>()</pre>
 
       </div>
 
@@ -219,7 +223,7 @@ <h1 class="section-heading">
 
       <div class="specs">
 
-          <pre>enqueue_time() :: float</pre>
+          <pre>enqueue_time() :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">float</a>()</pre>
 
       </div>
 
@@ -242,7 +246,7 @@ <h1 class="section-heading">
 
       <div class="specs">
 
-          <pre>job() :: <a href="Sidewalk.Job.html#t:t/0">Sidewalk.Job.t</a></pre>
+          <pre>job() :: <a href="Sidewalk.Job.html#t:t/0">Sidewalk.Job.t</a>()</pre>
 
       </div>
 
@@ -265,7 +269,7 @@ <h1 class="section-heading">
 
       <div class="specs">
 
-          <pre>response() :: {:ok, <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>} | {:error, <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>}</pre>
+          <pre>response() :: {:ok, <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()} | {:error, <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()}</pre>
 
       </div>
 
@@ -302,7 +306,7 @@ <h1 class="section-heading">
 
       <div class="specs">
 
-          <pre>enqueue(<a href="#t:job/0">job</a>) :: <a href="#t:response/0">response</a></pre>
+          <pre>enqueue(<a href="#t:job/0">job</a>()) :: <a href="#t:response/0">response</a>()</pre>
 
       </div>
 
@@ -336,7 +340,7 @@ <h2 id="enqueue/1-example" class="section-heading">
 
       <div class="specs">
 
-          <pre>enqueue_at(<a href="#t:job/0">job</a>, <a href="#t:enqueue_time/0">enqueue_time</a>) :: <a href="#t:response/0">response</a></pre>
+          <pre>enqueue_at(<a href="#t:job/0">job</a>(), <a href="#t:enqueue_time/0">enqueue_time</a>()) :: <a href="#t:response/0">response</a>()</pre>
 
       </div>
 
@@ -370,7 +374,7 @@ <h2 id="enqueue_at/2-example" class="section-heading">
 
       <div class="specs">
 
-          <pre>enqueue_in(<a href="#t:job/0">job</a>, <a href="#t:enqueue_delay/0">enqueue_delay</a>) :: <a href="#t:response/0">response</a></pre>
+          <pre>enqueue_in(<a href="#t:job/0">job</a>(), <a href="#t:enqueue_delay/0">enqueue_delay</a>()) :: <a href="#t:response/0">response</a>()</pre>
 
       </div>
 
@@ -397,21 +401,23 @@ <h2 id="enqueue_in/2-example" class="section-heading">
         <p>
           <span class="line">
             Built using
-            <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.16.4),
+            <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.18.3),
           </span>
           <span class="line">
             designed by
             <a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.
             </span>
         </p>
-        <button class="night-mode-toggle"><span class="sr-only">Switch theme</span></button>
       </footer>
     </div>
   </div>
 </section>
 </div>
   <script src="dist/app-574613960f.js"></script>
 
+
+
+
   </body>
 </html>
 
diff --git a/doc/Sidewalk.Job.html b/doc/Sidewalk.Job.html
@@ -4,24 +4,30 @@
     <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.16.4">
-    <title>Sidewalk.Job – sidewalk v0.3.4</title>
+    <meta name="generator" content="ExDoc v0.18.3">
+    <title>Sidewalk.Job – sidewalk v0.4.0</title>
     <link rel="stylesheet" href="dist/app-091c05798a.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/sidewalk/Sidewalk.Job.html" />
 
+    <script src="dist/sidebar_items-7c46a62e60.js"></script>
+
+
 
-    <script src="dist/sidebar_items-0aadb755c3.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-toggle">
+<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">
 
 
@@ -31,7 +37,7 @@ <h1 class="sidebar-projectName">
         sidewalk
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.3.4
+        v0.4.0
       </h2>
     </div>
 
@@ -41,7 +47,7 @@ <h2 class="sidebar-projectVersion">
     <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" />
+    <input name="q" type="text" id="search-list" class="search-input" placeholder="Search" aria-label="Search" autocomplete="off" />
   </form>
 
   <ul class="sidebar-listNav">
@@ -54,8 +60,6 @@ <h2 class="sidebar-projectVersion">
 
 
 
-
-
   </ul>
   <div class="gradient"></div>
   <ul id="full-list" class="sidebar-fullList"></ul>
@@ -67,7 +71,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">sidewalk v0.3.4</small>
+        <small class="visible-xs">sidewalk v0.4.0</small>
         Sidewalk.Job
 
       </h1>
@@ -157,7 +161,16 @@ <h1 class="section-heading">
 
       <div class="specs">
 
-          <pre>t() :: %Sidewalk.Job{args: list, class: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>, created_at: float, enqueued_at: float, jid: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>, queue: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>, retry: boolean, wrapped: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>}</pre>
+          <pre>t() :: %Sidewalk.Job{
+  args: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">list</a>(),
+  class: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>(),
+  created_at: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">float</a>(),
+  enqueued_at: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">float</a>(),
+  jid: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>(),
+  queue: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>(),
+  retry: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>(),
+  wrapped: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()
+}</pre>
 
       </div>
 
@@ -178,21 +191,23 @@ <h1 class="section-heading">
         <p>
           <span class="line">
             Built using
-            <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.16.4),
+            <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.18.3),
           </span>
           <span class="line">
             designed by
             <a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.
             </span>
         </p>
-        <button class="night-mode-toggle"><span class="sr-only">Switch theme</span></button>
       </footer>
     </div>
   </div>
 </section>
 </div>
   <script src="dist/app-574613960f.js"></script>
 
+
+
+
   </body>
 </html>