Packages

return_helpers

0.1.0
0.1.1 0.1.0 0.0.3 0.0.2 0.0.1

Simple library that adds a piping possibility for easy returning from pipe chains Imagine: socket = socket |> assign(valid: true) {:noreply, socket} to write as: socket |> assign(valid: true) |> noreply() or: iex> "34" |> between_strings("12", "56") "123456"

HexDocs

Current section

Files

Jump to
Readme
5 Versions
0 Dependencies
Dependants
Files
Activity
return_helpers doc ReturnHelpers.html
Raw

doc/ReturnHelpers.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.21.3">

    <meta name="project" content="return_helpers v0.1.0">

    <title>ReturnHelpers — return_helpers v0.1.0</title>

    <link rel="stylesheet" href="dist/elixir-0ab8a6a80ebaaa287431.css" />

      <link rel="canonical" href="https://hexdocs.pm/return_helpers/ReturnHelpers.html" />

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

      <script src="docs_config.js"></script>

    <script async src="dist/app-a225d03098e64fef431a.js"></script>

  </head>

  <body data-type="modules">

    <script>try { if(localStorage.getItem('night-mode') === 'true') 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="api-reference.html" class="sidebar-projectName">

return_helpers      </a>

      <h2 class="sidebar-projectVersion">

        v0.1.0

      </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">return_helpers v0.1.0</small>

ReturnHelpers      </h1>





        <section id="moduledoc">

<p>Simple library that adds a piping possibility for easy returning</p>

<p>Imagine</p>

<pre><code class="nohighlight makeup elixir"><span class="w">  </span><span class="n">socket</span><span class="w"> </span><span class="o">=</span><span class="w">

    </span><span class="n">socket</span><span class="w">

    </span><span class="o">|&gt;</span><span class="w"> </span><span class="n">assign</span><span class="p" data-group-id="8296830383-1">(</span><span class="ss">valid</span><span class="p">:</span><span class="w"> </span><span class="no">true</span><span class="p" data-group-id="8296830383-1">)</span><span class="w">

  </span><span class="p" data-group-id="8296830383-2">{</span><span class="ss">:noreply</span><span class="p">,</span><span class="w"> </span><span class="n">socket</span><span class="p" data-group-id="8296830383-2">}</span></code></pre>

<p>to write like:</p>

<pre><code class="nohighlight makeup elixir"><span class="w">  </span><span class="n">socket</span><span class="w">

  </span><span class="o">|&gt;</span><span class="w"> </span><span class="n">assign</span><span class="p" data-group-id="6707757972-1">(</span><span class="ss">valid</span><span class="p">:</span><span class="w"> </span><span class="no">true</span><span class="p" data-group-id="6707757972-1">)</span><span class="w">

  </span><span class="o">|&gt;</span><span class="w"> </span><span class="n">noreply</span><span class="p" data-group-id="6707757972-2">(</span><span class="p" data-group-id="6707757972-2">)</span></code></pre>

<p>Looks cleaner ?</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="#error/1">error(reason)</a>

  </div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#noreply/1">noreply(state)</a>

  </div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#noreply/2">noreply(state, params)</a>

  </div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#noreply/3">noreply(state, params, other)</a>

  </div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#ok/1">ok(return)</a>

  </div>

    <div class="summary-synopsis"><h2>Examples</h2>

<pre><code class="nohighlight makeup elixir"><span class="gp unselectable">iex(2)&gt; </span><span class="n">socket</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p" data-group-id="5469399656-1">%{</span><span class="p" data-group-id="5469399656-1">}</span><span class="w">

</span><span class="p" data-group-id="5469399656-2">%{</span><span class="p" data-group-id="5469399656-2">}</span><span class="w">

</span><span class="gp unselectable">iex(3)&gt; </span><span class="n">socket</span><span class="w"> </span><span class="o">|&gt;</span><span class="w"> </span><span class="n">ok</span><span class="p" data-group-id="5469399656-3">(</span><span class="p" data-group-id="5469399656-3">)</span><span class="w">

</span><span class="p" data-group-id="5469399656-4">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5469399656-5">%{</span><span class="p" data-group-id="5469399656-5">}</span><span class="p" data-group-id="5469399656-4">}</span><span class="w">

</span><span class="gp unselectable">iex(4)&gt; </span><span class="n">socket</span><span class="w"> </span><span class="o">|&gt;</span><span class="w"> </span><span class="n">noreply</span><span class="p" data-group-id="5469399656-6">(</span><span class="p" data-group-id="5469399656-6">)</span><span class="w">

</span><span class="p" data-group-id="5469399656-7">{</span><span class="ss">:noreply</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5469399656-8">%{</span><span class="p" data-group-id="5469399656-8">}</span><span class="p" data-group-id="5469399656-7">}</span></code></pre>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#ok/2">ok(return, params)</a>

  </div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#reply/1">reply(reply)</a>

  </div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#reply/2">reply(reply, state)</a>

  </div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#reply/3">reply(return, state, other)</a>

  </div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#stop/1">stop(reason)</a>

  </div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#stop/2">stop(reason, state)</a>

  </div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="#stop/3">stop(reason, reply, state)</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="error/1">

  <div class="detail-header">

    <a href="#error/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">error(reason)</h1>

  </div>

  <section class="docstring">

  </section>

</section>

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

  <div class="detail-header">

    <a href="#noreply/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">noreply(state)</h1>

  </div>

  <section class="docstring">

  </section>

</section>

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

  <div class="detail-header">

    <a href="#noreply/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">noreply(state, params)</h1>

  </div>

  <section class="docstring">

  </section>

</section>

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

  <div class="detail-header">

    <a href="#noreply/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">noreply(state, params, other)</h1>

  </div>

  <section class="docstring">

  </section>

</section>

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

  <div class="detail-header">

    <a href="#ok/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">ok(return)</h1>

  </div>

  <section class="docstring">

<h2 id="ok/1-examples" class="section-heading">

  <a href="#ok/1-examples" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>

  Examples

</h2>



<pre><code class="nohighlight makeup elixir"><span class="gp unselectable">iex(2)&gt; </span><span class="n">socket</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p" data-group-id="5469399656-1">%{</span><span class="p" data-group-id="5469399656-1">}</span><span class="w">

</span><span class="p" data-group-id="5469399656-2">%{</span><span class="p" data-group-id="5469399656-2">}</span><span class="w">

</span><span class="gp unselectable">iex(3)&gt; </span><span class="n">socket</span><span class="w"> </span><span class="o">|&gt;</span><span class="w"> </span><span class="n">ok</span><span class="p" data-group-id="5469399656-3">(</span><span class="p" data-group-id="5469399656-3">)</span><span class="w">

</span><span class="p" data-group-id="5469399656-4">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5469399656-5">%{</span><span class="p" data-group-id="5469399656-5">}</span><span class="p" data-group-id="5469399656-4">}</span><span class="w">

</span><span class="gp unselectable">iex(4)&gt; </span><span class="n">socket</span><span class="w"> </span><span class="o">|&gt;</span><span class="w"> </span><span class="n">noreply</span><span class="p" data-group-id="5469399656-6">(</span><span class="p" data-group-id="5469399656-6">)</span><span class="w">

</span><span class="p" data-group-id="5469399656-7">{</span><span class="ss">:noreply</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5469399656-8">%{</span><span class="p" data-group-id="5469399656-8">}</span><span class="p" data-group-id="5469399656-7">}</span></code></pre>

  </section>

</section>

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

  <div class="detail-header">

    <a href="#ok/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">ok(return, params)</h1>

  </div>

  <section class="docstring">

  </section>

</section>

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

  <div class="detail-header">

    <a href="#reply/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">reply(reply)</h1>

  </div>

  <section class="docstring">

  </section>

</section>

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

  <div class="detail-header">

    <a href="#reply/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">reply(reply, state)</h1>

  </div>

  <section class="docstring">

  </section>

</section>

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

  <div class="detail-header">

    <a href="#reply/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">reply(return, state, other)</h1>

  </div>

  <section class="docstring">

  </section>

</section>

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

  <div class="detail-header">

    <a href="#stop/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">stop(reason)</h1>

  </div>

  <section class="docstring">

  </section>

</section>

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

  <div class="detail-header">

    <a href="#stop/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">stop(reason, state)</h1>

  </div>

  <section class="docstring">

  </section>

</section>

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

  <div class="detail-header">

    <a href="#stop/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">stop(reason, reply, state)</h1>

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

          </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 display-shortcuts-help">

            Display keyboard shortcuts

          </button>

          <button class="line footer-button night-mode-toggle">

            Toggle night mode

          </button>

          <button class="line footer-button display-quick-switch">

            Go to a HexDocs package

          </button>

          <button class="line footer-button tooltips-toggle">

            <span class="tooltips-option-disable">Disable tooltips</span>

            <span class="tooltips-option-enable">Enable tooltips</span>

          </button>

        </p>

      </footer>

    </div>

  </div>

</section>

</div>

  </body>

</html>