-
Notifications
You must be signed in to change notification settings - Fork 0
/
phone-number.format.html
25 lines (25 loc) · 18.2 KB
/
phone-number.format.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>phone-number.format 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 current"><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"><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.format.html#var-all"><div class="inner"><span>all</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-all-arg"><div class="inner"><span>all-arg</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-all-arg-vec"><div class="inner"><span>all-arg-vec</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-all-vec"><div class="inner"><span>all-vec</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-by-val"><div class="inner"><span>by-val</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-by-val-arg"><div class="inner"><span>by-val-arg</span></div></a></li><li class="depth-1"><a href="phone-number.format.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.format.html#var-by-val-vec"><div class="inner"><span>by-val-vec</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-calling-coded"><div class="inner"><span>calling-coded</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-calling-coded.3F"><div class="inner"><span>calling-coded?</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-default"><div class="inner"><span>default</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-default-val"><div class="inner"><span>default-val</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-global"><div class="inner"><span>global</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-global-vec"><div class="inner"><span>global-vec</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-global.3F"><div class="inner"><span>global?</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-not-calling-coded"><div class="inner"><span>not-calling-coded</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-not-calling-coded.3F"><div class="inner"><span>not-calling-coded?</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-parse"><div class="inner"><span>parse</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-raw"><div class="inner"><span>raw</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-raw-val"><div class="inner"><span>raw-val</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-regional"><div class="inner"><span>regional</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-regional-vec"><div class="inner"><span>regional-vec</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-regional.3F"><div class="inner"><span>regional?</span></div></a></li><li class="depth-1"><a href="phone-number.format.html#var-valid-arg.3F"><div class="inner"><span>valid-arg?</span></div></a></li><li class="depth-1"><a href="phone-number.format.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.format</h1><h4 class="added">added in 8.12.4-0</h4><div class="doc"><div class="markdown"><p>Phone number formats 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>Map of possible format identifiers (keywords) to PhoneNumberFormat values plus an additional value indicating raw input.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/format.clj#L16">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 possible format identifiers (keywords) to PhoneNumberFormat values (plus an additional value indicating raw input) 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/format.clj#L46">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 formats (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/format.clj#L73">view source</a></div></div><div class="public anchor" id="var-all-vec"><h3>all-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 formats (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/format.clj#L67">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>Map of possible PhoneNumberFormat values (plus an additional value indicating raw input) to format identifiers (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/format.clj#L53">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 possible PhoneNumberFormat values to format identifiers (keywords) suitable to be used as arguments for methods of Libphonenumber.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/format.clj#L60">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 formats (PhoneNumberFormat 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/format.clj#L86">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 formats (PhoneNumberFormat values + additional value indicating raw format as keyword).</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/format.clj#L79">view source</a></div></div><div class="public anchor" id="var-calling-coded"><h3>calling-coded</h3><h4 class="added">added in 8.12.4-0</h4><h4 class="deprecated">deprecated in 8.12.4-1</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>DEPRECATED: use <code>global</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/format.clj#L171">view source</a></div></div><div class="public anchor" id="var-calling-coded.3F"><h3>calling-coded?</h3><h4 class="added">added in 8.12.4-0</h4><h4 class="deprecated">deprecated in 8.12.4-1</h4><div class="usage"><code>(calling-coded? format)</code></div><div class="doc"><div class="markdown"><p>DEPRECATED: use <code>global?</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/format.clj#L178">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/format.clj#L37">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/format.clj#L42">view source</a></div></div><div class="public anchor" id="var-global"><h3>global</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Set of formats (keywords) that should identify values containing country code information.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/format.clj#L92">view source</a></div></div><div class="public anchor" id="var-global-vec"><h3>global-vec</h3><h4 class="added">added in 8.12.4-1</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Vector of formats (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/format.clj#L104">view source</a></div></div><div class="public anchor" id="var-global.3F"><h3>global?</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"><code>(global? format)</code><code>(global? format use-infer)</code></div><div class="doc"><div class="markdown"><p>Returns true if the given format contains country code information, false otherwise.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/format.clj#L148">view source</a></div></div><div class="public anchor" id="var-not-calling-coded"><h3>not-calling-coded</h3><h4 class="added">added in 8.12.4-0</h4><h4 class="deprecated">deprecated in 8.12.4-1</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>DEPRECATED: use <code>regional</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/format.clj#L186">view source</a></div></div><div class="public anchor" id="var-not-calling-coded.3F"><h3>not-calling-coded?</h3><h4 class="added">added in 8.12.4-0</h4><h4 class="deprecated">deprecated in 8.12.4-1</h4><div class="usage"><code>(not-calling-coded? format)</code></div><div class="doc"><div class="markdown"><p>DEPRECATED: use <code>regional?</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/format.clj#L193">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 format specification 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/format.clj#L134">view source</a></div></div><div class="public anchor" id="var-raw"><h3>raw</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/format.clj#L27">view source</a></div></div><div class="public anchor" id="var-raw-val"><h3>raw-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/format.clj#L32">view source</a></div></div><div class="public anchor" id="var-regional"><h3>regional</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Set of formats (keywords) that should identify values containing country code information.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/format.clj#L98">view source</a></div></div><div class="public anchor" id="var-regional-vec"><h3>regional-vec</h3><h4 class="added">added in 8.12.4-1</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Vector of formats (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/format.clj#L110">view source</a></div></div><div class="public anchor" id="var-regional.3F"><h3>regional?</h3><h4 class="added">added in 8.12.4-0</h4><div class="usage"><code>(regional? format)</code><code>(regional? format use-infer)</code></div><div class="doc"><div class="markdown"><p>Returns true if the given format does not contain country code information, false otherwise.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/format.clj#L157">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? format)</code><code>(valid-arg? format use-infer)</code></div><div class="doc"><div class="markdown"><p>Returns true if the given format is valid, false otherwise.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/format.clj#L125">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? format)</code><code>(valid? format use-infer)</code></div><div class="doc"><div class="markdown"><p>Returns true if the given format is valid, false otherwise.</p>
</div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/tree/8.13.6-3/src/phone_number/format.clj#L116">view source</a></div></div></div></body></html>