Current section
Files
Jump to
Current section
Files
doc/Riak.CRDT.Counter.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.16.2">
<title>Riak.CRDT.Counter – Riak Elixir Client v1.1.5</title>
<link rel="stylesheet" href="dist/app-268c9dc719.css" />
<link rel="canonical" href="https://hexdocs.pm/riak/Riak.CRDT.Counter.html" />
<script src="dist/sidebar_items-57e67b9199.js"></script>
</head>
<body data-type="modules">
<script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script>
<div class="main">
<button class="sidebar-toggle">
<span class="icon-menu" aria-hidden="true"></span>
<span class="sr-only">Toggle Sidebar</span>
</button>
<section class="sidebar">
<a href="api-reference.html" class="sidebar-projectLink">
<div class="sidebar-projectDetails">
<h1 class="sidebar-projectName">
Riak Elixir Client
</h1>
<h2 class="sidebar-projectVersion">
v1.1.5
</h2>
</div>
</a>
<div class="sidebar-search">
<span class="icon-search" aria-hidden="true"></span>
<input type="text" class="sidebar-searchInput" placeholder="search" aria-label="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>
<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="visible-xs">Riak Elixir Client v1.1.5</small>
Riak.CRDT.Counter
<a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/crdt/counter.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>Counter data-type on Riak 2.0.</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="#decrement/2">decrement(counter, amount \\ 1)</a>
</div>
<div class="summary-synopsis"><p>Decrement a <code class="inline">counter</code> on the <code class="inline">amount</code> defaulting in 1</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#increment/2">increment(counter, amount \\ 1)</a>
</div>
<div class="summary-synopsis"><p>Increment a <code class="inline">counter</code> on the <code class="inline">amount</code> defaulting in 1</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#new/0">new()</a>
</div>
<div class="summary-synopsis"><p>Create a new counter</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#value/1">value(counter)</a>
</div>
<div class="summary-synopsis"><p>Get the original value as a number</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="detail" id="decrement/2">
<span id="decrement/1"></span>
<div class="detail-header">
<a href="#decrement/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>
<span class="signature">decrement(counter, amount \\ 1)</span>
<a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/crdt/counter.ex#L30" 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>Decrement a <code class="inline">counter</code> on the <code class="inline">amount</code> defaulting in 1</p>
</section>
</div>
<div class="detail" id="increment/2">
<span id="increment/1"></span>
<div class="detail-header">
<a href="#increment/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>
<span class="signature">increment(counter, amount \\ 1)</span>
<a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/crdt/counter.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>Increment a <code class="inline">counter</code> on the <code class="inline">amount</code> defaulting in 1</p>
</section>
</div>
<div class="detail" id="new/0">
<div class="detail-header">
<a href="#new/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>
<span class="signature">new()</span>
<a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/crdt/counter.ex#L10" 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>Create a new counter</p>
</section>
</div>
<div class="detail" id="value/1">
<div class="detail-header">
<a href="#value/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>
<span class="signature">value(counter)</span>
<a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/crdt/counter.ex#L39" 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>Get the original value as a number</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.16.2),
</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"><span class="sr-only">Switch theme</span></button>
</footer>
</div>
</div>
</section>
</div>
<script src="dist/app-4988ddd06b.js"></script>
</body>
</html>