Packages

gleam_validator

0.1.0
0.2.0 0.1.0

A Gleam validator

HexDocs

Current section

Files

Jump to
Readme
2 Versions
1 Dependency
Dependants
Files
Activity
gleam_validator gen docs validator common index.html
Raw

gen/docs/validator/common/index.html 

<!DOCTYPE html>

<html>

  <head>

    <meta charset="utf-8" />

    <meta name="viewport" content="width=device-width" />

    <title>validator&#x2f;common - validator</title>

    <link rel="stylesheet" href="..&#x2f;../index.css" type="text/css" />

  </head>

  <body>

    <header class="page-header">

      <h2>

        validator<!-- -  -->

      </h2>

    </header>



    <div class="page">

      <nav class="sidebar">

        <a class="sidebar-toggle" href="#">

          <svg

            aria-hidden="true"

            focusable="false"

            data-prefix="fas"

            data-icon="bars"

            class="svg-inline--fa fa-bars fa-w-14"

            role="img"

            xmlns="http://www.w3.org/2000/svg"

            viewBox="0 0 448 512"

          >

            <path

              fill="#fff"

              d="M16 132h416c8.837 0 16-7.163 16-16V76c0-8.837-7.163-16-16-16H16C7.163 60 0 67.163 0 76v40c0 8.837 7.163 16 16 16zm0 160h416c8.837 0 16-7.163 16-16v-40c0-8.837-7.163-16-16-16H16c-8.837 0-16 7.163-16 16v40c0 8.837 7.163 16 16 16zm0 160h416c8.837 0 16-7.163 16-16v-40c0-8.837-7.163-16-16-16H16c-8.837 0-16 7.163-16 16v40c0 8.837 7.163 16 16 16z"

            ></path>

          </svg>

        </a>



        

        <h2>Pages</h2>

        <ul>

        

          <li><a href="..&#x2f;../index.html">README</a></li>

        

        </ul>

        



        

        



        <h2>Modules</h2>

        <ul>

        

          <li><a href="..&#x2f;../validator&#x2f;">validator</a></li>

        

          <li><a href="..&#x2f;../validator&#x2f;common&#x2f;">validator&#x2f;common</a></li>

        

          <li><a href="..&#x2f;../validator&#x2f;int&#x2f;">validator&#x2f;int</a></li>

        

          <li><a href="..&#x2f;../validator&#x2f;list&#x2f;">validator&#x2f;list</a></li>

        

          <li><a href="..&#x2f;../validator&#x2f;option&#x2f;">validator&#x2f;option</a></li>

        

          <li><a href="..&#x2f;../validator&#x2f;string&#x2f;">validator&#x2f;string</a></li>

        

        </ul>



        



<h2>Types</h2>

<ul>

    

    <li><a href="#Errors">Errors</a></li>

    

    <li><a href="#Validator">Validator</a></li>

    

    <li><a href="#ValidatorResult">ValidatorResult</a></li>

    

</ul>













<h2>Functions</h2>

<ul>

    

    <li><a href="#custom">custom</a></li>

    

</ul>





      </nav>



      <div class="content">

        

<h1 class="module-name">validator&#x2f;common</h1>







<section class="module-members">

  <a href="#module-types">

    <h1 id="module-types" class="module-member-kind">Types</h1>

  </a>



  

  <div class="member">

    <a href="#Errors">

      <h2 id="Errors" class="member-name">

        Errors

      </h2>

    </a>

    <div class="custom-type-constructors">

      <div class="rendered-markdown"><p>Error type returned by the validator.</p>

<p>This is a tuple with the first error and a list of all errors.

The list includes the first error.</p>

</div>

      <pre>pub type Errors(error) =

  tuple(error, List(error))</pre>

      

      

    </div>

  </div>

  

  <div class="member">

    <a href="#Validator">

      <h2 id="Validator" class="member-name">

        Validator

      </h2>

    </a>

    <div class="custom-type-constructors">

      <div class="rendered-markdown"><p>A Validator is a function that takes an input and

returns a ValidatorResult</p>

</div>

      <pre>pub type Validator(input, output, error) =

  fn(input) -&gt; ValidatorResult(output, error)</pre>

      

      

    </div>

  </div>

  

  <div class="member">

    <a href="#ValidatorResult">

      <h2 id="ValidatorResult" class="member-name">

        ValidatorResult

      </h2>

    </a>

    <div class="custom-type-constructors">

      <div class="rendered-markdown"></div>

      <pre>pub type ValidatorResult(output, error) =

  Result(output, Errors(error))</pre>

      

      

    </div>

  </div>

  

</section>













<section class="module-members">

 <a href="#module-functions">

   <h1 id="module-functions" class="module-member-kind">Functions</h1>

 </a>

 

 <div class="member">

    <a href="#custom">

      <h2 id="custom" class="member-name">

        custom

      </h2>

    </a>

    <pre>pub fn custom(

  error: a,

  check: fn(b) -&gt; Option(c),

) -&gt; fn(b) -&gt; Result(c, tuple(a, List(a)))</pre>

    <div class="rendered-markdown"><p>Create a custom validator, see documentation in root module</p>

</div>

  </div>

  

</section>





      </div>

    </div>



    <footer class="pride" onclick="document.querySelector('.pride').classList.toggle('show')">

      <div class="blue">Lucy</div>

      <div class="pink">says</div>

      <div class="white">trans</div>

      <div class="pink">rights</div>

      <div class="blue">✨</div>

      <a>✨</a>

    </footer>

  </body>

</html>