-
Notifications
You must be signed in to change notification settings - Fork 0
/
phone-number.locale.html
20 lines (20 loc) · 16.4 KB
/
phone-number.locale.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>phone-number.locale 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 current"><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"><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.locale.html#var-all"><div class="inner"><span>all</span></div></a></li><li class="depth-1"><a href="phone-number.locale.html#var-all-arg"><div class="inner"><span>all-arg</span></div></a></li><li class="depth-1"><a href="phone-number.locale.html#var-all-arg-vec"><div class="inner"><span>all-arg-vec</span></div></a></li><li class="depth-1"><a href="phone-number.locale.html#var-all-vec"><div class="inner"><span>all-vec</span></div></a></li><li class="depth-1"><a href="phone-number.locale.html#var-available"><div class="inner"><span>available</span></div></a></li><li class="depth-1"><a href="phone-number.locale.html#var-by-val"><div class="inner"><span>by-val</span></div></a></li><li class="depth-1"><a href="phone-number.locale.html#var-by-val-arg"><div class="inner"><span>by-val-arg</span></div></a></li><li class="depth-1"><a href="phone-number.locale.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.locale.html#var-by-val-vec"><div class="inner"><span>by-val-vec</span></div></a></li><li class="depth-1"><a href="phone-number.locale.html#var-default"><div class="inner"><span>default</span></div></a></li><li class="depth-1"><a href="phone-number.locale.html#var-default-val"><div class="inner"><span>default-val</span></div></a></li><li class="depth-1"><a href="phone-number.locale.html#var-generate-sample"><div class="inner"><span>generate-sample</span></div></a></li><li class="depth-1"><a href="phone-number.locale.html#var-generate-sample-val"><div class="inner"><span>generate-sample-val</span></div></a></li><li class="depth-1"><a href="phone-number.locale.html#var-parse"><div class="inner"><span>parse</span></div></a></li><li class="depth-1"><a href="phone-number.locale.html#var-strictly-valid-arg.3F"><div class="inner"><span>strictly-valid-arg?</span></div></a></li><li class="depth-1"><a href="phone-number.locale.html#var-strictly-valid.3F"><div class="inner"><span>strictly-valid?</span></div></a></li><li class="depth-1"><a href="phone-number.locale.html#var-valid-arg.3F"><div class="inner"><span>valid-arg?</span></div></a></li><li class="depth-1"><a href="phone-number.locale.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.locale</h1><h4 class="added">added in 8.12.4-3</h4><div class="doc"><div class="markdown"><p>Locale support for phone-number</p>
</div></div><div class="public anchor" id="var-all"><h3>all</h3><h4 class="added">added in 8.12.4-3</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Map of locales (keywords) to Locale 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/locale.clj#L25">view source</a></div></div><div class="public anchor" id="var-all-arg"><h3>all-arg</h3><h4 class="added">added in 8.12.16-1</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Map of locales (keywords) to Locale values suitable to be passed 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/locale.clj#L38">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.16-1</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Vector of locales (keywords) 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/locale.clj#L70">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-3</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Vector of locales (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/locale.clj#L64">view source</a></div></div><div class="public anchor" id="var-available"><h3>available</h3><h4 class="added">added in 8.12.4-3</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Set of available locale (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/locale.clj#L58">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-3</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Map of Locale values to locales (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/locale.clj#L44">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.16-1</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Map of Locale values to locales (keywords) suitable to be passed as method 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/locale.clj#L50">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.16-1</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Vector of locales (Locale values) suitable to be used as method 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/locale.clj#L82">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-3</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Vector of locales (Locale 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/locale.clj#L76">view source</a></div></div><div class="public anchor" id="var-default"><h3>default</h3><h4 class="added">added in 8.12.4-3</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/locale.clj#L16">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-3</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/locale.clj#L21">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-3</h4><div class="usage"><code>(generate-sample)</code><code>(generate-sample rng)</code></div><div class="doc"><div class="markdown"><p>Generates random locale.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/locale.clj#L172">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-3</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 locale (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/locale.clj#L178">view source</a></div></div><div class="public anchor" id="var-parse"><h3>parse</h3><h4 class="added">added in 8.12.4-3</h4><div class="usage"><code>(parse locale-specification)</code><code>(parse locale-specification use-infer)</code></div><div class="doc"><div class="markdown"><p>Parses locale. If it is a <code>java.util.Locale</code> object it returns it. If it’s not keyword then it parses it by calling <code>trptr.java-wrapper.locale/locale</code>. If it is a keyword it first tries to infer a namespace (if not present and the <code>use-infer</code> is set to some truthy value) and then looks it up in locales map. If the value is found, returns the associated <code>Locale</code> object. Otherwise it falls back to getting locale using the function from <code>trptr.java-wrapper.locale/locale</code> (before doing so it strips any namespace from a keyword, if found).</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/locale.clj#L153">view source</a></div></div><div class="public anchor" id="var-strictly-valid-arg.3F"><h3>strictly-valid-arg?</h3><h4 class="added">added in 8.12.4-3</h4><div class="usage"><code>(strictly-valid-arg? locale-specification)</code><code>(strictly-valid-arg? locale-specification use-infer)</code></div><div class="doc"><div class="markdown"><p>Returns <code>true</code> if the given locale specification is valid and supported, <code>false</code> otherwise. For <code>nil</code> it returns <code>false</code> and for keywords it only checks if they are in the locale map (<code>phone-number.locale/all</code>). If the key is not there, it returns <code>false</code>. Namespace inference is supported using the second argument (the default is not to infer).</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/locale.clj#L114">view source</a></div></div><div class="public anchor" id="var-strictly-valid.3F"><h3>strictly-valid?</h3><h4 class="added">added in 8.12.16-1</h4><div class="usage"><code>(strictly-valid? locale-specification)</code><code>(strictly-valid? locale-specification use-infer)</code></div><div class="doc"><div class="markdown"><p>Returns <code>true</code> if the given locale specification is valid and supported, <code>false</code> otherwise. For <code>nil</code> it returns <code>false</code> and for keywords it only checks if they are in the locale map (<code>phone-number.locale/all</code>). If the key is not there, it returns <code>false</code>. Namespace inference is supported using the second argument (the default is not to infer).</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/locale.clj#L141">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-3</h4><div class="usage"><code>(valid-arg? locale-specification)</code><code>(valid-arg? locale-specification use-infer)</code><code>(valid-arg? locale-specification use-infer strict)</code></div><div class="doc"><div class="markdown"><p>Returns <code>true</code> if the given locale specification is valid and supported, <code>false</code> otherwise. For <code>nil</code> it returns <code>true</code> assuming it will be a default, system locale. If <code>strict</code> flag is set then for nil value it returns <code>false</code> and for keywords it only checks if they are in the locale map (<code>phone-number.locale/all</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/locale.clj#L88">view source</a></div></div><div class="public anchor" id="var-valid.3F"><h3>valid?</h3><h4 class="added">added in 8.12.16-1</h4><div class="usage"><code>(valid? locale-specification)</code><code>(valid? locale-specification use-infer)</code><code>(valid? locale-specification use-infer strict)</code></div><div class="doc"><div class="markdown"><p>Returns <code>true</code> if the given locale specification is valid and supported, <code>false</code> otherwise. For <code>nil</code> it returns <code>true</code> assuming it will be a default, system locale. If <code>strict</code> flag is set then for nil value it returns <code>false</code> and for keywords it only checks if they are in the locale map (<code>phone-number.locale/all</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/locale.clj#L127">view source</a></div></div></div></body></html>