-
Notifications
You must be signed in to change notification settings - Fork 0
/
phone-number.region.html
21 lines (21 loc) · 16.1 KB
/
phone-number.region.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>phone-number.region documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script><link rel="stylesheet" type="text/css" href="css/randomseed.css" /></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Phone-number</span> <span class="project-version">8.13.6-3</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="10_introduction.html"><div class="inner"><span>Introduction</span></div></a></li><li class="depth-1 "><a href="30_specs.html"><div class="inner"><span>Specs and checks</span></div></a></li><li class="depth-1 "><a href="40_development.html"><div class="inner"><span>Development</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><a href="phone-number.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>phone-number</span></div></a></li><li class="depth-2 branch"><a href="phone-number.calling-code.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>calling-code</span></div></a></li><li class="depth-2 branch"><a href="phone-number.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch"><a href="phone-number.cost.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cost</span></div></a></li><li class="depth-2 branch"><a href="phone-number.country-code.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>country-code</span></div></a></li><li class="depth-2 branch"><a href="phone-number.db.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>db</span></div></a></li><li class="depth-2 branch"><a href="phone-number.format.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>format</span></div></a></li><li class="depth-2 branch"><a href="phone-number.leniency.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>leniency</span></div></a></li><li class="depth-2 branch"><a href="phone-number.locale.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>locale</span></div></a></li><li class="depth-2 branch"><a href="phone-number.match.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>match</span></div></a></li><li class="depth-2 branch"><a href="phone-number.net-code.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>net-code</span></div></a></li><li class="depth-2 branch current"><a href="phone-number.region.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>region</span></div></a></li><li class="depth-2 branch"><a href="phone-number.type.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>type</span></div></a></li><li class="depth-2 branch"><a href="phone-number.tz-format.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tz-format</span></div></a></li><li class="depth-2"><a href="phone-number.util.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>util</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="phone-number.region.html#var-all"><div class="inner"><span>all</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-all-arg"><div class="inner"><span>all-arg</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-all-arg-vec"><div class="inner"><span>all-arg-vec</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-all-vec"><div class="inner"><span>all-vec</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-by-val"><div class="inner"><span>by-val</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-by-val-arg"><div class="inner"><span>by-val-arg</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-by-val-arg-vec"><div class="inner"><span>by-val-arg-vec</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-by-val-vec"><div class="inner"><span>by-val-vec</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-default"><div class="inner"><span>default</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-default-val"><div class="inner"><span>default-val</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-generate-arg-sample"><div class="inner"><span>generate-arg-sample</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-generate-arg-sample-val"><div class="inner"><span>generate-arg-sample-val</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-generate-sample"><div class="inner"><span>generate-sample</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-generate-sample-val"><div class="inner"><span>generate-sample-val</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-non-geo"><div class="inner"><span>non-geo</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-non-geo-val"><div class="inner"><span>non-geo-val</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-normalize"><div class="inner"><span>normalize</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-normalize-arg"><div class="inner"><span>normalize-arg</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-parse"><div class="inner"><span>parse</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-valid-arg.3F"><div class="inner"><span>valid-arg?</span></div></a></li><li class="depth-1"><a href="phone-number.region.html#var-valid.3F"><div class="inner"><span>valid?</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">phone-number.region</h1><h4 class="added">added in 8.12.4-0</h4><div class="doc"><div class="markdown"><p>Region handling for phone-number.</p>
</div></div><div class="public anchor" id="var-all"><h3>all</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Mapping of supported regions (keywords) to region values (strings).</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L42">view source</a></div></div><div class="public anchor" id="var-all-arg"><h3>all-arg</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Mapping of supported regions (keywords) to region values (strings) suitable to be used as arguments.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L31">view source</a></div></div><div class="public anchor" id="var-all-arg-vec"><h3>all-arg-vec</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Vector of regions (keywords).</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L76">view source</a></div></div><div class="public anchor" id="var-all-vec"><h3>all-vec</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Vector of regions (keywords).</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L70">view source</a></div></div><div class="public anchor" id="var-by-val"><h3>by-val</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Mapping of supported region values (strings) to regions (keywords).</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L48">view source</a></div></div><div class="public anchor" id="var-by-val-arg"><h3>by-val-arg</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Mapping of supported region values (strings) to regions (keywords).</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L54">view source</a></div></div><div class="public anchor" id="var-by-val-arg-vec"><h3>by-val-arg-vec</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Vector of regions (string values).</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L88">view source</a></div></div><div class="public anchor" id="var-by-val-vec"><h3>by-val-vec</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Vector of regions (string values).</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L82">view source</a></div></div><div class="public anchor" id="var-default"><h3>default</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L60">view source</a></div></div><div class="public anchor" id="var-default-val"><h3>default-val</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L65">view source</a></div></div><div class="public anchor" id="var-generate-arg-sample"><h3>generate-arg-sample</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"><code>(generate-arg-sample)</code><code>(generate-arg-sample rng)</code></div><div class="doc"><div class="markdown"><p>Generates random region code.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L164">view source</a></div></div><div class="public anchor" id="var-generate-arg-sample-val"><h3>generate-arg-sample-val</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"><code>(generate-arg-sample-val)</code><code>(generate-arg-sample-val rng)</code></div><div class="doc"><div class="markdown"><p>Generates random region code (string value).</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L170">view source</a></div></div><div class="public anchor" id="var-generate-sample"><h3>generate-sample</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"><code>(generate-sample)</code><code>(generate-sample rng)</code></div><div class="doc"><div class="markdown"><p>Generates random region code.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L152">view source</a></div></div><div class="public anchor" id="var-generate-sample-val"><h3>generate-sample-val</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"><code>(generate-sample-val)</code><code>(generate-sample-val rng)</code></div><div class="doc"><div class="markdown"><p>Generates random region code (string value).</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L158">view source</a></div></div><div class="public anchor" id="var-non-geo"><h3>non-geo</h3><h4 class="added">added in 8.12.16-1</h4><div class="usage"></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L21">view source</a></div></div><div class="public anchor" id="var-non-geo-val"><h3>non-geo-val</h3><h4 class="added">added in 8.12.16-1</h4><div class="usage"></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L26">view source</a></div></div><div class="public anchor" id="var-normalize"><h3>normalize</h3><h4 class="added">added in 8.12.16-1</h4><div class="usage"><code>(normalize k)</code><code>(normalize k use-infer)</code></div><div class="doc"><div class="markdown"><p>Parses a region code and returns its normalized version.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L140">view source</a></div></div><div class="public anchor" id="var-normalize-arg"><h3>normalize-arg</h3><h4 class="added">added in 8.12.16-1</h4><div class="usage"><code>(normalize-arg k)</code><code>(normalize-arg k use-infer)</code></div><div class="doc"><div class="markdown"><p>Parses a region code and returns its normalized version that can be used as an argument.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L127">view source</a></div></div><div class="public anchor" id="var-parse"><h3>parse</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"><code>(parse k)</code><code>(parse k use-infer)</code></div><div class="doc"><div class="markdown"><p>Parses a region code and returns a value that can be supplied to Libphonenumber methods.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L114">view source</a></div></div><div class="public anchor" id="var-valid-arg.3F"><h3>valid-arg?</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"><code>(valid-arg? region-specification)</code><code>(valid-arg? region-specification use-infer)</code></div><div class="doc"><div class="markdown"><p>Returns <code>true</code> if the given region-specification is a valid region code, <code>false</code> otherwise. In its binary form it uses namespace inference.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L104">view source</a></div></div><div class="public anchor" id="var-valid.3F"><h3>valid?</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"><code>(valid? region-specification)</code><code>(valid? region-specification use-infer)</code></div><div class="doc"><div class="markdown"><p>Returns <code>true</code> if the given region-specification is a valid region code, <code>false</code> otherwise. In its binary form it uses namespace inference.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/region.clj#L94">view source</a></div></div></div></body></html>