Current section
Files
Jump to
Current section
Files
docs/JayaCurrencyConverter.Accounts.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.26.0">
<meta name="project" content="Currency Converter v0.1.0">
<title>JayaCurrencyConverter.Accounts — Currency Converter v0.1.0</title>
<link rel="stylesheet" href="dist/elixir-b5076885a795c65e636c.css" />
<script src="dist/sidebar_items-b06e806963.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/app-a404e1e870b77c874f9e.js"></script>
</head>
<body data-type="modules">
<script>
try {
if (localStorage.getItem('night-mode') === 'true') {
document.body.classList.add('night-mode');
}
} catch (error) { }
</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" aria-label="Submit Search">
<span class="icon-search" aria-hidden="true" title="Submit search"></span>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
<span class="icon-cross" aria-hidden="true" title="Cancel search"></span>
</button>
<label class="search-label">
<input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<div class="sidebar-projectDetails">
<a href="readme.html" class="sidebar-projectName" translate="no">
Currency Converter
</a>
<strong class="sidebar-projectVersion" translate="no">
v0.1.0
</strong>
</div>
<a href="readme.html">
<img src="assets/logo.png" alt="Currency Converter" class="sidebar-projectImage">
</a>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list-link" href="#full-list">Pages</a></li>
<li><a id="modules-list-link" 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>
<span translate="no">JayaCurrencyConverter.Accounts</span>
<small class="app-vsn" translate="no">(Currency Converter v0.1.0)</small>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/accounts.ex#L1" 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>The Accounts context.</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="#create_user/1" translate="no">create_user(attrs \\ %{})</a>
</div>
<div class="summary-synopsis"><p>Creates a user.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_user!/1" translate="no">get_user!(id)</a>
</div>
<div class="summary-synopsis"><p>Gets a single user.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#list_users/0" translate="no">list_users()</a>
</div>
<div class="summary-synopsis"><p>Returns the list of users.</p></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="create_user/1">
<span id="create_user/0"></span>
<div class="detail-header">
<a href="#create_user/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" translate="no">create_user(attrs \\ %{})</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/accounts.ex#L59" 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>Creates a user.</p><h2 id="create_user/1-examples" class="section-heading">
<a href="#create_user/1-examples" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Examples
</h2>
<pre><code class="makeup elixir"><span class="gp unselectable">iex> </span><span class="n">create_user</span><span class="p" data-group-id="3331998848-1">(</span><span class="p" data-group-id="3331998848-2">%{</span><span class="ss">field</span><span class="p">:</span><span class="w"> </span><span class="n">value</span><span class="p" data-group-id="3331998848-2">}</span><span class="p" data-group-id="3331998848-1">)</span><span class="w">
</span><span class="p" data-group-id="3331998848-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3331998848-4">%</span><span class="nc" data-group-id="3331998848-4">User</span><span class="p" data-group-id="3331998848-4">{</span><span class="p" data-group-id="3331998848-4">}</span><span class="p" data-group-id="3331998848-3">}</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="n">create_user</span><span class="p" data-group-id="3331998848-5">(</span><span class="p" data-group-id="3331998848-6">%{</span><span class="ss">field</span><span class="p">:</span><span class="w"> </span><span class="n">bad_value</span><span class="p" data-group-id="3331998848-6">}</span><span class="p" data-group-id="3331998848-5">)</span><span class="w">
</span><span class="p" data-group-id="3331998848-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3331998848-8">%</span><span class="nc" data-group-id="3331998848-8">Ecto.Changeset</span><span class="p" data-group-id="3331998848-8">{</span><span class="p" data-group-id="3331998848-8">}</span><span class="p" data-group-id="3331998848-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="get_user!/1">
<div class="detail-header">
<a href="#get_user!/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" translate="no">get_user!(id)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/accounts.ex#L38" 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>Gets a single user.</p><p>Raises <a href="https://hexdocs.pm/ecto/3.7.1/Ecto.NoResultsError.html"><code class="inline">Ecto.NoResultsError</code></a> if the User does not exist.</p><h2 id="get_user!/1-examples" class="section-heading">
<a href="#get_user!/1-examples" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Examples
</h2>
<pre><code class="makeup elixir"><span class="gp unselectable">iex> </span><span class="n">get_user!</span><span class="p" data-group-id="3766910436-1">(</span><span class="mi">123</span><span class="p" data-group-id="3766910436-1">)</span><span class="w">
</span><span class="p" data-group-id="3766910436-2">%</span><span class="nc" data-group-id="3766910436-2">User</span><span class="p" data-group-id="3766910436-2">{</span><span class="p" data-group-id="3766910436-2">}</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="n">get_user!</span><span class="p" data-group-id="3766910436-3">(</span><span class="mi">456</span><span class="p" data-group-id="3766910436-3">)</span><span class="w">
</span><span class="gt">** (Ecto.NoResultsError)</span></code></pre>
</section>
</section>
<section class="detail" id="list_users/0">
<div class="detail-header">
<a href="#list_users/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" translate="no">list_users()</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/accounts.ex#L20" 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>Returns the list of users.</p><h2 id="list_users/0-examples" class="section-heading">
<a href="#list_users/0-examples" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Examples
</h2>
<pre><code class="makeup elixir"><span class="gp unselectable">iex> </span><span class="n">list_users</span><span class="p" data-group-id="2847021691-1">(</span><span class="p" data-group-id="2847021691-1">)</span><span class="w">
</span><span class="p" data-group-id="2847021691-2">[</span><span class="p" data-group-id="2847021691-3">%</span><span class="nc" data-group-id="2847021691-3">User</span><span class="p" data-group-id="2847021691-3">{</span><span class="p" data-group-id="2847021691-3">}</span><span class="p">,</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="2847021691-2">]</span></code></pre>
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
Find it on Hex:
<a href="https://hex.pm/packages/jaya_currency_converter/0.1.0" class="line footer-hex-package">Package</a>
<a href="https://preview.hex.pm/preview/jaya_currency_converter/0.1.0" class="line">Preview</a>
<a href="https://preview.hex.pm/preview/jaya_currency_converter/0.1.0/show/lib/jaya_currency_converter/accounts.ex">(current file)</a>
</p>
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.26.0) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>.
</span>
<span class="line">
Designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" rel="noopener" title="@dignifiedquire" translate="no">Friedel Ziegelmayer</a>.
</span>
</p>
<p>
<a href="api-reference.html" title="API reference" class="line footer-button">API Reference</a>
<button class="line footer-button display-shortcuts-help">
Display keyboard shortcuts
</button>
<button class="line footer-button display-quick-switch">
Go to a HexDocs package
</button>
<button class="line footer-button display-settings">
Settings
</button>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>