-
Notifications
You must be signed in to change notification settings - Fork 0
/
phone-number.spec.html
3 lines (3 loc) · 9.86 KB
/
phone-number.spec.html
1
2
3
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>phone-number.spec 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.12.4-0</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="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"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>phone-number</span></div></div></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.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.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 current"><a href="phone-number.spec.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>spec</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.spec.html#var-begins-with-plus.3F"><div class="inner"><span>begins-with-plus?</span></div></a></li><li class="depth-1"><a href="phone-number.spec.html#var-info-keys"><div class="inner"><span>info-keys</span></div></a></li><li class="depth-1"><a href="phone-number.spec.html#var-not-begins-with-plus.3F"><div class="inner"><span>not-begins-with-plus?</span></div></a></li><li class="depth-1"><a href="phone-number.spec.html#var-phone-gen"><div class="inner"><span>phone-gen</span></div></a></li><li class="depth-1"><a href="phone-number.spec.html#var-phone-spec"><div class="inner"><span>phone-spec</span></div></a></li><li class="depth-1"><a href="phone-number.spec.html#var-random-format"><div class="inner"><span>random-format</span></div></a></li><li class="depth-1"><a href="phone-number.spec.html#var-random-format-global"><div class="inner"><span>random-format-global</span></div></a></li><li class="depth-1"><a href="phone-number.spec.html#var-random-format-regional"><div class="inner"><span>random-format-regional</span></div></a></li><li class="depth-1"><a href="phone-number.spec.html#var-random-region-code"><div class="inner"><span>random-region-code</span></div></a></li><li class="depth-1"><a href="phone-number.spec.html#var-random-region-code-arg"><div class="inner"><span>random-region-code-arg</span></div></a></li><li class="depth-1"><a href="phone-number.spec.html#var-short-info-keys"><div class="inner"><span>short-info-keys</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">phone-number.spec</h1><h4 class="added">added in 8.12.4-0</h4><div class="doc"><div class="markdown"><p>Public specs of phone-number library.</p></div></div><div class="public anchor" id="var-begins-with-plus.3F"><h3>begins-with-plus?</h3><h4 class="added">added in 8.12.4-1</h4><div class="usage"><code>(begins-with-plus? s)</code></div><div class="doc"><div class="markdown"><p>Helper that returns true if a string has the + character before any digit.</p></div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/blob/8.12.4-0/src/phone_number/spec.clj#L230">view source</a></div></div><div class="public anchor" id="var-info-keys"><h3>info-keys</h3><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/blob/8.12.4-0/src/phone_number/spec.clj#L387">view source</a></div></div><div class="public anchor" id="var-not-begins-with-plus.3F"><h3>not-begins-with-plus?</h3><h4 class="added">added in 8.12.4-1</h4><div class="usage"><code>(not-begins-with-plus? s)</code></div><div class="doc"><div class="markdown"><p>Complementary to begins-with-plus?</p></div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/blob/8.12.4-0/src/phone_number/spec.clj#L241">view source</a></div></div><div class="public anchor" id="var-phone-gen"><h3>phone-gen</h3><h4 class="added">added in 8.12.4-1</h4><div class="usage"><code>(phone-gen options)</code></div><div class="doc"><div class="markdown"><p>Phone number generator for specs. Options map: :region, :type, :predicate, :retries, :min-digits, :locale, :random-seed, :early-shrinking :preserve-raw</p></div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/blob/8.12.4-0/src/phone_number/spec.clj#L161">view source</a></div></div><div class="public anchor" id="var-phone-spec"><h3>phone-spec</h3><h4 class="type">macro</h4><div class="usage"><code>(phone-spec f)</code><code>(phone-spec f options)</code></div><div class="doc"><div class="markdown"><p>Template macro for constructing specs with generators for the given predicate. It uses the generate function from phone-number.core to support generation of samples that are meeting the criteria.</p></div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/blob/8.12.4-0/src/phone_number/spec.clj#L292">view source</a></div></div><div class="public anchor" id="var-random-format"><h3>random-format</h3><div class="usage"><code>(random-format n)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/blob/8.12.4-0/src/phone_number/spec.clj#L87">view source</a></div></div><div class="public anchor" id="var-random-format-global"><h3>random-format-global</h3><div class="usage"><code>(random-format-global n)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/blob/8.12.4-0/src/phone_number/spec.clj#L91">view source</a></div></div><div class="public anchor" id="var-random-format-regional"><h3>random-format-regional</h3><div class="usage"><code>(random-format-regional n)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/blob/8.12.4-0/src/phone_number/spec.clj#L95">view source</a></div></div><div class="public anchor" id="var-random-region-code"><h3>random-region-code</h3><div class="usage"><code>(random-region-code)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/blob/8.12.4-0/src/phone_number/spec.clj#L42">view source</a></div></div><div class="public anchor" id="var-random-region-code-arg"><h3>random-region-code-arg</h3><div class="usage"><code>(random-region-code-arg)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/randomseed-io/phone-number/blob/8.12.4-0/src/phone_number/spec.clj#L46">view source</a></div></div><div class="public anchor" id="var-short-info-keys"><h3>short-info-keys</h3><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/blob/8.12.4-0/src/phone_number/spec.clj#L376">view source</a></div></div></div></body></html>