Current section
Files
Jump to
Current section
Files
doc/ExPomodoro.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.29.1">
<meta name="project" content="ExPomodoro v0.1.1">
<title>ExPomodoro — ExPomodoro v0.1.1</title>
<link rel="stylesheet" href="dist/html-elixir-V2ETBPMB.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-IV5W3OL2.js"></script>
<script src="dist/sidebar_items-A27BE2CD.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-XN2TSG4M.js"></script>
</head>
<body data-type="modules" class="page-module">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
<i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>
</button>
<label class="search-label">
<p class="sr-only">Search</p>
<input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<div class="sidebar-projectDetails">
<a href="ExPomodoro.html" class="sidebar-projectName" translate="no">
ExPomodoro
</a>
<strong class="sidebar-projectVersion" translate="no">
v0.1.1
</strong>
</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>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<button class="icon-action display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro.ex#L1" title="View Source" class="icon-action" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span translate="no">ExPomodoro</span>
<small class="app-vsn" translate="no">(ExPomodoro v0.1.1)</small>
</h1>
<section id="moduledoc">
<p>Documentation for <a href="ExPomodoro.html#content"><code class="inline">ExPomodoro</code></a>.</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Summary
</h1>
<div class="summary-types summary">
<h2>
<a href="#types">Types</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:already_finished_response/0" translate="no">already_finished_response()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:already_started_response/0" translate="no">already_started_response()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:not_found_response/0" translate="no">not_found_response()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:resumed_response/0" translate="no">resumed_response()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:started_response/0" translate="no">started_response()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:success_response/0" translate="no">success_response()</a>
</div>
</div>
</div>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#child_spec/1" translate="no">child_spec(options \\ [])</a>
</div>
<div class="summary-synopsis"><p>Returns the <a href="ExPomodoro.html#content"><code class="inline">Elixir.ExPomodoro</code></a> child spec. It is intended for appliations to
add an <a href="ExPomodoro.html#content"><code class="inline">Elixir.ExPomodoro</code></a> child spec to their application trees to have an
<a href="ExPomodoro.Supervisor.html"><code class="inline">Elixir.ExPomodoro.Supervisor</code></a> started before interacting with the rest of the
<a href="ExPomodoro.html#content"><code class="inline">Elixir.ExPomodoro</code></a> commands.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get/1" translate="no">get(id)</a>
</div>
<div class="summary-synopsis"><p>Generally this function is used to check whether a Pomodoro exists or not.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#pause/1" translate="no">pause(id)</a>
</div>
<div class="summary-synopsis"><p>The Pomodoro timer can be paused using this function. While this function
will cause a pomodoro to pause, it can still finish by timeout, defined in the
<a href="ExPomodoro.PomodoroServer.html"><code class="inline">Elixir.ExPomodoro.PomodoroServer</code></a> implementation.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#start/2" translate="no">start(id, opts \\ [])</a>
</div>
<div class="summary-synopsis"><p>This is the main function to start a pomodoro.</p></div>
</div>
</div>
</section>
<section id="types" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#types">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Types
</h1>
<div class="types-list">
<section class="detail" id="t:already_finished_response/0">
<div class="detail-header">
<a href="#t:already_finished_response/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">already_finished_response()</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro.ex#L15" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> already_finished_response() ::
{:ok, {:already_finished, <a href="ExPomodoro.Pomodoro.html#t:t/0">ExPomodoro.Pomodoro.t</a>()}}</pre>
</div>
</section>
</section>
<section class="detail" id="t:already_started_response/0">
<div class="detail-header">
<a href="#t:already_started_response/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">already_started_response()</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro.ex#L14" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> already_started_response() :: {:ok, {:already_started, <a href="ExPomodoro.Pomodoro.html#t:t/0">ExPomodoro.Pomodoro.t</a>()}}</pre>
</div>
</section>
</section>
<section class="detail" id="t:not_found_response/0">
<div class="detail-header">
<a href="#t:not_found_response/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">not_found_response()</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro.ex#L17" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> not_found_response() :: {:error, :not_found}</pre>
</div>
</section>
</section>
<section class="detail" id="t:resumed_response/0">
<div class="detail-header">
<a href="#t:resumed_response/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">resumed_response()</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro.ex#L16" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> resumed_response() :: {:ok, {:resumed, <a href="ExPomodoro.Pomodoro.html#t:t/0">ExPomodoro.Pomodoro.t</a>()}}</pre>
</div>
</section>
</section>
<section class="detail" id="t:started_response/0">
<div class="detail-header">
<a href="#t:started_response/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">started_response()</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro.ex#L13" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> started_response() :: {:ok, {:started, <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">pid</a>()}}</pre>
</div>
</section>
</section>
<section class="detail" id="t:success_response/0">
<div class="detail-header">
<a href="#t:success_response/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">success_response()</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro.ex#L12" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> success_response() :: {:ok, <a href="ExPomodoro.Pomodoro.html#t:t/0">ExPomodoro.Pomodoro.t</a>()}</pre>
</div>
</section>
</section>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Functions
</h1>
<div class="functions-list">
<section class="detail" id="child_spec/1">
<span id="child_spec/0"></span>
<div class="detail-header">
<a href="#child_spec/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">child_spec(options \\ [])</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro.ex#L26" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> child_spec(<a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">keyword</a>()) :: <a href="https://hexdocs.pm/elixir/Supervisor.html#t:child_spec/0">Supervisor.child_spec</a>()</pre>
</div>
<p>Returns the <a href="ExPomodoro.html#content"><code class="inline">Elixir.ExPomodoro</code></a> child spec. It is intended for appliations to
add an <a href="ExPomodoro.html#content"><code class="inline">Elixir.ExPomodoro</code></a> child spec to their application trees to have an
<a href="ExPomodoro.Supervisor.html"><code class="inline">Elixir.ExPomodoro.Supervisor</code></a> started before interacting with the rest of the
<a href="ExPomodoro.html#content"><code class="inline">Elixir.ExPomodoro</code></a> commands.</p>
</section>
</section>
<section class="detail" id="get/1">
<div class="detail-header">
<a href="#get/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">get(id)</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro.ex#L112" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> get(<a href="ExPomodoro.Pomodoro.html#t:id/0">ExPomodoro.Pomodoro.id</a>()) :: <a href="#t:success_response/0">success_response</a>() | <a href="#t:not_found_response/0">not_found_response</a>()</pre>
</div>
<p>Generally this function is used to check whether a Pomodoro exists or not.</p><p>Given an <code class="inline">id</code>, if a Pomodoro exists, a <a href="ExPomodoro.Pomodoro.html"><code class="inline">Elixir.ExPomodoro.Pomodoro</code></a> struct is returned,
othwerise returns an error tuple.</p><h3 id="get/1-examples" class="section-heading">
<a href="#get/1-examples" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">examples</p>
</a>
Examples:
</h3>
<pre><code class="makeup elixir" translate="no"><span class="c1"># Return a pomodoro.</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">ExPomodoro</span><span class="o">.</span><span class="n">get</span><span class="p" data-group-id="5555951257-1">(</span><span class="s">"some id"</span><span class="p" data-group-id="5555951257-1">)</span><span class="w">
</span><span class="p" data-group-id="5555951257-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5555951257-3">%</span><span class="nc" data-group-id="5555951257-3">ExPomodoro.Pomodoro</span><span class="p" data-group-id="5555951257-3">{</span><span class="ss">id</span><span class="p">:</span><span class="w"> </span><span class="s">"some id"</span><span class="p" data-group-id="5555951257-3">}</span><span class="p" data-group-id="5555951257-2">}</span><span class="w">
</span><span class="c1"># Get a pomodoro that does not exist.</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">ExPomodoro</span><span class="o">.</span><span class="n">get</span><span class="p" data-group-id="5555951257-4">(</span><span class="s">"some other id"</span><span class="p" data-group-id="5555951257-4">)</span><span class="w">
</span><span class="p" data-group-id="5555951257-5">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="ss">:not_found</span><span class="p" data-group-id="5555951257-5">}</span></code></pre>
</section>
</section>
<section class="detail" id="pause/1">
<div class="detail-header">
<a href="#pause/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">pause(id)</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro.ex#L139" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> pause(<a href="ExPomodoro.Pomodoro.html#t:id/0">ExPomodoro.Pomodoro.id</a>()) :: <a href="#t:success_response/0">success_response</a>() | <a href="#t:not_found_response/0">not_found_response</a>()</pre>
</div>
<p>The Pomodoro timer can be paused using this function. While this function
will cause a pomodoro to pause, it can still finish by timeout, defined in the
<a href="ExPomodoro.PomodoroServer.html"><code class="inline">Elixir.ExPomodoro.PomodoroServer</code></a> implementation.</p><p>Given an <code class="inline">id</code>, returns a <a href="ExPomodoro.Pomodoro.html"><code class="inline">Elixir.ExPomodoro.Pomodoro</code></a> struct or an error tuple if the
pomodoro does not exist.</p><h3 id="pause/1-examples" class="section-heading">
<a href="#pause/1-examples" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">examples</p>
</a>
Examples:
</h3>
<pre><code class="makeup elixir" translate="no"><span class="c1"># Pause a pomodoro and returns the remaining timeleft to complete the</span><span class="w">
</span><span class="c1"># current activity.</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">ExPomodoro</span><span class="o">.</span><span class="n">pause</span><span class="p" data-group-id="1228366908-1">(</span><span class="s">"some id"</span><span class="p" data-group-id="1228366908-1">)</span><span class="w">
</span><span class="p" data-group-id="1228366908-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1228366908-3">%</span><span class="nc" data-group-id="1228366908-3">Pomodoro</span><span class="p" data-group-id="1228366908-3">{</span><span class="ss">id</span><span class="p">:</span><span class="w"> </span><span class="s">"some id"</span><span class="p">,</span><span class="w"> </span><span class="ss">activity</span><span class="p">:</span><span class="w"> </span><span class="ss">:idle</span><span class="p">,</span><span class="w"> </span><span class="ss">current_duration</span><span class="p">:</span><span class="w"> </span><span class="n">timeleft</span><span class="p" data-group-id="1228366908-3">}</span><span class="p" data-group-id="1228366908-2">}</span><span class="w">
</span><span class="c1"># Pause a pomodoro that does not exist.</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">ExPomodoro</span><span class="o">.</span><span class="n">pause</span><span class="p" data-group-id="1228366908-4">(</span><span class="s">"some id"</span><span class="p" data-group-id="1228366908-4">)</span><span class="w">
</span><span class="p" data-group-id="1228366908-5">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="ss">:not_found</span><span class="p" data-group-id="1228366908-5">}</span></code></pre>
</section>
</section>
<section class="detail" id="start/2">
<span id="start/1"></span>
<div class="detail-header">
<a href="#start/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">start(id, opts \\ [])</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro.ex#L87" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> start(<a href="ExPomodoro.Pomodoro.html#t:id/0">ExPomodoro.Pomodoro.id</a>(), <a href="ExPomodoro.Pomodoro.html#t:opts/0">ExPomodoro.Pomodoro.opts</a>()) ::
<a href="#t:success_response/0">success_response</a>()
| <a href="#t:already_started_response/0">already_started_response</a>()
| <a href="#t:already_finished_response/0">already_finished_response</a>()
| <a href="#t:resumed_response/0">resumed_response</a>()</pre>
</div>
<p>This is the main function to start a pomodoro.</p><p>Given an <code class="inline">id</code> and an optional keyword of options returns a successful response
if a Pomodoro has been started or resumed. Every successful responses returns
the current <a href="ExPomodoro.Pomodoro.html"><code class="inline">Elixir.ExPomodoro.Pomodoro</code></a> struct.</p><h3 id="start/2-options" class="section-heading">
<a href="#start/2-options" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">options</p>
</a>
Options
</h3>
<ul><li><code class="inline">exercise_duration</code>: The duration in milliseconds of the exercise duration,
<code class="inline">non_negative_integer()</code>.</li><li><code class="inline">break_duration</code>: The duration in milliseconds of the break duration,
<code class="inline">non_negative_integer()</code>.</li><li><code class="inline">rounds</code>: The number of rounds until a long break, <code class="inline">non_negative_integer()</code>.</li></ul><h3 id="start/2-examples" class="section-heading">
<a href="#start/2-examples" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">examples</p>
</a>
Examples:
</h3>
<pre><code class="makeup elixir" translate="no"><span class="c1"># Start a pomodoro with default options.</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">ExPomodoro</span><span class="o">.</span><span class="n">start</span><span class="p" data-group-id="0482169923-1">(</span><span class="s">"some id"</span><span class="p" data-group-id="0482169923-1">)</span><span class="w">
</span><span class="p" data-group-id="0482169923-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0482169923-3">%</span><span class="nc" data-group-id="0482169923-3">ExPomodoro.Pomodoro</span><span class="p" data-group-id="0482169923-3">{</span><span class="w">
</span><span class="ss">id</span><span class="p">:</span><span class="w"> </span><span class="s">"some id"</span><span class="p">,</span><span class="w">
</span><span class="ss">activity</span><span class="p">:</span><span class="w"> </span><span class="ss">:exercise</span><span class="p">,</span><span class="w">
</span><span class="ss">exercise_duration</span><span class="p">:</span><span class="w"> </span><span class="mi">1_500_000</span><span class="p">,</span><span class="w">
</span><span class="ss">break_duration</span><span class="p">:</span><span class="w"> </span><span class="mi">300_000</span><span class="p">,</span><span class="w">
</span><span class="ss">rounds</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="w">
</span><span class="p" data-group-id="0482169923-3">}</span><span class="p" data-group-id="0482169923-2">}</span><span class="w">
</span><span class="c1"># Start a pomodoro with some options.</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">ExPomodoro</span><span class="o">.</span><span class="n">start</span><span class="p" data-group-id="0482169923-4">(</span><span class="s">"some id"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0482169923-5">[</span><span class="w">
</span><span class="gp unselectable">...> </span><span class="w"> </span><span class="ss">exercise_duration</span><span class="p">:</span><span class="w"> </span><span class="mi">150_000</span><span class="p">,</span><span class="w">
</span><span class="gp unselectable">...> </span><span class="w"> </span><span class="ss">break_duration</span><span class="p">:</span><span class="w"> </span><span class="mi">25_000</span><span class="p">,</span><span class="w">
</span><span class="gp unselectable">...> </span><span class="w"> </span><span class="ss">rounds</span><span class="p">:</span><span class="w"> </span><span class="mi">8</span><span class="w">
</span><span class="gp unselectable">...> </span><span class="p" data-group-id="0482169923-5">]</span><span class="p" data-group-id="0482169923-4">)</span><span class="w">
</span><span class="p" data-group-id="0482169923-6">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0482169923-7">%</span><span class="nc" data-group-id="0482169923-7">ExPomodoro.Pomodoro</span><span class="p" data-group-id="0482169923-7">{</span><span class="w">
</span><span class="ss">id</span><span class="p">:</span><span class="w"> </span><span class="s">"some id"</span><span class="p">,</span><span class="w">
</span><span class="ss">activity</span><span class="p">:</span><span class="w"> </span><span class="ss">:exercise</span><span class="p">,</span><span class="w">
</span><span class="ss">exercise_duration</span><span class="p">:</span><span class="w"> </span><span class="mi">150_000</span><span class="p">,</span><span class="w">
</span><span class="ss">break_duration</span><span class="p">:</span><span class="w"> </span><span class="mi">25_000</span><span class="p">,</span><span class="w">
</span><span class="ss">rounds</span><span class="p">:</span><span class="w"> </span><span class="mi">8</span><span class="w">
</span><span class="p" data-group-id="0482169923-7">}</span><span class="p" data-group-id="0482169923-6">}</span><span class="w">
</span><span class="c1"># Start a pomodoro that is already running.</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">ExPomodoro</span><span class="o">.</span><span class="n">start</span><span class="p" data-group-id="0482169923-8">(</span><span class="s">"some_id"</span><span class="p" data-group-id="0482169923-8">)</span><span class="w">
</span><span class="p" data-group-id="0482169923-9">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0482169923-10">{</span><span class="ss">:already_started</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0482169923-11">%</span><span class="nc" data-group-id="0482169923-11">Pomodoro</span><span class="p" data-group-id="0482169923-11">{</span><span class="ss">id</span><span class="p">:</span><span class="w"> </span><span class="s">"some id"</span><span class="p" data-group-id="0482169923-11">}</span><span class="p" data-group-id="0482169923-10">}</span><span class="p" data-group-id="0482169923-9">}</span><span class="w">
</span><span class="c1"># Start a pomodoro that already finished.</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">ExPomodoro</span><span class="o">.</span><span class="n">start</span><span class="p" data-group-id="0482169923-12">(</span><span class="s">"some_id"</span><span class="p" data-group-id="0482169923-12">)</span><span class="w">
</span><span class="p" data-group-id="0482169923-13">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0482169923-14">{</span><span class="ss">:already_finished</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0482169923-15">%</span><span class="nc" data-group-id="0482169923-15">Pomodoro</span><span class="p" data-group-id="0482169923-15">{</span><span class="ss">id</span><span class="p">:</span><span class="w"> </span><span class="s">"some id"</span><span class="p" data-group-id="0482169923-15">}</span><span class="p" data-group-id="0482169923-14">}</span><span class="p" data-group-id="0482169923-13">}</span><span class="w">
</span><span class="c1"># Start a pomodoro that was paused or finished a break.</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">ExPomodoro</span><span class="o">.</span><span class="n">start</span><span class="p" data-group-id="0482169923-16">(</span><span class="s">"some_id"</span><span class="p" data-group-id="0482169923-16">)</span><span class="w">
</span><span class="p" data-group-id="0482169923-17">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0482169923-18">{</span><span class="ss">:resumed</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0482169923-19">%</span><span class="nc" data-group-id="0482169923-19">Pomodoro</span><span class="p" data-group-id="0482169923-19">{</span><span class="ss">id</span><span class="p">:</span><span class="w"> </span><span class="s">"some id"</span><span class="p" data-group-id="0482169923-19">}</span><span class="p" data-group-id="0482169923-18">}</span><span class="p" data-group-id="0482169923-17">}</span></code></pre>
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
<a href="https://hex.pm/packages/ex_pomodoro/0.1.1" class="footer-hex-package">Hex Package</a>
<a href="https://preview.hex.pm/preview/ex_pomodoro/0.1.1">Hex Preview</a>
(<a href="https://preview.hex.pm/preview/ex_pomodoro/0.1.1/show/lib/ex_pomodoro.ex">current file</a>)
</span>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="ExPomodoro.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.29.1) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>