Current section
Files
Jump to
Current section
Files
doc/RandomUserApi.CLI.html
<!DOCTYPE html>
<html>
<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.12.0">
<title>RandomUserApi.CLI – RandomUserApi v0.5.0</title>
<link rel="stylesheet" href="dist/app-88251e7c81.css" />
<link rel="canonical" href="https://hexdocs.pm/random_user_api/RandomUserApi.CLI.html" />
<script src="dist/sidebar_items.js"></script>
</head>
<body data-type="modules">
<div class="main">
<button class="sidebar-toggle">
<i class="icon-menu"></i>
</button>
<section class="sidebar">
<a href="api-reference.html" class="sidebar-projectLink">
<div class="sidebar-projectDetails">
<h1 class="sidebar-projectName">
RandomUserApi
</h1>
<h2 class="sidebar-projectVersion">
v0.5.0
</h2>
</div>
</a>
<div class="sidebar-search">
<i class="icon-search"></i>
<input type="text" class="sidebar-searchInput" placeholder="search" autocomplete="off" />
</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>
<ul id="full-list" class="sidebar-fullList"></ul>
<div class="sidebar-noResults"></div>
</section>
<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<small class="visible-xs">RandomUserApi v0.5.0</small>
RandomUserApi.CLI
<a href="https://github.com/PatNowak/random_user_api/blob/master/lib/RandomUserApi/cli.ex#L1" title="View Source" class="view-source" rel="help">
<i class="icon-code"></i>
</a>
</h1>
<section id="moduledoc" class="docstring">
<p>Handle the command line interface for getting random users.</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="icon-link"></i>
</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="#get_female/0">get_female()</a>
</div>
<div class="summary-synopsis"><p>Gets single random user with gender “female”.
Return map with the female</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_females/1">get_females(n)</a>
</div>
<div class="summary-synopsis"><p>Gets n number of users and all of them are females.
Return list of maps with females</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_male/0">get_male()</a>
</div>
<div class="summary-synopsis"><p>Gets single random user with gender “male”.
Return map with the male</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_males/1">get_males(n)</a>
</div>
<div class="summary-synopsis"><p>Gets n number of users and all of them are males.
Return list of maps with males</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_user/0">get_user()</a>
</div>
<div class="summary-synopsis"><p>Gets single random user.
Return map with the user</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_users/1">get_users(n)</a>
</div>
<div class="summary-synopsis"><p>Gets n number of users.
Return list of maps with users</p>
</div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="icon-link"></i>
</a>
Functions
</h1>
<div class="detail" id="get_female/0">
<div class="detail-header">
<a href="#get_female/0" class="detail-link" title="Link to this function">
<i class="icon-link"></i>
</a>
<span class="signature">get_female()</span>
<a href="https://github.com/PatNowak/random_user_api/blob/master/lib/RandomUserApi/cli.ex#L36" class="view-source" rel="help" title="View Source">
<i class="icon-code"></i>
</a>
</div>
<section class="docstring">
<p>Gets single random user with gender “female”.
Return map with the female.</p>
</section>
</div>
<div class="detail" id="get_females/1">
<div class="detail-header">
<a href="#get_females/1" class="detail-link" title="Link to this function">
<i class="icon-link"></i>
</a>
<span class="signature">get_females(n)</span>
<a href="https://github.com/PatNowak/random_user_api/blob/master/lib/RandomUserApi/cli.ex#L52" class="view-source" rel="help" title="View Source">
<i class="icon-code"></i>
</a>
</div>
<section class="docstring">
<p>Gets n number of users and all of them are females.
Return list of maps with females.</p>
</section>
</div>
<div class="detail" id="get_male/0">
<div class="detail-header">
<a href="#get_male/0" class="detail-link" title="Link to this function">
<i class="icon-link"></i>
</a>
<span class="signature">get_male()</span>
<a href="https://github.com/PatNowak/random_user_api/blob/master/lib/RandomUserApi/cli.ex#L28" class="view-source" rel="help" title="View Source">
<i class="icon-code"></i>
</a>
</div>
<section class="docstring">
<p>Gets single random user with gender “male”.
Return map with the male.</p>
</section>
</div>
<div class="detail" id="get_males/1">
<div class="detail-header">
<a href="#get_males/1" class="detail-link" title="Link to this function">
<i class="icon-link"></i>
</a>
<span class="signature">get_males(n)</span>
<a href="https://github.com/PatNowak/random_user_api/blob/master/lib/RandomUserApi/cli.ex#L44" class="view-source" rel="help" title="View Source">
<i class="icon-code"></i>
</a>
</div>
<section class="docstring">
<p>Gets n number of users and all of them are males.
Return list of maps with males.</p>
</section>
</div>
<div class="detail" id="get_user/0">
<div class="detail-header">
<a href="#get_user/0" class="detail-link" title="Link to this function">
<i class="icon-link"></i>
</a>
<span class="signature">get_user()</span>
<a href="https://github.com/PatNowak/random_user_api/blob/master/lib/RandomUserApi/cli.ex#L12" class="view-source" rel="help" title="View Source">
<i class="icon-code"></i>
</a>
</div>
<section class="docstring">
<p>Gets single random user.
Return map with the user.</p>
</section>
</div>
<div class="detail" id="get_users/1">
<div class="detail-header">
<a href="#get_users/1" class="detail-link" title="Link to this function">
<i class="icon-link"></i>
</a>
<span class="signature">get_users(n)</span>
<a href="https://github.com/PatNowak/random_user_api/blob/master/lib/RandomUserApi/cli.ex#L20" class="view-source" rel="help" title="View Source">
<i class="icon-code"></i>
</a>
</div>
<section class="docstring">
<p>Gets n number of users.
Return list of maps with users.</p>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.12.0),
</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" />
</footer>
</div>
</div>
</section>
</div>
<script src="dist/app-21f1a20b9e.js"></script>
</body>
</html>