From 5bacecac29b165058404e2e6ae427856411dde49 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Wilk?= Date: Fri, 24 Feb 2023 11:49:03 +0100 Subject: [PATCH] Documentation updated --- doc/10_introduction.md | 4 +- docs/10_introduction.html | 6 +- docs/30_specs.html | 2 +- docs/40_development.html | 2 +- docs/index.html | 4 +- docs/phone-number.calling-code.html | 32 +++--- docs/phone-number.core.html | 163 ++++++++++++++-------------- docs/phone-number.cost.html | 28 ++--- docs/phone-number.country-code.html | 32 +++--- docs/phone-number.db.html | 98 ++++++++--------- docs/phone-number.format.html | 44 ++++---- docs/phone-number.html | 2 +- docs/phone-number.leniency.html | 32 +++--- docs/phone-number.locale.html | 34 +++--- docs/phone-number.match.html | 12 +- docs/phone-number.net-code.html | 32 +++--- docs/phone-number.region.html | 36 +++--- docs/phone-number.type.html | 32 +++--- docs/phone-number.tz-format.html | 26 ++--- docs/phone-number.util.html | 48 ++++---- 20 files changed, 335 insertions(+), 334 deletions(-) diff --git a/doc/10_introduction.md b/doc/10_introduction.md index 37215cd..c8c00f9 100644 --- a/doc/10_introduction.md +++ b/doc/10_introduction.md @@ -10,14 +10,14 @@ To use phone-number in your project, add the following to dependencies section o `project.clj` or `build.boot`: ```clojure -[io.randomseed/phone-number "8.13.6-1"] +[io.randomseed/phone-number "8.13.6-2"] ``` For `deps.edn` add the following as an element of a map under `:deps` or `:extra-deps` key: ```clojure -io.randomseed/phone-number {:mvn/version "8.13.6-1"} +io.randomseed/phone-number {:mvn/version "8.13.6-2"} ``` You can also download JAR from diff --git a/docs/10_introduction.html b/docs/10_introduction.html index a635a89..77dc8bd 100644 --- a/docs/10_introduction.html +++ b/docs/10_introduction.html @@ -1,13 +1,13 @@ -Introduction

Introduction

+Introduction

Introduction

The phone-number library is an interface to the Libphonenumber with some extra sugar. It allows to validate, inspect and generate phone numbers.

Installation

To use phone-number in your project, add the following to dependencies section of project.clj or build.boot:

-
[io.randomseed/phone-number "8.13.6-1"]
+
[io.randomseed/phone-number "8.13.6-2"]
 

For deps.edn add the following as an element of a map under :deps or :extra-deps key:

-
io.randomseed/phone-number {:mvn/version "8.13.6-1"}
+
io.randomseed/phone-number {:mvn/version "8.13.6-2"}
 

You can also download JAR from Clojars.

Additionally you can use (in your development profile) if you want to utilize specs and spec-integrated generators provided by the phone-number:

diff --git a/docs/30_specs.html b/docs/30_specs.html index fb0a75b..8e07b30 100644 --- a/docs/30_specs.html +++ b/docs/30_specs.html @@ -1,6 +1,6 @@ -Specs and checks

Specs and checks

+Specs and checks

Specs and checks

Predicates

The phone-number provides many predicate functions that can be used to check for certain properties of phone numbers. These include:

diff --git a/docs/40_development.html b/docs/40_development.html index 41dfa5e..7b42144 100644 --- a/docs/40_development.html +++ b/docs/40_development.html @@ -1,6 +1,6 @@ -Development

Development

+Development

Development

CircleCI

Source code

    diff --git a/docs/index.html b/docs/index.html index a6494c4..c8bbf9b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,9 +1,9 @@ -Phone-number 8.13.6-1

    Phone-number 8.13.6-1

    Generation, validation and inspection of phone numbers.

    Installation

    To install, add the following dependency to your project or build file:

    [io.randomseed/phone-number "8.13.6-1"]

    Topics

    Namespaces

    phone-number

    Clojure interface to Libphonenumber.

    +Phone-number 8.13.6-2

    Phone-number 8.13.6-2

    Generation, validation and inspection of phone numbers.

    Installation

    To install, add the following dependency to your project or build file:

    [io.randomseed/phone-number "8.13.6-2"]

    Topics

    Namespaces

    phone-number

    Clojure interface to Libphonenumber.

    Public variables and functions:

      phone-number.format

      Phone number formats for phone-number.

      diff --git a/docs/phone-number.calling-code.html b/docs/phone-number.calling-code.html index 859d801..7a2e1eb 100644 --- a/docs/phone-number.calling-code.html +++ b/docs/phone-number.calling-code.html @@ -1,19 +1,19 @@ -phone-number.calling-code documentation

      phone-number.calling-code

      added in 8.12.4-0

      Calling codes handling for phone-number.

      +phone-number.calling-code documentation

      phone-number.calling-code

      added in 8.12.4-0

      Calling codes handling for phone-number.

      all

      added in 8.12.4-0

      Set of supported calling codes.

      -

      all-arg

      added in 8.12.16-1

      Set of supported calling codes to be passed as arguments.

      -

      all-arg-vec

      added in 8.12.16-1

      Vector of all supported calling codes to be used as arguments.

      -

      all-vec

      added in 8.12.4-0

      Vector of all supported calling codes.

      -

      by-val

      added in 8.12.4-0

      Set of supported calling codes (values).

      -

      by-val-arg

      added in 8.12.16-1

      Set of supported calling codes (values) to be passed as arguments.

      -

      by-val-arg-vec

      added in 8.12.16-1

      Vector of all supported calling codes.

      -

      by-val-vec

      added in 8.12.4-0

      Vector of all supported calling codes.

      -

      generate-arg-sample

      added in 8.12.16-1

      (generate-arg-sample)(generate-arg-sample rng)

      Generates random calling code.

      -

      generate-arg-sample-val

      added in 8.12.16-1

      (generate-arg-sample-val)(generate-arg-sample-val rng)

      Generates random calling code.

      -

      generate-sample

      added in 8.12.4-0

      (generate-sample)(generate-sample rng)

      Generates a random calling code.

      -

      generate-sample-val

      added in 8.12.16-1

      (generate-sample-val)(generate-sample-val rng)

      Generates a random calling code.

      -

      parse

      added in 8.12.4-0

      (parse calling-code)

      Parses a calling code and returns a value that can be supplied to Libphonenumber methods.

      -

      valid-arg?

      added in 8.12.16-1

      (valid-arg? calling-code)

      Returns true if the given region-specification is a valid region code to be used as an argument, false otherwise.

      -

      valid?

      added in 8.12.4-0

      (valid? calling-code)

      Returns true if the given region-specification is a valid region code, false otherwise.

      -
      \ No newline at end of file +

      all-arg

      added in 8.12.16-1

      Set of supported calling codes to be passed as arguments.

      +

      all-arg-vec

      added in 8.12.16-1

      Vector of all supported calling codes to be used as arguments.

      +

      all-vec

      added in 8.12.4-0

      Vector of all supported calling codes.

      +

      by-val

      added in 8.12.4-0

      Set of supported calling codes (values).

      +

      by-val-arg

      added in 8.12.16-1

      Set of supported calling codes (values) to be passed as arguments.

      +

      by-val-arg-vec

      added in 8.12.16-1

      Vector of all supported calling codes.

      +

      by-val-vec

      added in 8.12.4-0

      Vector of all supported calling codes.

      +

      generate-arg-sample

      added in 8.12.16-1

      (generate-arg-sample)(generate-arg-sample rng)

      Generates random calling code.

      +

      generate-arg-sample-val

      added in 8.12.16-1

      (generate-arg-sample-val)(generate-arg-sample-val rng)

      Generates random calling code.

      +

      generate-sample

      added in 8.12.4-0

      (generate-sample)(generate-sample rng)

      Generates a random calling code.

      +

      generate-sample-val

      added in 8.12.16-1

      (generate-sample-val)(generate-sample-val rng)

      Generates a random calling code.

      +

      parse

      added in 8.12.4-0

      (parse calling-code)

      Parses a calling code and returns a value that can be supplied to Libphonenumber methods.

      +

      valid-arg?

      added in 8.12.16-1

      (valid-arg? calling-code)

      Returns true if the given region-specification is a valid region code to be used as an argument, false otherwise.

      +

      valid?

      added in 8.12.4-0

      (valid? calling-code)

      Returns true if the given region-specification is a valid region code, false otherwise.

      +
      \ No newline at end of file diff --git a/docs/phone-number.core.html b/docs/phone-number.core.html index e9e6cd9..226c577 100644 --- a/docs/phone-number.core.html +++ b/docs/phone-number.core.html @@ -1,29 +1,29 @@ -phone-number.core documentation

      phone-number.core

      added in 8.12.4-0

      Clojure interface to Libphonenumber.

      +phone-number.core documentation

      phone-number.core

      added in 8.12.4-0

      Clojure interface to Libphonenumber.

      *default-dialing-region*

      dynamic

      added in 8.12.4-1

      Sets a default dialing region (from where calls are originating) for functions that explicitly require dialing region code to be present (usually operating on short numbers). Default is nil.

      -

      *inferred-namespaces*

      dynamic

      added in 8.12.4-0

      Decides whether keywords which are not fully-qualified should be automatically qualified (by attaching default namespaces) when passed as arguments to functions that operate on phone number types, phone number formats, region codes and time zone formats. Defaults to true.

      -

      *info-dialing-region-derived*

      dynamic

      added in 8.12.4-1

      Decides whether some of the results of the info function should be calculated using dialing region code derived from the given region code if the dialing region was not passed as an argument nor obtained from the *default-dialing-region* dynamic variable. Default is true.

      -

      *info-removed-nils*

      dynamic

      added in 8.12.4-0

      Decides whether the results of the info function should contain properties having nil values. They are removed by default due to true value of this switch.

      -

      all-formats

      added in 8.12.4-0

      (all-formats phone-number)(all-formats phone-number region-code)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns a map which keys are all possible formats expressed as keywords and values are string representations of the number formatted accordingly.

      +

      *inferred-namespaces*

      dynamic

      added in 8.12.4-0

      Decides whether keywords which are not fully-qualified should be automatically qualified (by attaching default namespaces) when passed as arguments to functions that operate on phone number types, phone number formats, region codes and time zone formats. Defaults to true.

      +

      *info-dialing-region-derived*

      dynamic

      added in 8.12.4-1

      Decides whether some of the results of the info function should be calculated using dialing region code derived from the given region code if the dialing region was not passed as an argument nor obtained from the *default-dialing-region* dynamic variable. Default is true.

      +

      *info-removed-nils*

      dynamic

      added in 8.12.4-0

      Decides whether the results of the info function should contain properties having nil values. They are removed by default due to true value of this switch.

      +

      all-formats

      added in 8.12.4-0

      (all-formats phone-number)(all-formats phone-number region-code)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns a map which keys are all possible formats expressed as keywords and values are string representations of the number formatted accordingly.

      If the second argument is present then it should be a valid region code (a keyword) to be used when the given phone number does not contain region information.

      -

      allowed-input-characters

      added in 8.12.4-1

      A set of allowed characters in a phone number which is a string (applied to all characters except the first 3 on a string cleaned up from removable characters).

      -

      allowed-removable-characters

      added in 8.12.4-1

      A set of removable (like punctuation) characters in a phone number which is a string. Used during input validation.

      -

      calling-code

      added in 8.12.4-0

      (calling-code phone-number)(calling-code phone-number region-code)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns its calling code as an integer number.

      +

      allowed-input-characters

      added in 8.12.4-1

      deprecated in 8.13.6-2

      A set of allowed characters in a phone number which is a string (applied to all characters except the first 3 on a string cleaned up from removable characters).

      +

      allowed-removable-characters

      added in 8.12.4-1

      deprecated in 8.13.6-2

      A set of removable (like punctuation) characters in a phone number which is a string. Used during input validation.

      +

      calling-code

      added in 8.12.4-0

      (calling-code phone-number)(calling-code phone-number region-code)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns its calling code as an integer number.

      If the second argument is present then it should be a valid region code (a keyword) to be used when the given phone number does not contain region information.

      -

      calling-code-prefix

      added in 8.12.16-1

      (calling-code-prefix phone-number)(calling-code-prefix phone-number region-code)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns its calling code prefix (including a plus symbol) as a string.

      +

      calling-code-prefix

      added in 8.12.16-1

      (calling-code-prefix phone-number)(calling-code-prefix phone-number region-code)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns its calling code prefix (including a plus symbol) as a string.

      If the second argument is present then it should be a valid region code (a keyword) to be used when the given phone number does not contain region information.

      -

      calling-codes

      added in 8.12.4-0

      A set of all possible country calling codes.

      -

      calling-codes-for-region

      added in 8.12.16-1

      (calling-codes-for-region region-code)

      Returns a set of all calling codes (integer numbers) associated with the given region code (keyword) which may also be :phone-number.region/world pseudo-region.

      -

      carrier

      added in 8.12.4-0

      (carrier phone-number)(carrier phone-number region-code)(carrier phone-number locale-specification-FQ)(carrier phone-number region-code locale-specification)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns its possible carrier name as a string or nil if the carrier name happens to be empty.

      +

      calling-codes

      added in 8.12.4-0

      A set of all possible country calling codes.

      +

      calling-codes-for-region

      added in 8.12.16-1

      (calling-codes-for-region region-code)

      Returns a set of all calling codes (integer numbers) associated with the given region code (keyword) which may also be :phone-number.region/world pseudo-region.

      +

      carrier

      added in 8.12.4-0

      (carrier phone-number)(carrier phone-number region-code)(carrier phone-number locale-specification-FQ)(carrier phone-number region-code locale-specification)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns its possible carrier name as a string or nil if the carrier name happens to be empty.

      If the second argument is present then it may be a valid region code (a keyword) to be used when the given phone number does not contain region information. It is acceptable to pass nil as a value to tell the function that there is no explicit region information and it should extract it from a number.

      If the third argument is present then it should be a string specifying locale information or a java.util.Locale object. It will be used during rendering carrier name. When nil is passed then the default locale settings will be used.

      If there are 2 arguments and the second argument is a keyword but IS NOT a fully-qualified, valid locale specification (locale-specification-FQ having namespace set to phone-number.locale) then it will be treated as a region code. Using namespaced keyword for a locale (or using object other than keyword) is required to avoid ambiguity since simple region codes and locale specs can be expressed using the very same keyword names. Optionally (but a bad habit) you may use simple keyword with locale and variant (e.g. :pl_PL) that will not match any region but match locale object.

      -

      costs

      added in 8.12.4-0

      A set of all possible phone number cost classes as a set of keywords.

      -

      country-codes

      added in 8.12.4-0

      A set of all possible country calling codes.

      -

      example

      added in 8.12.4-0

      (example region-code)(example region-code number-type)

      For the given region code and optional number type returns an example phone number that is valid (being a PhoneNumber kind of object). This is not a random number generator; it will always generate the same example number for the same arguments.

      -

      example-non-geo

      added in 8.12.4-0

      (example-non-geo calling-code _)(example-non-geo calling-code)

      For the given network global calling code (given as a positive, natural number) returns the example phone number that is valid (being a PhoneNumber kind of object). This is not a random number generator; it will always generate the same example number for the same arguments.

      -

      find-numbers

      added in 8.12.4-0

      (find-numbers text)(find-numbers text region-code)(find-numbers text leniency)(find-numbers text region-code leniency)(find-numbers text region-code locale-specification)(find-numbers text region-code max-tries)(find-numbers text leniency max-tries)(find-numbers text leniency locale-specification)(find-numbers text region-code leniency max-tries)(find-numbers text region-code locale-specification dialing-region)(find-numbers text region-code leniency max-tries locale-specification)(find-numbers text region-code leniency max-tries dialing-region-FQ)(find-numbers text region-code leniency max-tries locale-specification dialing-region)

      Searches for phone numbers in the given text. Returns a lazy sequence of maps where each element is a map representing a match and having the following keys:

      +

      costs

      added in 8.12.4-0

      A set of all possible phone number cost classes as a set of keywords.

      +

      country-codes

      added in 8.12.4-0

      A set of all possible country calling codes.

      +

      example

      added in 8.12.4-0

      (example region-code)(example region-code number-type)

      For the given region code and optional number type returns an example phone number that is valid (being a PhoneNumber kind of object). This is not a random number generator; it will always generate the same example number for the same arguments.

      +

      example-non-geo

      added in 8.12.4-0

      (example-non-geo calling-code _)(example-non-geo calling-code)

      For the given network global calling code (given as a positive, natural number) returns the example phone number that is valid (being a PhoneNumber kind of object). This is not a random number generator; it will always generate the same example number for the same arguments.

      +

      find-numbers

      added in 8.12.4-0

      (find-numbers text)(find-numbers text region-code)(find-numbers text leniency)(find-numbers text region-code leniency)(find-numbers text region-code locale-specification)(find-numbers text region-code max-tries)(find-numbers text leniency max-tries)(find-numbers text leniency locale-specification)(find-numbers text region-code leniency max-tries)(find-numbers text region-code locale-specification dialing-region)(find-numbers text region-code leniency max-tries locale-specification)(find-numbers text region-code leniency max-tries dialing-region-FQ)(find-numbers text region-code leniency max-tries locale-specification dialing-region)

      Searches for phone numbers in the given text. Returns a lazy sequence of maps where each element is a map representing a match and having the following keys:

      • :phone-number.match/start - start index of a phone number substring
      • :phone-number.match/end - end index of a phone number substring
      • @@ -54,11 +54,11 @@

        All keyword arguments except locale-specification (which can also be of other type) are namespace inferred if *inferred-namespace* dynamic variable is set in the calling context.

        Some arities can have different variants (depending on the given arguments). It’s possible to detect when keywords describing different things are not conflicting. The exception is when we have two final arguments which cannot be easily distinguished without namespacing since they may have overlapping values (like :pl as a dialing region and :pl as a locale specification). To use shortened arity with them and allow function to properly detect what kind of data it’s dealing with, please use fully-qualified keywords to describe a dialing region. Keyword without a proper namespace will be treated as locale specification on this argument position.

        For the sake of efficiency it is possible to entirely disable generation of a map under the :phone-number/info key. To do that just use arity with locale-specification and set the value of this argument to false. For argument values that you wish to be kept as default, use nil.

        -

      format

      added in 8.12.4-0

      (format phone-number)(format phone-number region-code)(format phone-number format-specification)(format phone-number region-code format-specification)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns it as a formatted string. The last argument should be a format expressed as a keyword (use the all-formats function to list them) or a PhoneNumberType.

      +

      format

      added in 8.12.4-0

      (format phone-number)(format phone-number region-code)(format phone-number format-specification)(format phone-number region-code format-specification)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns it as a formatted string. The last argument should be a format expressed as a keyword (use the all-formats function to list them) or a PhoneNumberType.

      If the second argument is present (and there are 3 arguments) then it should be a valid region code (a keyword) to be used when the given phone number does not contain region information.

      If there are 2 arguments and the second argument is a valid format specification it will be used without setting the region. If the format specification doesn’t look like a valid format then it will be assumed it is a region code and format will be set to a default.

      -

      formats

      added in 8.12.4-0

      A set of all possible phone number formats as a set of keywords.

      -

      generate

      added in 8.12.4-0

      (generate)(generate region-code)(generate region-code number-type)(generate region-code number-type predicate)(generate region-code number-type predicate retries)(generate region-code number-type predicate retries min-digits)(generate region-code number-type predicate retries min-digits locale-specification)(generate region-code number-type predicate retries min-digits locale-specification random-seed)(generate region-code number-type predicate retries min-digits locale-specification random-seed early-shrinking)(generate region-code number-type predicate retries min-digits locale-specification random-seed early-shrinking preserve-raw)

      Generates random phone number in a form of a map with the following keys:

      +

      formats

      added in 8.12.4-0

      A set of all possible phone number formats as a set of keywords.

      +

      generate

      added in 8.12.4-0

      (generate)(generate region-code)(generate region-code number-type)(generate region-code number-type predicate)(generate region-code number-type predicate retries)(generate region-code number-type predicate retries min-digits)(generate region-code number-type predicate retries min-digits locale-specification)(generate region-code number-type predicate retries min-digits locale-specification random-seed)(generate region-code number-type predicate retries min-digits locale-specification random-seed early-shrinking)(generate region-code number-type predicate retries min-digits locale-specification random-seed early-shrinking preserve-raw)

      Generates random phone number in a form of a map with the following keys:

      • :phone-number/number - a PhoneNumber object
      • :phone-number/info - a map with phone number information (evaluated on access)
      • @@ -80,16 +80,16 @@

        The seventh argument should be a long value that will seed the pseudo-random number generator used to produce digits and to choose region and/or phone number type when not given. It can be used to create a deterministic sequence of samples.

        The eight, optional argument enables more aggressive shrinking of randomly generated part. If it is set to a truthy value (not nil and not false) then each sampling step that involves generation of random digits will have 50% chances of producing less digits than required (at least 1 digit remaining). The number of digits is chosen randomly. It is advised to enable shrinking when expecting highly improbable phone numbers, for instance with the impossible? predicate.

        The last, optional argument chooses whether raw input should be preserved within the PhoneNumber objects when generating samples. By default it is not preserved.

        -

      geographical?

      added in 8.12.4-0

      (geographical? phone-number)(geographical? phone-number region-code)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns true if it is a geographical number as defined by Libphonenumber. Otherwise it returns false. If the second argument is present then it should be a valid region code (a keyword) to be used when the given phone number does not contain region information.

      -

      has-calling-code?

      added in 8.12.4-0

      (has-calling-code? phone-number)(has-calling-code? phone-number region-code)

      For the given phone number returns true if the calling code is present in it, false otherwise. The region code can be explicit part of a number (as its prefix) or can be inferred by making use of the region-code argument.

      +

      geographical?

      added in 8.12.4-0

      (geographical? phone-number)(geographical? phone-number region-code)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns true if it is a geographical number as defined by Libphonenumber. Otherwise it returns false. If the second argument is present then it should be a valid region code (a keyword) to be used when the given phone number does not contain region information.

      +

      has-calling-code?

      added in 8.12.4-0

      (has-calling-code? phone-number)(has-calling-code? phone-number region-code)

      For the given phone number returns true if the calling code is present in it, false otherwise. The region code can be explicit part of a number (as its prefix) or can be inferred by making use of the region-code argument.

      This function will always return true if a phone number was successfully parsed.

      -

      has-known-type?

      added in 8.12.4-0

      (has-known-type? phone-number)(has-known-type? phone-number region-code)

      Returns true if the given number is of a known type, false otherwise.

      -

      has-location?

      added in 8.12.4-0

      (has-location? phone-number)(has-location? phone-number region-code)

      For the given phone number returns true if the approximate geographic location is present in it, false otherwise.

      -

      has-raw-input?

      added in 8.12.4-1

      (has-raw-input? phone-number)(has-raw-input? phone-number region-code)

      Checks whether raw input string can be obtained from the given phone number.

      -

      has-region?

      added in 8.12.4-0

      (has-region? phone-number)(has-region? phone-number region-code)

      For the given phone number returns true if the region code is present in it, false otherwise. The region code can be explicit part of a number (as its prefix) or can be inferred by making use of the region-code argument.

      -

      has-time-zone?

      added in 8.12.4-0

      (has-time-zone? phone-number)(has-time-zone? phone-number region-code)

      For the given phone number returns true if any time zone information is present in it, false otherwise.

      -

      impossible?

      added in 8.12.4-0

      (impossible? phone-number)(impossible? phone-number region-code)

      Returns true if the given phone number (expressed as a string, a number, a map or a PhoneNumber object) is not possible.

      -

      info

      added in 8.12.4-0

      (info phone-number)(info phone-number region-code)(info phone-number locale-specification-FQ)(info phone-number region-code locale-specification)(info phone-number region-code dialing-region-FQ)(info phone-number region-code locale-specification dialing-region)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns a map containing all possible information about the number with keywords as keys.

      +

      has-known-type?

      added in 8.12.4-0

      (has-known-type? phone-number)(has-known-type? phone-number region-code)

      Returns true if the given number is of a known type, false otherwise.

      +

      has-location?

      added in 8.12.4-0

      (has-location? phone-number)(has-location? phone-number region-code)

      For the given phone number returns true if the approximate geographic location is present in it, false otherwise.

      +

      has-raw-input?

      added in 8.12.4-1

      (has-raw-input? phone-number)(has-raw-input? phone-number region-code)

      Checks whether raw input string can be obtained from the given phone number.

      +

      has-region?

      added in 8.12.4-0

      (has-region? phone-number)(has-region? phone-number region-code)

      For the given phone number returns true if the region code is present in it, false otherwise. The region code can be explicit part of a number (as its prefix) or can be inferred by making use of the region-code argument.

      +

      has-time-zone?

      added in 8.12.4-0

      (has-time-zone? phone-number)(has-time-zone? phone-number region-code)

      For the given phone number returns true if any time zone information is present in it, false otherwise.

      +

      impossible?

      added in 8.12.4-0

      (impossible? phone-number)(impossible? phone-number region-code)

      Returns true if the given phone number (expressed as a string, a number, a map or a PhoneNumber object) is not possible.

      +

      info

      added in 8.12.4-0

      (info phone-number)(info phone-number region-code)(info phone-number locale-specification-FQ)(info phone-number region-code locale-specification)(info phone-number region-code dialing-region-FQ)(info phone-number region-code locale-specification dialing-region)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns a map containing all possible information about the number with keywords as keys.

      Required keys:

      :phone-number/calling-code
       :phone-number/geographical?
      @@ -133,40 +133,40 @@
       

      If there are four arguments then the last one should be a dialing region code intended to be used with short numbers (like 112 etc.). It describes originating region to help validate the possibility of reaching the destination number. When this argument is missing or its value is nil and the dynamic variable *default-dialing-region* is not nil then its value will be used to set the dialing region. If the dynamic variable is also nil (which is the default) then the dynamic variable *info-dialing-region-derived* is checked to be set to truthy value (not nil and not false). If that is true then the dialing region will be derived from a region code of the number.

      The :phone-number/valid? key holds the return value of valid? function call without any dialing region applied (even if it is passed as an argument or extracted from a map given as input to the info function). There is also the :phone-number.dialing-region/valid-for? key which holds the validity information taking dialing region (passed, extracted or default) into account.

      It is important to realize that certain properties of short numbers can only be successfully calculated if the unprocessed form of a number (a string or a natural number) does not contain country code and so it is delivered as it would be dialed. It is advised to pass a region code as the second argument when short numbers are analysed. It is also advised to submit a dialing region code when more precise analysis is required.

      -

      invalid-example

      added in 8.12.4-0

      (invalid-example region-code)

      For the given region code returns the example phone number that is invalid (being a PhoneNumber kind of object). This is not a random number generator; it will always generate the same example number for the same arguments.

      -

      invalid?

      added in 8.12.4-0

      (invalid? phone-number)(invalid? phone-number region-code)

      Returns true if the given phone number (expressed as a string, a number, a map or a PhoneNumber object) is not valid.

      -

      is-fixed-line-or-mobile?

      added in 8.12.4-0

      (is-fixed-line-or-mobile? phone-number)(is-fixed-line-or-mobile? phone-number region-code)

      Returns true if the given number is a kind of fixed-line number or a mobile number, false otherwise. Returns true also when there is a chance that a number is either mobile or fixed-line but it cannot be certainly decided.

      -

      is-fixed-line?

      added in 8.12.4-0

      (is-fixed-line? phone-number)(is-fixed-line? phone-number region-specification)

      Returns true when type is :phone-number.type/fixed-line, false otherwise.

      -

      is-maybe-fixed-line?

      added in 8.12.4-0

      (is-maybe-fixed-line? phone-number)(is-maybe-fixed-line? phone-number region-code)

      Returns true if the given number is a kind of a fixed-line number or a number that belongs to a class where it cannot be fully decided whether it is mobile or fixed-line. Returns false otherwise.

      -

      is-maybe-mobile?

      added in 8.12.4-0

      (is-maybe-mobile? phone-number)(is-maybe-mobile? phone-number region-code)

      Returns true if the given number is a kind of a mobile number or a number that belongs to a class where it cannot be fully decided whether it is mobile or fixed-line. Returns false otherwise.

      -

      is-maybe-short?

      added in 8.12.4-0

      Same as short-possible?

      -

      is-mobile?

      added in 8.12.4-0

      (is-mobile? phone-number)(is-mobile? phone-number region-specification)

      Returns true when type is :phone-number.type/mobile, false otherwise.

      -

      is-pager?

      added in 8.12.4-0

      (is-pager? phone-number)(is-pager? phone-number region-specification)

      Returns true when type is :phone-number.type/pager, false otherwise.

      -

      is-personal?

      added in 8.12.4-0

      (is-personal? phone-number)(is-personal? phone-number region-specification)

      Returns true when type is :phone-number.type/personal, false otherwise.

      -

      is-premium-rate?

      added in 8.12.4-0

      (is-premium-rate? phone-number)(is-premium-rate? phone-number region-specification)

      Returns true when type is :phone-number.type/premium-rate, false otherwise.

      -

      is-shared-cost?

      added in 8.12.4-0

      (is-shared-cost? phone-number)(is-shared-cost? phone-number region-specification)

      Returns true when type is :phone-number.type/shared-cost, false otherwise.

      -

      is-short?

      added in 8.12.4-0

      Same as short-valid?

      -

      is-toll-free?

      added in 8.12.4-0

      (is-toll-free? phone-number)(is-toll-free? phone-number region-specification)

      Returns true when type is :phone-number.type/toll-free, false otherwise.

      -

      is-uan?

      added in 8.12.4-0

      (is-uan? phone-number)(is-uan? phone-number region-specification)

      Returns true when type is :phone-number.type/uan, false otherwise.

      -

      is-uncertain-fixed-line-or-mobile?

      added in 8.12.4-0

      (is-uncertain-fixed-line-or-mobile? phone-number)(is-uncertain-fixed-line-or-mobile? phone-number region-code)

      Returns true if the given number belongs to a class of numbers that cannot be certainly decided as being mobile or fixed-line, false otherwise. Please note that it will return false for mobile or fixed-line numbers that are certainly classified as such.

      -

      is-unknown?

      added in 8.12.4-0

      (is-unknown? phone-number)(is-unknown? phone-number region-specification)

      Returns true when type is :phone-number.type/unknown, false otherwise.

      -

      is-voicemail?

      added in 8.12.4-0

      (is-voicemail? phone-number)(is-voicemail? phone-number region-specification)

      Returns true when type is :phone-number.type/voicemail, false otherwise.

      -

      is-voip?

      added in 8.12.4-0

      (is-voip? phone-number)(is-voip? phone-number region-specification)

      Returns true when type is :phone-number.type/voip, false otherwise.

      -

      leniencies

      added in 8.12.4-3

      A set of all possible phone number leniencies as a set of keywords.

      -

      locales

      added in 8.12.4-3

      A set of all possible phone number locales as a set of keywords.

      -

      location

      added in 8.12.4-0

      (location phone-number)(location phone-number region-code)(location phone-number locale-specification-FQ)(location phone-number region-code locale-specification)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns its possible geographic location as a string or nil if the location happens to be empty.

      +

      invalid-example

      added in 8.12.4-0

      (invalid-example region-code)

      For the given region code returns the example phone number that is invalid (being a PhoneNumber kind of object). This is not a random number generator; it will always generate the same example number for the same arguments.

      +

      invalid?

      added in 8.12.4-0

      (invalid? phone-number)(invalid? phone-number region-code)

      Returns true if the given phone number (expressed as a string, a number, a map or a PhoneNumber object) is not valid.

      +

      is-fixed-line-or-mobile?

      added in 8.12.4-0

      (is-fixed-line-or-mobile? phone-number)(is-fixed-line-or-mobile? phone-number region-code)

      Returns true if the given number is a kind of fixed-line number or a mobile number, false otherwise. Returns true also when there is a chance that a number is either mobile or fixed-line but it cannot be certainly decided.

      +

      is-fixed-line?

      added in 8.12.4-0

      (is-fixed-line? phone-number)(is-fixed-line? phone-number region-specification)

      Returns true when type is :phone-number.type/fixed-line, false otherwise.

      +

      is-maybe-fixed-line?

      added in 8.12.4-0

      (is-maybe-fixed-line? phone-number)(is-maybe-fixed-line? phone-number region-code)

      Returns true if the given number is a kind of a fixed-line number or a number that belongs to a class where it cannot be fully decided whether it is mobile or fixed-line. Returns false otherwise.

      +

      is-maybe-mobile?

      added in 8.12.4-0

      (is-maybe-mobile? phone-number)(is-maybe-mobile? phone-number region-code)

      Returns true if the given number is a kind of a mobile number or a number that belongs to a class where it cannot be fully decided whether it is mobile or fixed-line. Returns false otherwise.

      +

      is-maybe-short?

      added in 8.12.4-0

      Same as short-possible?

      +

      is-mobile?

      added in 8.12.4-0

      (is-mobile? phone-number)(is-mobile? phone-number region-specification)

      Returns true when type is :phone-number.type/mobile, false otherwise.

      +

      is-pager?

      added in 8.12.4-0

      (is-pager? phone-number)(is-pager? phone-number region-specification)

      Returns true when type is :phone-number.type/pager, false otherwise.

      +

      is-personal?

      added in 8.12.4-0

      (is-personal? phone-number)(is-personal? phone-number region-specification)

      Returns true when type is :phone-number.type/personal, false otherwise.

      +

      is-premium-rate?

      added in 8.12.4-0

      (is-premium-rate? phone-number)(is-premium-rate? phone-number region-specification)

      Returns true when type is :phone-number.type/premium-rate, false otherwise.

      +

      is-shared-cost?

      added in 8.12.4-0

      (is-shared-cost? phone-number)(is-shared-cost? phone-number region-specification)

      Returns true when type is :phone-number.type/shared-cost, false otherwise.

      +

      is-short?

      added in 8.12.4-0

      Same as short-valid?

      +

      is-toll-free?

      added in 8.12.4-0

      (is-toll-free? phone-number)(is-toll-free? phone-number region-specification)

      Returns true when type is :phone-number.type/toll-free, false otherwise.

      +

      is-uan?

      added in 8.12.4-0

      (is-uan? phone-number)(is-uan? phone-number region-specification)

      Returns true when type is :phone-number.type/uan, false otherwise.

      +

      is-uncertain-fixed-line-or-mobile?

      added in 8.12.4-0

      (is-uncertain-fixed-line-or-mobile? phone-number)(is-uncertain-fixed-line-or-mobile? phone-number region-code)

      Returns true if the given number belongs to a class of numbers that cannot be certainly decided as being mobile or fixed-line, false otherwise. Please note that it will return false for mobile or fixed-line numbers that are certainly classified as such.

      +

      is-unknown?

      added in 8.12.4-0

      (is-unknown? phone-number)(is-unknown? phone-number region-specification)

      Returns true when type is :phone-number.type/unknown, false otherwise.

      +

      is-voicemail?

      added in 8.12.4-0

      (is-voicemail? phone-number)(is-voicemail? phone-number region-specification)

      Returns true when type is :phone-number.type/voicemail, false otherwise.

      +

      is-voip?

      added in 8.12.4-0

      (is-voip? phone-number)(is-voip? phone-number region-specification)

      Returns true when type is :phone-number.type/voip, false otherwise.

      +

      leniencies

      added in 8.12.4-3

      A set of all possible phone number leniencies as a set of keywords.

      +

      locales

      added in 8.12.4-3

      A set of all possible phone number locales as a set of keywords.

      +

      location

      added in 8.12.4-0

      (location phone-number)(location phone-number region-code)(location phone-number locale-specification-FQ)(location phone-number region-code locale-specification)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns its possible geographic location as a string or nil if the location happens to be empty.

      If the second argument is present then it may be a valid region code (a keyword) to be used when the given phone number does not contain region information. It is acceptable to pass nil as a value to tell the function that there is no explicit region information and it should extract it from a number.

      If the third argument is present then it should be a string specifying locale information or a java.util.Locale object. It will be used during rendering strings describing geographic location and carrier data. When nil is passed then the default locale settings will be used.

      If there are 2 arguments and the second argument is a keyword but IS NOT a fully-qualified, valid locale specification (locale-specification-FQ having namespace set to phone-number.locale) then it will be treated as a region code. Using namespaced keyword for a locale (or using object other than keyword) is required to avoid ambiguity since simple region codes and locale specs can be expressed using the very same keyword names. Optionally (but a bad habit) you may use simple keyword with locale and variant (e.g. :pl_PL) that will not match any region but match locale object.

      -

      match

      added in 8.12.4-0

      (match phone-number-a region-code-a phone-number-b region-code-b)(match phone-number-a region-code-a phone-number-b)(match phone-number-a phone-number-b)

      Returns matching level of two numbers or nil if there is no match. Optionally each second argument can be a region code (if the given phone number is not a kind of PhoneNumber and is not prefixed by any calling code ).

      -

      match-types

      added in 8.12.4-0

      A set of all possible phone number match types as a set of keywords.

      -

      match?

      added in 8.12.4-0

      (match? phone-number-a region-code-a phone-number-b region-code-b)(match? phone-number-a region-code-a phone-number-b)(match? phone-number-a phone-number-b)

      Returns true if two numbers match, false otherwise. Optionally each second argument can be a region code (if the given phone number is not a kind of PhoneNumber and is not prefixed by any calling code).

      -

      native?

      added in 8.12.4-0

      (native? phone-number _)(native? phone-number)

      Returns true if the given argument is an instance of PhoneNumber class.

      -

      net-codes

      added in 8.12.4-0

      A set of all possible global network calling codes.

      -

      none

      added in 8.12.4-0

      A set containing values considered to be none, unknown or empty in the domain of processing phone numbers and codes.

      -

      numeric

      added in 8.12.4-1

      (numeric phone-number)(numeric phone-number region-code)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns its regional part as an integer, positive number of type Long.

      +

      match

      added in 8.12.4-0

      (match phone-number-a region-code-a phone-number-b region-code-b)(match phone-number-a region-code-a phone-number-b)(match phone-number-a phone-number-b)

      Returns matching level of two numbers or nil if there is no match. Optionally each second argument can be a region code (if the given phone number is not a kind of PhoneNumber and is not prefixed by any calling code ).

      +

      match-types

      added in 8.12.4-0

      A set of all possible phone number match types as a set of keywords.

      +

      match?

      added in 8.12.4-0

      (match? phone-number-a region-code-a phone-number-b region-code-b)(match? phone-number-a region-code-a phone-number-b)(match? phone-number-a phone-number-b)

      Returns true if two numbers match, false otherwise. Optionally each second argument can be a region code (if the given phone number is not a kind of PhoneNumber and is not prefixed by any calling code).

      +

      native?

      added in 8.12.4-0

      (native? phone-number _)(native? phone-number)

      Returns true if the given argument is an instance of PhoneNumber class.

      +

      net-codes

      added in 8.12.4-0

      A set of all possible global network calling codes.

      +

      none

      added in 8.12.4-0

      A set containing values considered to be none, unknown or empty in the domain of processing phone numbers and codes.

      +

      numeric

      added in 8.12.4-1

      (numeric phone-number)(numeric phone-number region-code)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns its regional part as an integer, positive number of type Long.

      If the second argument is present then it should be a valid region code (a keyword) to be used when the given phone number does not contain region information.

      -

      Phoneable

      protocol

      added in 8.12.4-0

      This protocol is used to utilize class-based single dispatch on a phone number abstract.

      +

      Phoneable

      protocol

      added in 8.12.4-0

      This protocol is used to utilize class-based single dispatch on a phone number abstract.

      members

      number

      added in 8.12.4-0

      (number phone-number)(number phone-number region-code)

      Takes a phone number represented as a string, a number, a map or a PhoneNumber object and returns parsed PhoneNumber object. Second, optional argument should be a keyword with region code which is helpful if a local number (without region code) was given. If the region code argument is passed and the first argument is already a kind of PhoneNumber then it will be ignored.

      It is important to realize that certain properties of so called short numbers (like an emergency numbers) can only be successfully calculated by other functions if the unprocessed form of a number (a string or a natural number) does not contain country code and so it is delivered as it would be dialed. It is advised to pass a region code as the second argument when short numbers are in use.

      number-noraw

      added in 8.12.4-0

      (number-noraw phone-number)(number-noraw phone-number region-code)

      Like number but does not preserve raw input.

      @@ -177,25 +177,26 @@

      When 3 arguments are given the last one should be a source region code for which the test is performed. It only makes sense to use it when the calling code for a number is not the same as the dialing code for the region. If that argument is nil then a value stored in the dynamic variable *default-dialing-region* will be used. If this value is also nil then the function will fall back to checking a number without any dialing region.

      One special case is when validating an info map (the result of calling info function). When there will not be dialing region given (or its value will be nil) then this function will try to obtain the source region information from an entry stored under the key :phone-number/dialing-region (or possibly :dialing-region when namespace inference is enabled). It will fetch it only when the key :phone-number.dialing-region/derived? is not holding a truthy value. When this fail then it will default to *default-dialing-region*.

      This function will NOT make use of *info-dialing-region-derived*, hence the prefix info- (this variable is to control only the info function). If you need a dialing region code to be derived from the region code of a number, please parse a number and supply the result of the region function to valid? as its last argument.

      -

      possible?

      added in 8.12.4-0

      (possible? phone-number)(possible? phone-number region-code)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns true if it is a possible number as defined by Libphonenumber. Otherwise it returns false.

      +

      possible?

      added in 8.12.4-0

      (possible? phone-number)(possible? phone-number region-code)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns true if it is a possible number as defined by Libphonenumber. Otherwise it returns false.

      If the second argument is present then it should be a valid region code (a keyword) to be used when the given phone number does not contain region information.

      -

      region

      added in 8.12.4-0

      (region phone-number)(region phone-number region-code)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns its region code as a string or nil if the number is not regional or not given.

      +

      re-two-digits

      added in 8.13.6-2

      Regular expression pattern matching at least 2 digits in a string.

      +

      region

      added in 8.12.4-0

      (region phone-number)(region phone-number region-code)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns its region code as a string or nil if the number is not regional or not given.

      If the second argument is present then it should be a valid region code (a keyword) to be used when the given phone number does not contain region information.

      -

      region-for-calling-code

      added in 8.12.16-1

      (region-for-calling-code calling-code)

      Returns a primary region code (keyword) assigned to the given calling code (integer number). Please be aware that for non-geographical calling codes (like global network calling codes) it will return a set containing :phone-number.region/:world which cannot be later used as a valid region argument in most of the functions.

      -

      regions

      added in 8.12.4-0

      A set of all possible phone number region codes.

      -

      regions-for-calling-code

      added in 8.12.16-1

      (regions-for-calling-code calling-code)

      Returns a set of region codes (keywords) assigned to the given calling code (integer number). Please be aware that for non-geographical calling codes (like global network calling codes) it will return a set containing :phone-number.region/:world which cannot be later used as a valid region argument in most of the functions.

      -

      required-first-input-characters

      added in 8.12.4-1

      A set of required first characters in a phone number which is a string.

      -

      short-carrier-specific?

      added in 8.12.4-0

      (short-carrier-specific? phone-number)(short-carrier-specific? phone-number region-code)(short-carrier-specific? phone-number region-code dialing-region)

      Takes a short phone number (expressed as a string, a number, a map or a PhoneNumber object), optional region code (or nil) and optional dialing region code. Returns true if it is a carrier-specific number.

      +

      region-for-calling-code

      added in 8.12.16-1

      (region-for-calling-code calling-code)

      Returns a primary region code (keyword) assigned to the given calling code (integer number). Please be aware that for non-geographical calling codes (like global network calling codes) it will return a set containing :phone-number.region/:world which cannot be later used as a valid region argument in most of the functions.

      +

      regions

      added in 8.12.4-0

      A set of all possible phone number region codes.

      +

      regions-for-calling-code

      added in 8.12.16-1

      (regions-for-calling-code calling-code)

      Returns a set of region codes (keywords) assigned to the given calling code (integer number). Please be aware that for non-geographical calling codes (like global network calling codes) it will return a set containing :phone-number.region/:world which cannot be later used as a valid region argument in most of the functions.

      +

      required-first-input-characters

      added in 8.12.4-1

      A set of required first characters in a phone number which is a string. Used internally in spec testing.

      +

      short-carrier-specific?

      added in 8.12.4-0

      (short-carrier-specific? phone-number)(short-carrier-specific? phone-number region-code)(short-carrier-specific? phone-number region-code dialing-region)

      Takes a short phone number (expressed as a string, a number, a map or a PhoneNumber object), optional region code (or nil) and optional dialing region code. Returns true if it is a carrier-specific number.

      If the default-dialing-region* dynamic variable is set then it will be used as a default dialing region if it is not passed as an argument.

      It is important to realize that certain properties of short numbers can only be successfully calculated if the unprocessed form of a number (a string or a natural number) does not contain country code and so it is delivered as it would be dialed. It is advised to pass a region code as the second argument when short numbers are tested.

      -

      short-cost

      added in 8.12.4-0

      (short-cost phone-number)(short-cost phone-number region-code)(short-cost phone-number region-code dialing-region)

      Takes a short (like an emergency) phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns the expected cost class of that number as a keyword.

      +

      short-cost

      added in 8.12.4-0

      (short-cost phone-number)(short-cost phone-number region-code)(short-cost phone-number region-code dialing-region)

      Takes a short (like an emergency) phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns the expected cost class of that number as a keyword.

      The second, optional argument should be a valid region code (a keyword) to be used when the given phone number does not contain region information. It is acceptable to pass nil as a value to tell the function that there is no explicit region information and it should extract it from a number.

      If the default-dialing-region* dynamic variable is set then it will be used as a default dialing region if it is not passed as an argument.

      If the third argument is present then it should be a valid region code for the origination of a possible call. That hint will be used to restrict the check according to rules. For example 112 may be valid in multiple regions but if one calls it from some particular region it might not be reachable. When this argument is missing or its value is nil and the dynamic variable *default-dialing-region* is not nil then its value will be used to set the dialing region. If this argument is missing or is nil and there is no default the binary variant of this function is called (without a source region).

      It is important to realize that certain properties of short numbers can only be successfully calculated if the unprocessed form of a number (a string or a natural number) does not contain country code and so it is delivered as it would be dialed. It is advised to pass a region code as the second argument when short numbers are tested. It is also advised to submit a dialing region code when more precise checking should be performed.

      -

      short-emergency?

      added in 8.12.4-0

      (short-emergency? phone-number)(short-emergency? phone-number region-code)

      Takes a short (like an emergency) phone number (expressed as a string!) and returns true if it is exactly the emergency number. The second argument should be a valid region code (a keyword).

      +

      short-emergency?

      added in 8.12.4-0

      (short-emergency? phone-number)(short-emergency? phone-number region-code)

      Takes a short (like an emergency) phone number (expressed as a string!) and returns true if it is exactly the emergency number. The second argument should be a valid region code (a keyword).

      It is important to realize that certain properties of short numbers can only be successfully calculated if the unprocessed form of a number (a string or a natural number) does not contain country code and so it is delivered as it would be dialed. It is advised to pass a region code as the second argument when short numbers are tested.

      -

      short-info

      added in 8.12.4-0

      (short-info phone-number)(short-info phone-number region-code)(short-info phone-number region-code dialing-region)

      Takes a short (like an emergency) phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns a map containing all possible information about the number with keywords as keys.

      +

      short-info

      added in 8.12.4-0

      (short-info phone-number)(short-info phone-number region-code)(short-info phone-number region-code dialing-region)

      Takes a short (like an emergency) phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns a map containing all possible information about the number with keywords as keys.

      Required keys:

       :phone-number.short/valid?
        :phone-number.short/possible?
      @@ -213,29 +214,29 @@
       

      If the second argument is present then it should be a valid region code (a keyword) to be used when the given phone number does not contain region information. It is acceptable to pass nil as a value to tell the function that there is no explicit region information and it should extract it from a number.

      If the third argument is present then it should be a valid region code for the origination of a possible call. That hint will be used to restrict the check according to rules. For example 112 may be valid in multiple regions but if one calls it from some particular region it might not be reachable. When this argument is missing or its value is nil and the dynamic variable *default-dialing-region* is not nil then its value will be used to set the dialing region. If the dynamic variable is also nil (which is the default) then the dynamic variable *info-dialing-region-derived* is checked to be set to truthy value (not nil and not false). If that is true then the dialing region will be derived from a region code of the number.

      It is important to realize that certain properties of short numbers can only be successfully calculated if the unprocessed form of a number (a string or a natural number) does not contain country code and so it is delivered as it would be dialed. It is advised to pass a region code as the second argument when short numbers are tested. It is also advised to submit a dialing region code when more precise checking is required.

      -

      short-invalid?

      added in 8.12.4-0

      Logical negation of short-valid?

      -

      short-possible?

      added in 8.12.4-0

      (short-possible? phone-number)(short-possible? phone-number region-code)(short-possible? phone-number region-code dialing-region)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns true if it is a possible short number (like emergency etc.) as defined by Libphonenumber. Otherwise it returns false. If the second argument is present then it should be a valid region code (a keyword) to be used when the given phone number does not contain region information.

      +

      short-invalid?

      added in 8.12.4-0

      Logical negation of short-valid?

      +

      short-possible?

      added in 8.12.4-0

      (short-possible? phone-number)(short-possible? phone-number region-code)(short-possible? phone-number region-code dialing-region)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns true if it is a possible short number (like emergency etc.) as defined by Libphonenumber. Otherwise it returns false. If the second argument is present then it should be a valid region code (a keyword) to be used when the given phone number does not contain region information.

      If the default-dialing-region* dynamic variable is set then it will be used as a default dialing region if it is not passed as an argument.

      In its ternary form this function takes an additional argument (dialing-region) that should be a valid region code for the origination of a possible call. That hint will be used to restrict the check according to rules. For example 112 may be valid in multiple regions but if one calls it from some particular region it might not be reachable. When this argument is missing or its value is nil and the dynamic variable *default-dialing-region* is not nil then its value will be used to set the dialing region. If this argument is missing or is nil and there is no default the binary variant of this function is called (without a source region).

      -

      short-sms-service?

      added in 8.12.4-0

      (short-sms-service? phone-number)(short-sms-service? phone-number region-code)(short-sms-service? phone-number region-code dialing-region)

      Takes a short phone number (expressed as a string, a number, a map or a PhoneNumber object), optional region code (or nil) and a dialing region code (uses *default-dialing-region* if not given). Returns true if SMS is supported, false otherwise.

      +

      short-sms-service?

      added in 8.12.4-0

      (short-sms-service? phone-number)(short-sms-service? phone-number region-code)(short-sms-service? phone-number region-code dialing-region)

      Takes a short phone number (expressed as a string, a number, a map or a PhoneNumber object), optional region code (or nil) and a dialing region code (uses *default-dialing-region* if not given). Returns true if SMS is supported, false otherwise.

      If the default-dialing-region* dynamic variable is set then it will be used as a default dialing region if it is not passed as an argument.

      It is important to realize that certain properties of short numbers can only be successfully calculated if the unprocessed form of a number (a string or a natural number) does not contain country code and so it is delivered as it would be dialed. It is advised to pass a region code as the second argument when short numbers are tested.

      -

      short-to-emergency?

      added in 8.12.4-0

      (short-to-emergency? phone-number)(short-to-emergency? phone-number region-code)

      Takes a short (like an emergency) phone number (expressed as a string!) and returns true if it can be used to connect to emergency services. The second argument should be a valid region code (a keyword).

      +

      short-to-emergency?

      added in 8.12.4-0

      (short-to-emergency? phone-number)(short-to-emergency? phone-number region-code)

      Takes a short (like an emergency) phone number (expressed as a string!) and returns true if it can be used to connect to emergency services. The second argument should be a valid region code (a keyword).

      It is important to realize that certain properties of short numbers can only be successfully calculated if the unprocessed form of a number (a string or a natural number) does not contain country code and so it is delivered as it would be dialed. It is advised to pass a region code as the second argument when short numbers are tested.

      -

      short-valid?

      added in 8.12.4-0

      (short-valid? phone-number)(short-valid? phone-number region-code)(short-valid? phone-number region-code dialing-region)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns true if it is a valid short number (like emergency etc.) as defined by Libphonenumber. Otherwise it returns false. If the second argument is present then it should be a valid region code (a keyword) to be used when the given phone number does not contain region information.

      +

      short-valid?

      added in 8.12.4-0

      (short-valid? phone-number)(short-valid? phone-number region-code)(short-valid? phone-number region-code dialing-region)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns true if it is a valid short number (like emergency etc.) as defined by Libphonenumber. Otherwise it returns false. If the second argument is present then it should be a valid region code (a keyword) to be used when the given phone number does not contain region information.

      If the default-dialing-region* dynamic variable is set then it will be used as a default dialing region if it is not passed as an argument.

      In its ternary form this function takes an additional argument (dialing-region) that should be a valid region code for the origination of a possible call. That hint will be used to restrict the check according to rules. For example 112 may be valid in multiple regions but if one calls it from some particular region it might not be reachable. When this argument is missing or its value is nil and the dynamic variable *default-dialing-region* is not nil then its value will be used to set the dialing region. If this argument is missing or is nil and there is no default the binary variant of this function is called (without a source region).

      -

      time-zones

      added in 8.12.4-0

      (time-zones phone-number)(time-zones phone-number region-code)(time-zones phone-number format-specification)(time-zones phone-number region-code format-specification)(time-zones phone-number region-code locale-specification)(time-zones phone-number region-code locale-specification format-specification)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns all possible time zones which relate to its geographical location as a lazy sequence of strings (representing zone identifiers in English). Returns nil if the list would be empty.

      +

      time-zones

      added in 8.12.4-0

      (time-zones phone-number)(time-zones phone-number region-code)(time-zones phone-number format-specification)(time-zones phone-number region-code format-specification)(time-zones phone-number region-code locale-specification)(time-zones phone-number region-code locale-specification format-specification)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns all possible time zones which relate to its geographical location as a lazy sequence of strings (representing zone identifiers in English). Returns nil if the list would be empty.

      If the second argument is present then it may be a valid region code (a keyword) to be used when the given phone number does not contain region information. It is acceptable to pass nil as a value to tell the function that there is no explicit region information and it should extract it from a number. It may also be a format specifier (also a keyword).

      The third argument may be a format specification or a locale specification (both as keywords).

      If there are 4 arguments then the format specification should be the last and locale specification should be last but one.

      -

      time-zones-all-formats

      added in 8.12.4-0

      (time-zones-all-formats phone-number)(time-zones-all-formats phone-number region-code)(time-zones-all-formats phone-number locale-specification-FQ)(time-zones-all-formats phone-number region-code locale-specification)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns a map which keys are all possible time zone formats expressed as keywords and values are sequences of the number’s time zones formatted accordingly. If the given number is nil, invalid or time zone information is unavailable for it this function returns nil.

      +

      time-zones-all-formats

      added in 8.12.4-0

      (time-zones-all-formats phone-number)(time-zones-all-formats phone-number region-code)(time-zones-all-formats phone-number locale-specification-FQ)(time-zones-all-formats phone-number region-code locale-specification)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns a map which keys are all possible time zone formats expressed as keywords and values are sequences of the number’s time zones formatted accordingly. If the given number is nil, invalid or time zone information is unavailable for it this function returns nil.

      If the second argument is present then it may be a valid region code (a keyword) to be used when the given phone number does not contain region information. It is possible to pass a nil value as this argument to ignore extra processing when region can be inferred from the number.

      If there are 2 arguments and the second argument is a keyword but IS NOT a fully-qualified, valid locale specification (locale-specification-FQ having namespace set to phone-number.locale) then it will be treated as a region code. Using namespaced keyword for a locale (or using object other than keyword) is required to avoid ambiguity since simple region codes and locale specs can be expressed using the very same keyword names. Optionally (but a bad habit) you may use simple keyword with locale and variant (e.g. :pl_PL) that will not match any region but match locale object.

      The third argument should be a Locale object or a string describing locale settings to be used when rendering locale-dependent time zone information. When there is no third argument or it is nil then default locale settings will be used.

      -

      type

      added in 8.12.4-0

      (type phone-number)(type phone-number region-code)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns its type as a keyword. For unknown types and number without types it returns :phone-number.type/unknown.

      +

      type

      added in 8.12.4-0

      (type phone-number)(type phone-number region-code)

      Takes a phone number (expressed as a string, a number, a map or a PhoneNumber object) and returns its type as a keyword. For unknown types and number without types it returns :phone-number.type/unknown.

      If the second argument is present then it should be a valid region code (a keyword) to be used when the given phone number does not contain region information.

      -

      types

      added in 8.12.4-0

      A set of all possible phone number types as a set of keywords.

      -

      tz-formats

      added in 8.12.4-0

      A set of all possible time zone formats as a set of keywords.

      -

      valid-for-region?

      added in 8.12.4-0

      deprecated in 8.12.4-1

      (valid-for-region? phone-number region-code dialing-region)

      DEPRECATED: Please use ternary version of the valid? function.

      -

      when-some-input

      macro

      (when-some-input phone-num & body)
      \ No newline at end of file +

      types

      added in 8.12.4-0

      A set of all possible phone number types as a set of keywords.

      +

      tz-formats

      added in 8.12.4-0

      A set of all possible time zone formats as a set of keywords.

      +

      valid-for-region?

      added in 8.12.4-0

      deprecated in 8.12.4-1

      (valid-for-region? phone-number region-code dialing-region)

      DEPRECATED: Please use ternary version of the valid? function.

      +

      when-some-input

      macro

      (when-some-input phone-num & body)
      \ No newline at end of file diff --git a/docs/phone-number.cost.html b/docs/phone-number.cost.html index 594f1fc..2747a8e 100644 --- a/docs/phone-number.cost.html +++ b/docs/phone-number.cost.html @@ -1,17 +1,17 @@ -phone-number.cost documentation

      phone-number.cost

      added in 8.12.4-0

      Cost classes of short numbers for phone-number.

      +phone-number.cost documentation

      phone-number.cost

      added in 8.12.4-0

      Cost classes of short numbers for phone-number.

      all

      added in 8.12.4-0

      Map of phone number cost (keywords) to ShortNumberCost values.

      -

      all-arg

      added in 8.12.4-0

      Map of ShortNumberCost values to phone number costs (keywords) suitable to be passed as arguments.

      -

      all-arg-vec

      added in 8.12.4-0

      Vector of costs (keywords) suitable as arguments.

      -

      all-vec

      added in 8.12.4-0

      Vector of costs (keywords).

      -

      by-val

      added in 8.12.4-0

      Map of ShortNumberCost values to phone number costs (keywords).

      -

      by-val-arg

      added in 8.12.16-1

      Map of ShortNumberCost values to phone number costs (keywords) suitable to be passed as method argument.

      -

      by-val-arg-vec

      added in 8.12.16-1

      Vector of costs (ShortNumberCost values).

      -

      by-val-vec

      added in 8.12.4-0

      Vector of costs (ShortNumberCost values).

      -

      default

      added in 8.12.4-0

      default-val

      added in 8.12.4-0

      generate-sample

      added in 8.12.4-0

      (generate-sample)(generate-sample rng)

      Generates random number cost.

      -

      generate-sample-val

      added in 8.12.4-0

      (generate-sample-val)(generate-sample-val rng)

      Generates random number cost (ShortNumberCost value).

      -

      parse

      added in 8.12.4-0

      (parse k)(parse k use-infer)

      Parses a cost and returns a value that can be supplied to Libphonenumber methods. If nil is given it returns the default value.

      -

      unknown

      added in 8.12.16-1

      unknown-val

      added in 8.12.16-1

      valid-arg?

      added in 8.12.4-0

      (valid-arg? cost)(valid-arg? cost use-infer)

      Returns true if the given cost is valid, false otherwise.

      -

      valid?

      added in 8.12.4-0

      (valid? cost)(valid? cost use-infer)

      Returns true if the given cost is valid, false otherwise.

      -
      \ No newline at end of file +

      all-arg

      added in 8.12.4-0

      Map of ShortNumberCost values to phone number costs (keywords) suitable to be passed as arguments.

      +

      all-arg-vec

      added in 8.12.4-0

      Vector of costs (keywords) suitable as arguments.

      +

      all-vec

      added in 8.12.4-0

      Vector of costs (keywords).

      +

      by-val

      added in 8.12.4-0

      Map of ShortNumberCost values to phone number costs (keywords).

      +

      by-val-arg

      added in 8.12.16-1

      Map of ShortNumberCost values to phone number costs (keywords) suitable to be passed as method argument.

      +

      by-val-arg-vec

      added in 8.12.16-1

      Vector of costs (ShortNumberCost values).

      +

      by-val-vec

      added in 8.12.4-0

      Vector of costs (ShortNumberCost values).

      +

      default

      added in 8.12.4-0

      default-val

      added in 8.12.4-0

      generate-sample

      added in 8.12.4-0

      (generate-sample)(generate-sample rng)

      Generates random number cost.

      +

      generate-sample-val

      added in 8.12.4-0

      (generate-sample-val)(generate-sample-val rng)

      Generates random number cost (ShortNumberCost value).

      +

      parse

      added in 8.12.4-0

      (parse k)(parse k use-infer)

      Parses a cost and returns a value that can be supplied to Libphonenumber methods. If nil is given it returns the default value.

      +

      unknown

      added in 8.12.16-1

      unknown-val

      added in 8.12.16-1

      valid-arg?

      added in 8.12.4-0

      (valid-arg? cost)(valid-arg? cost use-infer)

      Returns true if the given cost is valid, false otherwise.

      +

      valid?

      added in 8.12.4-0

      (valid? cost)(valid? cost use-infer)

      Returns true if the given cost is valid, false otherwise.

      +
      \ No newline at end of file diff --git a/docs/phone-number.country-code.html b/docs/phone-number.country-code.html index fcf86a6..e5350f0 100644 --- a/docs/phone-number.country-code.html +++ b/docs/phone-number.country-code.html @@ -1,19 +1,19 @@ -phone-number.country-code documentation

      phone-number.country-code

      added in 8.12.4-0

      Country calling codes handling for phone-number.

      +phone-number.country-code documentation

      phone-number.country-code

      added in 8.12.4-0

      Country calling codes handling for phone-number.

      all

      added in 8.12.4-0

      Set of supported country codes.

      -

      all-arg

      added in 8.12.4-0

      Set of supported country codes (to be used as arguments).

      -

      all-arg-vec

      added in 8.12.16-1

      Vector of all supported country codes (valid as args).

      -

      all-vec

      added in 8.12.4-0

      Vector of all supported country codes.

      -

      by-val

      added in 8.12.4-0

      Set of supported values of country codes.

      -

      by-val-arg

      added in 8.12.4-0

      Set of supported values of country codes (to be used as method arguments).

      -

      by-val-arg-vec

      added in 8.12.16-1

      Vector of all supported country codes (valid as args).

      -

      by-val-vec

      added in 8.12.4-0

      Vector of all supported country codes.

      -

      generate-arg-sample

      added in 8.12.16-1

      (generate-arg-sample)(generate-arg-sample rng)

      Generates a random country calling code.

      -

      generate-arg-sample-val

      added in 8.12.16-1

      (generate-arg-sample-val)(generate-arg-sample-val rng)

      Generates a random country calling code.

      -

      generate-sample

      added in 8.12.4-0

      (generate-sample)(generate-sample rng)

      Generates a random country calling code.

      -

      generate-sample-val

      added in 8.12.16-1

      (generate-sample-val)(generate-sample-val rng)

      Generates a random country calling code.

      -

      parse

      added in 8.12.4-0

      (parse calling-code)

      Parses a country calling code and returns a value that can be supplied to Libphonenumber methods.

      -

      valid-arg?

      added in 8.12.16-1

      (valid-arg? calling-code)

      Returns true if the given region-specification is a valid region code (to be used as an argument), false otherwise.

      -

      valid?

      added in 8.12.4-0

      (valid? calling-code)

      Returns true if the given region-specification is a valid region code, false otherwise.

      -
      \ No newline at end of file +

      all-arg

      added in 8.12.4-0

      Set of supported country codes (to be used as arguments).

      +

      all-arg-vec

      added in 8.12.16-1

      Vector of all supported country codes (valid as args).

      +

      all-vec

      added in 8.12.4-0

      Vector of all supported country codes.

      +

      by-val

      added in 8.12.4-0

      Set of supported values of country codes.

      +

      by-val-arg

      added in 8.12.4-0

      Set of supported values of country codes (to be used as method arguments).

      +

      by-val-arg-vec

      added in 8.12.16-1

      Vector of all supported country codes (valid as args).

      +

      by-val-vec

      added in 8.12.4-0

      Vector of all supported country codes.

      +

      generate-arg-sample

      added in 8.12.16-1

      (generate-arg-sample)(generate-arg-sample rng)

      Generates a random country calling code.

      +

      generate-arg-sample-val

      added in 8.12.16-1

      (generate-arg-sample-val)(generate-arg-sample-val rng)

      Generates a random country calling code.

      +

      generate-sample

      added in 8.12.4-0

      (generate-sample)(generate-sample rng)

      Generates a random country calling code.

      +

      generate-sample-val

      added in 8.12.16-1

      (generate-sample-val)(generate-sample-val rng)

      Generates a random country calling code.

      +

      parse

      added in 8.12.4-0

      (parse calling-code)

      Parses a country calling code and returns a value that can be supplied to Libphonenumber methods.

      +

      valid-arg?

      added in 8.12.16-1

      (valid-arg? calling-code)

      Returns true if the given region-specification is a valid region code (to be used as an argument), false otherwise.

      +

      valid?

      added in 8.12.4-0

      (valid? calling-code)

      Returns true if the given region-specification is a valid region code, false otherwise.

      +
      \ No newline at end of file diff --git a/docs/phone-number.db.html b/docs/phone-number.db.html index f3e596a..8114ede 100644 --- a/docs/phone-number.db.html +++ b/docs/phone-number.db.html @@ -1,52 +1,52 @@ -phone-number.db documentation

      phone-number.db

      added in 8.12.16-1

      Cross-category databases and generators for phone-number.

      +phone-number.db documentation

      phone-number.db

      added in 8.12.16-1

      Cross-category databases and generators for phone-number.

      calling-code-to-region

      added in 8.12.16-1

      Mapping of all supported calling codes (integer numbers) to their primary regions (sets of keywords).

      -

      calling-code-to-region-arg

      added in 8.12.16-1

      Mapping of all supported calling codes (integer numbers) to their primary regions (sets of keywords) which are valid as arguments. Be aware that this map does not contain :phone-number.region/world.

      -

      calling-code-to-regions

      added in 8.12.16-1

      Mapping of all supported calling codes (integer numbers) to regions (sets of keywords) they are assigned to.

      -

      calling-code-to-regions-arg

      added in 8.12.16-1

      Mapping of all supported calling codes (integer numbers) to regions (sets of keywords) they are assigned to and are valid as arguments. Be aware that this map does not contain :phone-number.region/world.

      -

      calling-code-to-regions-arg-vec

      added in 8.12.16-1

      (calling-code-to-regions-arg-vec region-code)

      Returns a vector of phone number regions (which can be used as arguments) for the given calling code and caches the result.

      -

      calling-code-to-regions-vec

      added in 8.12.16-1

      (calling-code-to-regions-vec region-code)

      Returns a vector of phone number types for the given calling code and caches the result.

      -

      calling-code-to-types

      added in 8.12.16-1

      Mapping of all calling codes (integer numbers) to sets of the supported phone number types (keywords). Please be aware that single country calling code may be used by more than one geographical region (e.g. 1 maps to US, Canada and more), making this database less precise for geographical location. In case of regional numbers consider using phone-number.db/region-to-types. This database will work precisely with non-geographical, global network calling codes.

      -

      calling-code-to-types-vec

      added in 8.12.16-1

      (calling-code-to-types-vec region-code)

      Returns a vector of phone number types for the given calling code and caches the result.

      -

      calling-codes

      added in 8.12.16-1

      A set of all possible country calling codes.

      -

      calling-codes-args

      added in 8.12.16-1

      A set of all possible country calling codes (suitable to be used as arguments).

      -

      costs

      added in 8.12.16-1

      A set of all possible phone number cost classes as a set of keywords.

      -

      costs-args

      added in 8.12.16-1

      A set of all possible phone number cost classes as a set of keywords (suitable to be used as arguments).

      -

      country-codes

      added in 8.12.16-1

      A set of all possible country calling codes.

      -

      country-codes-args

      added in 8.12.16-1

      A set of all possible country calling codes (suitable to be used as arguments).

      -

      formats

      added in 8.12.16-1

      A set of all possible phone number formats as a set of keywords.

      -

      formats-args

      added in 8.12.16-1

      A set of all possible phone number formats as a set of keywords (suitable to be used as arguments).

      -

      generate-region-arg-for-calling-code

      added in 8.12.16-1

      (generate-region-arg-for-calling-code)(generate-region-arg-for-calling-code calling-code)(generate-region-arg-for-calling-code calling-code rng)

      Generates a random region code (keyword) which is suitable as an argument for the given calling code.

      -

      generate-region-for-calling-code

      added in 8.12.16-1

      (generate-region-for-calling-code)(generate-region-for-calling-code calling-code)(generate-region-for-calling-code calling-code rng)

      Generates random region code (keyword) for the given calling code.

      -

      generate-type-arg-for-calling-code

      added in 8.12.16-1

      (generate-type-arg-for-calling-code)(generate-type-arg-for-calling-code calling-code-or-random)(generate-type-arg-for-calling-code calling-code rng)

      Generates a random number type which is valid for the given region and suitable to be used as an argument. Works for non-geographical numbers (global network calling codes), doesn’t work well for country calling codes.

      -

      generate-type-arg-for-region

      added in 8.12.16-1

      (generate-type-arg-for-region)(generate-type-arg-for-region region-code-or-random)(generate-type-arg-for-region region-code rng)

      Generates a random number type which is valid for the given region and can be used as an argument. Works for geographical numbers, doesn’t work for :phone-number.region/world.

      -

      generate-type-for-calling-code

      added in 8.12.16-1

      (generate-type-for-calling-code)(generate-type-for-calling-code calling-code-or-random)(generate-type-for-calling-code calling-code rng)

      Generates a random number type which is valid for the given region. Works for non-geographical numbers (global network calling codes), doesn’t work well for country calling codes.

      -

      generate-type-for-region

      added in 8.12.16-1

      (generate-type-for-region)(generate-type-for-region region-code-or-random)(generate-type-for-region region-code rng)

      Generates a random number type which is valid for the given region. Works for geographical numbers, doesn’t work for :phone-number.region/world.

      -

      generate-type-for-region-arg

      added in 8.12.16-1

      (generate-type-for-region-arg)(generate-type-for-region-arg region-code-or-random)(generate-type-for-region-arg region-code rng)

      Generates a random number type which is valid for the given region (taken from the region codes which are suitable to be used as arguments). Works for geographical numbers, doesn’t work for :phone-number.region/world.

      -

      leniencies

      added in 8.12.16-1

      A set of all possible phone number leniencies as a set of keywords.

      -

      leniencies-args

      added in 8.12.16-1

      A set of all possible phone number leniencies as a set of keywords (suitable to be used as arguments).

      -

      locales

      added in 8.12.16-1

      A set of all possible phone number locales as a set of keywords.

      -

      locales-args

      added in 8.12.16-1

      A set of all possible phone number locales as a set of keywords (suitable to be used as arguments).

      -

      match-types

      added in 8.12.16-1

      A set of all possible phone number match types as a set of keywords.

      -

      match-types-args

      added in 8.12.16-1

      A set of all possible phone number match types as a set of keywords (suitable to be used as arguments).

      -

      net-codes

      added in 8.12.16-1

      A set of all possible global network calling codes.

      -

      net-codes-args

      added in 8.12.16-1

      A set of all possible global network calling codes (suitable to be used as arguments).

      -

      region-arg-to-calling-code

      added in 8.12.16-1

      Mapping of all supported regions (keywords) which are valid as arguments to their primary calling codes (integer numbers). Be aware that this map does not contain :phone-number.region/world.

      -

      region-arg-to-calling-codes

      added in 8.12.16-1

      Mapping of all supported regions (keywords) which are valid as arguments to their calling codes (sets of integer numbers). Be aware that this map does not contain :phone-number.region/world.

      -

      region-arg-to-types

      added in 8.12.16-1

      Mapping of all regions (keywords) which are valid as arguments to supported phone number types (sets of keywords). Please be aware that this map does not contain :phone-number.region/world pseudo-region.

      -

      region-arg-to-types-vec

      added in 8.12.16-1

      (region-arg-to-types-vec region-code)

      Returns a vector of phone number types for the given region (which must be suitable to be used as an argument) and caches the result.

      -

      region-to-calling-code

      added in 8.12.16-1

      Mapping of all supported regions (keywords) to their primary calling codes (integer numbers).

      -

      region-to-calling-codes

      added in 8.12.16-1

      Mapping of all supported regions (keywords) to their calling codes (sets of integer numbers).

      -

      region-to-types

      added in 8.12.16-1

      Mapping of all regions (keywords) to supported phone number types (sets of keywords). Please be aware that the :phone-number.region/world pseudo-region groups many calling codes which can vary when it comes to the supported types, hence making this database less precise. To get more granular data for global numbers which are not geographical, please use phone-number.db/calling-code-to-types. For geographical regions this database will be precise.

      -

      region-to-types-vec

      added in 8.12.16-1

      (region-to-types-vec region-code)

      Returns a vector of phone number types for the given region and caches the result.

      -

      regions

      added in 8.12.16-1

      A set of all possible phone number region codes.

      -

      regions-args

      added in 8.12.16-1

      A set of all possible phone number region codes (suitable to be used as arguments).

      -

      type-to-calling-codes

      added in 8.12.16-1

      Mapping of all the supported phone number types (keywords) to sets of calling codes (integer numbers). Please be aware that single country calling code may be used by more than one geographical region (e.g. 1 maps to US, Canada and more), making this database less precise for geographical location. In case of regional numbers consider using phone-number.db/type-to-regions. This database will work precisely with non-geographical, global network calling codes.

      -

      type-to-regions

      added in 8.12.16-1

      Mapping of all supported phone number types (keywords) to regions (sets of keywords). Please be aware that the :phone-number.region/world pseudo-region groups many calling codes which can vary when it comes to the supported types, hence making this database less precise. To get more granular data for global numbers which are not geographical, please use phone-number.db/type-to-calling-codes. For geographical regions this database will be precise.

      -

      type-to-regions-arg

      added in 8.12.16-1

      Mapping of all supported phone number types (keywords) to regions (sets of keywords) which are valid as arguments. Please be aware that this map does not contain :phone-number.region/world pseudo-region within its values.

      -

      types

      added in 8.12.16-1

      A set of all possible phone number types as a set of keywords.

      -

      types-args

      added in 8.12.16-1

      A set of all possible phone number types as a set of keywords (suitable to be used as arguments).

      -

      tz-formats

      added in 8.12.16-1

      A set of all possible time zone formats as a set of keywords.

      -

      tz-formats-args

      added in 8.12.16-1

      A set of all possible time zone formats as a set of keywords (suitable to be used as arguments).

      -
      \ No newline at end of file +

      calling-code-to-region-arg

      added in 8.12.16-1

      Mapping of all supported calling codes (integer numbers) to their primary regions (sets of keywords) which are valid as arguments. Be aware that this map does not contain :phone-number.region/world.

      +

      calling-code-to-regions

      added in 8.12.16-1

      Mapping of all supported calling codes (integer numbers) to regions (sets of keywords) they are assigned to.

      +

      calling-code-to-regions-arg

      added in 8.12.16-1

      Mapping of all supported calling codes (integer numbers) to regions (sets of keywords) they are assigned to and are valid as arguments. Be aware that this map does not contain :phone-number.region/world.

      +

      calling-code-to-regions-arg-vec

      added in 8.12.16-1

      (calling-code-to-regions-arg-vec region-code)

      Returns a vector of phone number regions (which can be used as arguments) for the given calling code and caches the result.

      +

      calling-code-to-regions-vec

      added in 8.12.16-1

      (calling-code-to-regions-vec region-code)

      Returns a vector of phone number types for the given calling code and caches the result.

      +

      calling-code-to-types

      added in 8.12.16-1

      Mapping of all calling codes (integer numbers) to sets of the supported phone number types (keywords). Please be aware that single country calling code may be used by more than one geographical region (e.g. 1 maps to US, Canada and more), making this database less precise for geographical location. In case of regional numbers consider using phone-number.db/region-to-types. This database will work precisely with non-geographical, global network calling codes.

      +

      calling-code-to-types-vec

      added in 8.12.16-1

      (calling-code-to-types-vec region-code)

      Returns a vector of phone number types for the given calling code and caches the result.

      +

      calling-codes

      added in 8.12.16-1

      A set of all possible country calling codes.

      +

      calling-codes-args

      added in 8.12.16-1

      A set of all possible country calling codes (suitable to be used as arguments).

      +

      costs

      added in 8.12.16-1

      A set of all possible phone number cost classes as a set of keywords.

      +

      costs-args

      added in 8.12.16-1

      A set of all possible phone number cost classes as a set of keywords (suitable to be used as arguments).

      +

      country-codes

      added in 8.12.16-1

      A set of all possible country calling codes.

      +

      country-codes-args

      added in 8.12.16-1

      A set of all possible country calling codes (suitable to be used as arguments).

      +

      formats

      added in 8.12.16-1

      A set of all possible phone number formats as a set of keywords.

      +

      formats-args

      added in 8.12.16-1

      A set of all possible phone number formats as a set of keywords (suitable to be used as arguments).

      +

      generate-region-arg-for-calling-code

      added in 8.12.16-1

      (generate-region-arg-for-calling-code)(generate-region-arg-for-calling-code calling-code)(generate-region-arg-for-calling-code calling-code rng)

      Generates a random region code (keyword) which is suitable as an argument for the given calling code.

      +

      generate-region-for-calling-code

      added in 8.12.16-1

      (generate-region-for-calling-code)(generate-region-for-calling-code calling-code)(generate-region-for-calling-code calling-code rng)

      Generates random region code (keyword) for the given calling code.

      +

      generate-type-arg-for-calling-code

      added in 8.12.16-1

      (generate-type-arg-for-calling-code)(generate-type-arg-for-calling-code calling-code-or-random)(generate-type-arg-for-calling-code calling-code rng)

      Generates a random number type which is valid for the given region and suitable to be used as an argument. Works for non-geographical numbers (global network calling codes), doesn’t work well for country calling codes.

      +

      generate-type-arg-for-region

      added in 8.12.16-1

      (generate-type-arg-for-region)(generate-type-arg-for-region region-code-or-random)(generate-type-arg-for-region region-code rng)

      Generates a random number type which is valid for the given region and can be used as an argument. Works for geographical numbers, doesn’t work for :phone-number.region/world.

      +

      generate-type-for-calling-code

      added in 8.12.16-1

      (generate-type-for-calling-code)(generate-type-for-calling-code calling-code-or-random)(generate-type-for-calling-code calling-code rng)

      Generates a random number type which is valid for the given region. Works for non-geographical numbers (global network calling codes), doesn’t work well for country calling codes.

      +

      generate-type-for-region

      added in 8.12.16-1

      (generate-type-for-region)(generate-type-for-region region-code-or-random)(generate-type-for-region region-code rng)

      Generates a random number type which is valid for the given region. Works for geographical numbers, doesn’t work for :phone-number.region/world.

      +

      generate-type-for-region-arg

      added in 8.12.16-1

      (generate-type-for-region-arg)(generate-type-for-region-arg region-code-or-random)(generate-type-for-region-arg region-code rng)

      Generates a random number type which is valid for the given region (taken from the region codes which are suitable to be used as arguments). Works for geographical numbers, doesn’t work for :phone-number.region/world.

      +

      leniencies

      added in 8.12.16-1

      A set of all possible phone number leniencies as a set of keywords.

      +

      leniencies-args

      added in 8.12.16-1

      A set of all possible phone number leniencies as a set of keywords (suitable to be used as arguments).

      +

      locales

      added in 8.12.16-1

      A set of all possible phone number locales as a set of keywords.

      +

      locales-args

      added in 8.12.16-1

      A set of all possible phone number locales as a set of keywords (suitable to be used as arguments).

      +

      match-types

      added in 8.12.16-1

      A set of all possible phone number match types as a set of keywords.

      +

      match-types-args

      added in 8.12.16-1

      A set of all possible phone number match types as a set of keywords (suitable to be used as arguments).

      +

      net-codes

      added in 8.12.16-1

      A set of all possible global network calling codes.

      +

      net-codes-args

      added in 8.12.16-1

      A set of all possible global network calling codes (suitable to be used as arguments).

      +

      region-arg-to-calling-code

      added in 8.12.16-1

      Mapping of all supported regions (keywords) which are valid as arguments to their primary calling codes (integer numbers). Be aware that this map does not contain :phone-number.region/world.

      +

      region-arg-to-calling-codes

      added in 8.12.16-1

      Mapping of all supported regions (keywords) which are valid as arguments to their calling codes (sets of integer numbers). Be aware that this map does not contain :phone-number.region/world.

      +

      region-arg-to-types

      added in 8.12.16-1

      Mapping of all regions (keywords) which are valid as arguments to supported phone number types (sets of keywords). Please be aware that this map does not contain :phone-number.region/world pseudo-region.

      +

      region-arg-to-types-vec

      added in 8.12.16-1

      (region-arg-to-types-vec region-code)

      Returns a vector of phone number types for the given region (which must be suitable to be used as an argument) and caches the result.

      +

      region-to-calling-code

      added in 8.12.16-1

      Mapping of all supported regions (keywords) to their primary calling codes (integer numbers).

      +

      region-to-calling-codes

      added in 8.12.16-1

      Mapping of all supported regions (keywords) to their calling codes (sets of integer numbers).

      +

      region-to-types

      added in 8.12.16-1

      Mapping of all regions (keywords) to supported phone number types (sets of keywords). Please be aware that the :phone-number.region/world pseudo-region groups many calling codes which can vary when it comes to the supported types, hence making this database less precise. To get more granular data for global numbers which are not geographical, please use phone-number.db/calling-code-to-types. For geographical regions this database will be precise.

      +

      region-to-types-vec

      added in 8.12.16-1

      (region-to-types-vec region-code)

      Returns a vector of phone number types for the given region and caches the result.

      +

      regions

      added in 8.12.16-1

      A set of all possible phone number region codes.

      +

      regions-args

      added in 8.12.16-1

      A set of all possible phone number region codes (suitable to be used as arguments).

      +

      type-to-calling-codes

      added in 8.12.16-1

      Mapping of all the supported phone number types (keywords) to sets of calling codes (integer numbers). Please be aware that single country calling code may be used by more than one geographical region (e.g. 1 maps to US, Canada and more), making this database less precise for geographical location. In case of regional numbers consider using phone-number.db/type-to-regions. This database will work precisely with non-geographical, global network calling codes.

      +

      type-to-regions

      added in 8.12.16-1

      Mapping of all supported phone number types (keywords) to regions (sets of keywords). Please be aware that the :phone-number.region/world pseudo-region groups many calling codes which can vary when it comes to the supported types, hence making this database less precise. To get more granular data for global numbers which are not geographical, please use phone-number.db/type-to-calling-codes. For geographical regions this database will be precise.

      +

      type-to-regions-arg

      added in 8.12.16-1

      Mapping of all supported phone number types (keywords) to regions (sets of keywords) which are valid as arguments. Please be aware that this map does not contain :phone-number.region/world pseudo-region within its values.

      +

      types

      added in 8.12.16-1

      A set of all possible phone number types as a set of keywords.

      +

      types-args

      added in 8.12.16-1

      A set of all possible phone number types as a set of keywords (suitable to be used as arguments).

      +

      tz-formats

      added in 8.12.16-1

      A set of all possible time zone formats as a set of keywords.

      +

      tz-formats-args

      added in 8.12.16-1

      A set of all possible time zone formats as a set of keywords (suitable to be used as arguments).

      +
      \ No newline at end of file diff --git a/docs/phone-number.format.html b/docs/phone-number.format.html index e60b019..1eb2b65 100644 --- a/docs/phone-number.format.html +++ b/docs/phone-number.format.html @@ -1,25 +1,25 @@ -phone-number.format documentation

      phone-number.format

      added in 8.12.4-0

      Phone number formats for phone-number.

      +phone-number.format documentation

      phone-number.format

      added in 8.12.4-0

      Phone number formats for phone-number.

      all

      added in 8.12.4-0

      Map of possible format identifiers (keywords) to PhoneNumberFormat values plus an additional value indicating raw input.

      -

      all-arg

      added in 8.12.16-1

      Map of possible format identifiers (keywords) to PhoneNumberFormat values (plus an additional value indicating raw input) suitable to be used as arguments.

      -

      all-arg-vec

      added in 8.12.16-1

      Vector of formats (keywords) suitable to be used as arguments.

      -

      all-vec

      added in 8.12.16-1

      Vector of formats (keywords).

      -

      by-val

      added in 8.12.4-0

      Map of possible PhoneNumberFormat values (plus an additional value indicating raw input) to format identifiers (keywords) suitable to be used as arguments.

      -

      by-val-arg

      added in 8.12.16-1

      Map of possible PhoneNumberFormat values to format identifiers (keywords) suitable to be used as arguments for methods of Libphonenumber.

      -

      by-val-arg-vec

      added in 8.12.16-1

      Vector of formats (PhoneNumberFormat values).

      -

      by-val-vec

      added in 8.12.4-0

      Vector of formats (PhoneNumberFormat values + additional value indicating raw format as keyword).

      -

      calling-coded

      added in 8.12.4-0

      deprecated in 8.12.4-1

      DEPRECATED: use global

      -

      calling-coded?

      added in 8.12.4-0

      deprecated in 8.12.4-1

      (calling-coded? format)

      DEPRECATED: use global?

      -

      default

      added in 8.12.4-0

      default-val

      added in 8.12.4-0

      global

      added in 8.12.4-0

      Set of formats (keywords) that should identify values containing country code information.

      -

      global-vec

      added in 8.12.4-1

      Vector of formats (keywords).

      -

      global?

      added in 8.12.4-0

      (global? format)(global? format use-infer)

      Returns true if the given format contains country code information, false otherwise.

      -

      not-calling-coded

      added in 8.12.4-0

      deprecated in 8.12.4-1

      DEPRECATED: use regional

      -

      not-calling-coded?

      added in 8.12.4-0

      deprecated in 8.12.4-1

      (not-calling-coded? format)

      DEPRECATED: use regional?

      -

      parse

      added in 8.12.4-0

      (parse k)(parse k use-infer)

      Parses a format specification and returns a value that can be supplied to Libphonenumber methods.

      -

      raw

      added in 8.12.16-1

      raw-val

      added in 8.12.16-1

      regional

      added in 8.12.4-0

      Set of formats (keywords) that should identify values containing country code information.

      -

      regional-vec

      added in 8.12.4-1

      Vector of formats (keywords).

      -

      regional?

      added in 8.12.4-0

      (regional? format)(regional? format use-infer)

      Returns true if the given format does not contain country code information, false otherwise.

      -

      valid-arg?

      added in 8.12.4-0

      (valid-arg? format)(valid-arg? format use-infer)

      Returns true if the given format is valid, false otherwise.

      -

      valid?

      added in 8.12.4-0

      (valid? format)(valid? format use-infer)

      Returns true if the given format is valid, false otherwise.

      -
      \ No newline at end of file +

      all-arg

      added in 8.12.16-1

      Map of possible format identifiers (keywords) to PhoneNumberFormat values (plus an additional value indicating raw input) suitable to be used as arguments.

      +

      all-arg-vec

      added in 8.12.16-1

      Vector of formats (keywords) suitable to be used as arguments.

      +

      all-vec

      added in 8.12.16-1

      Vector of formats (keywords).

      +

      by-val

      added in 8.12.4-0

      Map of possible PhoneNumberFormat values (plus an additional value indicating raw input) to format identifiers (keywords) suitable to be used as arguments.

      +

      by-val-arg

      added in 8.12.16-1

      Map of possible PhoneNumberFormat values to format identifiers (keywords) suitable to be used as arguments for methods of Libphonenumber.

      +

      by-val-arg-vec

      added in 8.12.16-1

      Vector of formats (PhoneNumberFormat values).

      +

      by-val-vec

      added in 8.12.4-0

      Vector of formats (PhoneNumberFormat values + additional value indicating raw format as keyword).

      +

      calling-coded

      added in 8.12.4-0

      deprecated in 8.12.4-1

      DEPRECATED: use global

      +

      calling-coded?

      added in 8.12.4-0

      deprecated in 8.12.4-1

      (calling-coded? format)

      DEPRECATED: use global?

      +

      default

      added in 8.12.4-0

      default-val

      added in 8.12.4-0

      global

      added in 8.12.4-0

      Set of formats (keywords) that should identify values containing country code information.

      +

      global-vec

      added in 8.12.4-1

      Vector of formats (keywords).

      +

      global?

      added in 8.12.4-0

      (global? format)(global? format use-infer)

      Returns true if the given format contains country code information, false otherwise.

      +

      not-calling-coded

      added in 8.12.4-0

      deprecated in 8.12.4-1

      DEPRECATED: use regional

      +

      not-calling-coded?

      added in 8.12.4-0

      deprecated in 8.12.4-1

      (not-calling-coded? format)

      DEPRECATED: use regional?

      +

      parse

      added in 8.12.4-0

      (parse k)(parse k use-infer)

      Parses a format specification and returns a value that can be supplied to Libphonenumber methods.

      +

      raw

      added in 8.12.16-1

      raw-val

      added in 8.12.16-1

      regional

      added in 8.12.4-0

      Set of formats (keywords) that should identify values containing country code information.

      +

      regional-vec

      added in 8.12.4-1

      Vector of formats (keywords).

      +

      regional?

      added in 8.12.4-0

      (regional? format)(regional? format use-infer)

      Returns true if the given format does not contain country code information, false otherwise.

      +

      valid-arg?

      added in 8.12.4-0

      (valid-arg? format)(valid-arg? format use-infer)

      Returns true if the given format is valid, false otherwise.

      +

      valid?

      added in 8.12.4-0

      (valid? format)(valid? format use-infer)

      Returns true if the given format is valid, false otherwise.

      +
    \ No newline at end of file diff --git a/docs/phone-number.html b/docs/phone-number.html index 18e6362..3f51b1d 100644 --- a/docs/phone-number.html +++ b/docs/phone-number.html @@ -1,4 +1,4 @@ -phone-number documentation

    phone-number

    added in 8.12.4-2

    Clojure interface to Libphonenumber.

    +phone-number documentation

    phone-number

    added in 8.12.4-2

    Clojure interface to Libphonenumber.

    \ No newline at end of file diff --git a/docs/phone-number.leniency.html b/docs/phone-number.leniency.html index 883abe4..6ca5a7c 100644 --- a/docs/phone-number.leniency.html +++ b/docs/phone-number.leniency.html @@ -1,19 +1,19 @@ -phone-number.leniency documentation

    phone-number.leniency

    added in 8.12.4-3

    Leniency types for phone-number

    +phone-number.leniency documentation

    phone-number.leniency

    added in 8.12.4-3

    Leniency types for phone-number

    all

    added in 8.12.4-3

    Map of leniencies (keywords) to Leniency values.

    -

    all-arg

    added in 8.12.16-1

    Vector of leniencies (keywords) to be used as arguments.

    -

    all-arg-vec

    added in 8.12.16-1

    Vector of leniencies (keywords) to be used as arguments.

    -

    all-vec

    added in 8.12.4-3

    Vector of leniencies (keywords).

    -

    by-val

    added in 8.12.4-3

    Map of Leniency values to leniencies (keywords).

    -

    by-val-arg

    added in 8.12.16-1

    Map of Leniency values to leniencies (keywords) to be used as method arguments.

    -

    by-val-arg-vec

    added in 8.12.16-1

    Vector of leniencies (Leniency values) to be used as method arguments.

    -

    by-val-vec

    added in 8.12.4-3

    Vector of leniencies (Leniency values).

    -

    default

    added in 8.12.4-3

    default-val

    added in 8.12.4-3

    generate-sample

    added in 8.12.4-3

    (generate-sample)(generate-sample rng)

    Generates random leniency.

    -

    generate-sample-arg

    added in 8.12.16-1

    (generate-sample-arg)(generate-sample-arg rng)

    Generates random leniency (suitable as an argument).

    -

    generate-sample-val

    added in 8.12.4-3

    (generate-sample-val)(generate-sample-val rng)

    Generates random leniency (string value).

    -

    generate-sample-val-arg

    added in 8.12.16-1

    (generate-sample-val-arg)(generate-sample-val-arg rng)

    Generates random leniency (string value, suitable as an argument).

    -

    parse

    added in 8.12.4-3

    (parse k)(parse k use-infer)

    Parses a leniency and returns a value that can be supplied to Libphonenumber methods.

    -

    valid-arg?

    added in 8.12.16-1

    (valid-arg? leniency)(valid-arg? leniency use-infer)

    Returns true if the given leniency is a valid leniency to be used as an argument, false otherwise. In its binary form it uses namespace inference.

    -

    valid?

    added in 8.12.4-3

    (valid? leniency)(valid? leniency use-infer)

    Returns true if the given leniency is a valid leniency, false otherwise. In its binary form it uses namespace inference.

    -
    \ No newline at end of file +

    all-arg

    added in 8.12.16-1

    Vector of leniencies (keywords) to be used as arguments.

    +

    all-arg-vec

    added in 8.12.16-1

    Vector of leniencies (keywords) to be used as arguments.

    +

    all-vec

    added in 8.12.4-3

    Vector of leniencies (keywords).

    +

    by-val

    added in 8.12.4-3

    Map of Leniency values to leniencies (keywords).

    +

    by-val-arg

    added in 8.12.16-1

    Map of Leniency values to leniencies (keywords) to be used as method arguments.

    +

    by-val-arg-vec

    added in 8.12.16-1

    Vector of leniencies (Leniency values) to be used as method arguments.

    +

    by-val-vec

    added in 8.12.4-3

    Vector of leniencies (Leniency values).

    +

    default

    added in 8.12.4-3

    default-val

    added in 8.12.4-3

    generate-sample

    added in 8.12.4-3

    (generate-sample)(generate-sample rng)

    Generates random leniency.

    +

    generate-sample-arg

    added in 8.12.16-1

    (generate-sample-arg)(generate-sample-arg rng)

    Generates random leniency (suitable as an argument).

    +

    generate-sample-val

    added in 8.12.4-3

    (generate-sample-val)(generate-sample-val rng)

    Generates random leniency (string value).

    +

    generate-sample-val-arg

    added in 8.12.16-1

    (generate-sample-val-arg)(generate-sample-val-arg rng)

    Generates random leniency (string value, suitable as an argument).

    +

    parse

    added in 8.12.4-3

    (parse k)(parse k use-infer)

    Parses a leniency and returns a value that can be supplied to Libphonenumber methods.

    +

    valid-arg?

    added in 8.12.16-1

    (valid-arg? leniency)(valid-arg? leniency use-infer)

    Returns true if the given leniency is a valid leniency to be used as an argument, false otherwise. In its binary form it uses namespace inference.

    +

    valid?

    added in 8.12.4-3

    (valid? leniency)(valid? leniency use-infer)

    Returns true if the given leniency is a valid leniency, false otherwise. In its binary form it uses namespace inference.

    +
    \ No newline at end of file diff --git a/docs/phone-number.locale.html b/docs/phone-number.locale.html index b99b313..fd4bb6a 100644 --- a/docs/phone-number.locale.html +++ b/docs/phone-number.locale.html @@ -1,20 +1,20 @@ -phone-number.locale documentation

    phone-number.locale

    added in 8.12.4-3

    Locale support for phone-number

    +phone-number.locale documentation

    phone-number.locale

    added in 8.12.4-3

    Locale support for phone-number

    all

    added in 8.12.4-3

    Map of locales (keywords) to Locale values.

    -

    all-arg

    added in 8.12.16-1

    Map of locales (keywords) to Locale values suitable to be passed as arguments.

    -

    all-arg-vec

    added in 8.12.16-1

    Vector of locales (keywords) suitable to be used as arguments.

    -

    all-vec

    added in 8.12.4-3

    Vector of locales (keywords).

    -

    available

    added in 8.12.4-3

    Set of available locale (keywords).

    -

    by-val

    added in 8.12.4-3

    Map of Locale values to locales (keywords).

    -

    by-val-arg

    added in 8.12.16-1

    Map of Locale values to locales (keywords) suitable to be passed as method arguments.

    -

    by-val-arg-vec

    added in 8.12.16-1

    Vector of locales (Locale values) suitable to be used as method arguments.

    -

    by-val-vec

    added in 8.12.4-3

    Vector of locales (Locale values).

    -

    default

    added in 8.12.4-3

    default-val

    added in 8.12.4-3

    generate-sample

    added in 8.12.4-3

    (generate-sample)(generate-sample rng)

    Generates random locale.

    -

    generate-sample-val

    added in 8.12.4-3

    (generate-sample-val)(generate-sample-val rng)

    Generates random locale (string value).

    -

    parse

    added in 8.12.4-3

    (parse locale-specification)(parse locale-specification use-infer)

    Parses locale. If it is a java.util.Locale object it returns it. If it’s not keyword then it parses it by calling trptr.java-wrapper.locale/locale. If it is a keyword it first tries to infer a namespace (if not present and the use-infer is set to some truthy value) and then looks it up in locales map. If the value is found, returns the associated Locale object. Otherwise it falls back to getting locale using the function from trptr.java-wrapper.locale/locale (before doing so it strips any namespace from a keyword, if found).

    -

    strictly-valid-arg?

    added in 8.12.4-3

    (strictly-valid-arg? locale-specification)(strictly-valid-arg? locale-specification use-infer)

    Returns true if the given locale specification is valid and supported, false otherwise. For nil it returns false and for keywords it only checks if they are in the locale map (phone-number.locale/all). If the key is not there, it returns false. Namespace inference is supported using the second argument (the default is not to infer).

    -

    strictly-valid?

    added in 8.12.16-1

    (strictly-valid? locale-specification)(strictly-valid? locale-specification use-infer)

    Returns true if the given locale specification is valid and supported, false otherwise. For nil it returns false and for keywords it only checks if they are in the locale map (phone-number.locale/all). If the key is not there, it returns false. Namespace inference is supported using the second argument (the default is not to infer).

    -

    valid-arg?

    added in 8.12.4-3

    (valid-arg? locale-specification)(valid-arg? locale-specification use-infer)(valid-arg? locale-specification use-infer strict)

    Returns true if the given locale specification is valid and supported, false otherwise. For nil it returns true assuming it will be a default, system locale. If strict flag is set then for nil value it returns false and for keywords it only checks if they are in the locale map (phone-number.locale/all).

    -

    valid?

    added in 8.12.16-1

    (valid? locale-specification)(valid? locale-specification use-infer)(valid? locale-specification use-infer strict)

    Returns true if the given locale specification is valid and supported, false otherwise. For nil it returns true assuming it will be a default, system locale. If strict flag is set then for nil value it returns false and for keywords it only checks if they are in the locale map (phone-number.locale/all).

    -
    \ No newline at end of file +

    all-arg

    added in 8.12.16-1

    Map of locales (keywords) to Locale values suitable to be passed as arguments.

    +

    all-arg-vec

    added in 8.12.16-1

    Vector of locales (keywords) suitable to be used as arguments.

    +

    all-vec

    added in 8.12.4-3

    Vector of locales (keywords).

    +

    available

    added in 8.12.4-3

    Set of available locale (keywords).

    +

    by-val

    added in 8.12.4-3

    Map of Locale values to locales (keywords).

    +

    by-val-arg

    added in 8.12.16-1

    Map of Locale values to locales (keywords) suitable to be passed as method arguments.

    +

    by-val-arg-vec

    added in 8.12.16-1

    Vector of locales (Locale values) suitable to be used as method arguments.

    +

    by-val-vec

    added in 8.12.4-3

    Vector of locales (Locale values).

    +

    default

    added in 8.12.4-3

    default-val

    added in 8.12.4-3

    generate-sample

    added in 8.12.4-3

    (generate-sample)(generate-sample rng)

    Generates random locale.

    +

    generate-sample-val

    added in 8.12.4-3

    (generate-sample-val)(generate-sample-val rng)

    Generates random locale (string value).

    +

    parse

    added in 8.12.4-3

    (parse locale-specification)(parse locale-specification use-infer)

    Parses locale. If it is a java.util.Locale object it returns it. If it’s not keyword then it parses it by calling trptr.java-wrapper.locale/locale. If it is a keyword it first tries to infer a namespace (if not present and the use-infer is set to some truthy value) and then looks it up in locales map. If the value is found, returns the associated Locale object. Otherwise it falls back to getting locale using the function from trptr.java-wrapper.locale/locale (before doing so it strips any namespace from a keyword, if found).

    +

    strictly-valid-arg?

    added in 8.12.4-3

    (strictly-valid-arg? locale-specification)(strictly-valid-arg? locale-specification use-infer)

    Returns true if the given locale specification is valid and supported, false otherwise. For nil it returns false and for keywords it only checks if they are in the locale map (phone-number.locale/all). If the key is not there, it returns false. Namespace inference is supported using the second argument (the default is not to infer).

    +

    strictly-valid?

    added in 8.12.16-1

    (strictly-valid? locale-specification)(strictly-valid? locale-specification use-infer)

    Returns true if the given locale specification is valid and supported, false otherwise. For nil it returns false and for keywords it only checks if they are in the locale map (phone-number.locale/all). If the key is not there, it returns false. Namespace inference is supported using the second argument (the default is not to infer).

    +

    valid-arg?

    added in 8.12.4-3

    (valid-arg? locale-specification)(valid-arg? locale-specification use-infer)(valid-arg? locale-specification use-infer strict)

    Returns true if the given locale specification is valid and supported, false otherwise. For nil it returns true assuming it will be a default, system locale. If strict flag is set then for nil value it returns false and for keywords it only checks if they are in the locale map (phone-number.locale/all).

    +

    valid?

    added in 8.12.16-1

    (valid? locale-specification)(valid? locale-specification use-infer)(valid? locale-specification use-infer strict)

    Returns true if the given locale specification is valid and supported, false otherwise. For nil it returns true assuming it will be a default, system locale. If strict flag is set then for nil value it returns false and for keywords it only checks if they are in the locale map (phone-number.locale/all).

    +
    \ No newline at end of file diff --git a/docs/phone-number.match.html b/docs/phone-number.match.html index 6d9ff4e..1b3b8d9 100644 --- a/docs/phone-number.match.html +++ b/docs/phone-number.match.html @@ -1,9 +1,9 @@ -phone-number.match documentation

    phone-number.match

    added in 8.12.4-0

    Match types for phone-number

    +phone-number.match documentation

    phone-number.match

    added in 8.12.4-0

    Match types for phone-number

    all

    added in 8.12.4-0

    Map of phone number matches (keywords) to MatchType values.

    -

    all-arg

    added in 8.12.16-1

    Map of phone number matches (keywords) to MatchType values to be used as arguments.

    -

    by-val

    added in 8.12.4-0

    Map of MatchType values to phone number matches (keywords).

    -

    by-val-arg

    added in 8.12.16-1

    Map of MatchType values to phone number matches (keywords) to be used as arguments.

    -

    mapper

    added in 8.12.4-0

    (mapper m)

    Generates a map from PhoneNumberMatch object.

    -

    none

    added in 8.12.16-1

    none-val

    added in 8.12.16-1

    \ No newline at end of file +

    all-arg

    added in 8.12.16-1

    Map of phone number matches (keywords) to MatchType values to be used as arguments.

    +

    by-val

    added in 8.12.4-0

    Map of MatchType values to phone number matches (keywords).

    +

    by-val-arg

    added in 8.12.16-1

    Map of MatchType values to phone number matches (keywords) to be used as arguments.

    +

    mapper

    added in 8.12.4-0

    (mapper m)

    Generates a map from PhoneNumberMatch object.

    +

    none

    added in 8.12.16-1

    none-val

    added in 8.12.16-1

    \ No newline at end of file diff --git a/docs/phone-number.net-code.html b/docs/phone-number.net-code.html index 6a03add..6dcc5db 100644 --- a/docs/phone-number.net-code.html +++ b/docs/phone-number.net-code.html @@ -1,19 +1,19 @@ -phone-number.net-code documentation

    phone-number.net-code

    added in 8.12.4-0

    Global network calling codes handling for phone-number.

    +phone-number.net-code documentation

    phone-number.net-code

    added in 8.12.4-0

    Global network calling codes handling for phone-number.

    all

    added in 8.12.16-1

    Set of supported global network calling codes.

    -

    all-arg

    added in 8.12.4-0

    Set of supported global network calling codes (to be used as arguments).

    -

    all-arg-vec

    added in 8.12.16-1

    Vector of all supported global network calling codes (valid as args).

    -

    all-vec

    added in 8.12.4-0

    Vector of all supported global network calling codes.

    -

    by-val

    added in 8.12.16-1

    Set of supported values of global network calling codes.

    -

    by-val-arg

    added in 8.12.16-1

    Set of supported values of global network calling codes (to be used as method arguments).

    -

    by-val-arg-vec

    added in 8.12.16-1

    Vector of all supported global network calling codes (valid as args).

    -

    by-val-vec

    added in 8.12.16-1

    Vector of all supported global network calling codes.

    -

    generate-arg-sample

    added in 8.12.16-1

    (generate-arg-sample)(generate-arg-sample rng)

    Generates random global network calling code.

    -

    generate-arg-sample-val

    added in 8.12.16-1

    (generate-arg-sample-val)(generate-arg-sample-val rng)

    Generates random global network calling code.

    -

    generate-sample

    added in 8.12.4-0

    (generate-sample)(generate-sample rng)

    Generates random global network calling code.

    -

    generate-sample-val

    added in 8.12.16-1

    (generate-sample-val)(generate-sample-val rng)

    Generates random global network calling code.

    -

    parse

    added in 8.12.4-0

    (parse calling-code)

    Parses a network calling code and returns a value that can be supplied to Libphonenumber methods.

    -

    valid-arg?

    added in 8.12.16-1

    (valid-arg? calling-code)

    Returns true if the given region-specification is a valid region code (to be used as an argument), false otherwise.

    -

    valid?

    added in 8.12.4-0

    (valid? calling-code)

    Returns true if the given region-specification is a valid region code, false otherwise.

    -
    \ No newline at end of file +

    all-arg

    added in 8.12.4-0

    Set of supported global network calling codes (to be used as arguments).

    +

    all-arg-vec

    added in 8.12.16-1

    Vector of all supported global network calling codes (valid as args).

    +

    all-vec

    added in 8.12.4-0

    Vector of all supported global network calling codes.

    +

    by-val

    added in 8.12.16-1

    Set of supported values of global network calling codes.

    +

    by-val-arg

    added in 8.12.16-1

    Set of supported values of global network calling codes (to be used as method arguments).

    +

    by-val-arg-vec

    added in 8.12.16-1

    Vector of all supported global network calling codes (valid as args).

    +

    by-val-vec

    added in 8.12.16-1

    Vector of all supported global network calling codes.

    +

    generate-arg-sample

    added in 8.12.16-1

    (generate-arg-sample)(generate-arg-sample rng)

    Generates random global network calling code.

    +

    generate-arg-sample-val

    added in 8.12.16-1

    (generate-arg-sample-val)(generate-arg-sample-val rng)

    Generates random global network calling code.

    +

    generate-sample

    added in 8.12.4-0

    (generate-sample)(generate-sample rng)

    Generates random global network calling code.

    +

    generate-sample-val

    added in 8.12.16-1

    (generate-sample-val)(generate-sample-val rng)

    Generates random global network calling code.

    +

    parse

    added in 8.12.4-0

    (parse calling-code)

    Parses a network calling code and returns a value that can be supplied to Libphonenumber methods.

    +

    valid-arg?

    added in 8.12.16-1

    (valid-arg? calling-code)

    Returns true if the given region-specification is a valid region code (to be used as an argument), false otherwise.

    +

    valid?

    added in 8.12.4-0

    (valid? calling-code)

    Returns true if the given region-specification is a valid region code, false otherwise.

    +
    \ No newline at end of file diff --git a/docs/phone-number.region.html b/docs/phone-number.region.html index c45949d..489c370 100644 --- a/docs/phone-number.region.html +++ b/docs/phone-number.region.html @@ -1,21 +1,21 @@ -phone-number.region documentation

    phone-number.region

    added in 8.12.4-0

    Region handling for phone-number.

    +phone-number.region documentation

    phone-number.region

    added in 8.12.4-0

    Region handling for phone-number.

    all

    added in 8.12.4-0

    Mapping of supported regions (keywords) to region values (strings).

    -

    all-arg

    added in 8.12.4-0

    Mapping of supported regions (keywords) to region values (strings) suitable to be used as arguments.

    -

    all-arg-vec

    added in 8.12.4-0

    Vector of regions (keywords).

    -

    all-vec

    added in 8.12.4-0

    Vector of regions (keywords).

    -

    by-val

    added in 8.12.4-0

    Mapping of supported region values (strings) to regions (keywords).

    -

    by-val-arg

    added in 8.12.4-0

    Mapping of supported region values (strings) to regions (keywords).

    -

    by-val-arg-vec

    added in 8.12.4-0

    Vector of regions (string values).

    -

    by-val-vec

    added in 8.12.4-0

    Vector of regions (string values).

    -

    default

    added in 8.12.4-0

    default-val

    added in 8.12.4-0

    generate-arg-sample

    added in 8.12.4-0

    (generate-arg-sample)(generate-arg-sample rng)

    Generates random region code.

    -

    generate-arg-sample-val

    added in 8.12.4-0

    (generate-arg-sample-val)(generate-arg-sample-val rng)

    Generates random region code (string value).

    -

    generate-sample

    added in 8.12.4-0

    (generate-sample)(generate-sample rng)

    Generates random region code.

    -

    generate-sample-val

    added in 8.12.4-0

    (generate-sample-val)(generate-sample-val rng)

    Generates random region code (string value).

    -

    non-geo

    added in 8.12.16-1

    non-geo-val

    added in 8.12.16-1

    normalize

    added in 8.12.16-1

    (normalize k)(normalize k use-infer)

    Parses a region code and returns its normalized version.

    -

    normalize-arg

    added in 8.12.16-1

    (normalize-arg k)(normalize-arg k use-infer)

    Parses a region code and returns its normalized version that can be used as an argument.

    -

    parse

    added in 8.12.4-0

    (parse k)(parse k use-infer)

    Parses a region code and returns a value that can be supplied to Libphonenumber methods.

    -

    valid-arg?

    added in 8.12.4-0

    (valid-arg? region-specification)(valid-arg? region-specification use-infer)

    Returns true if the given region-specification is a valid region code, false otherwise. In its binary form it uses namespace inference.

    -

    valid?

    added in 8.12.4-0

    (valid? region-specification)(valid? region-specification use-infer)

    Returns true if the given region-specification is a valid region code, false otherwise. In its binary form it uses namespace inference.

    -
    \ No newline at end of file +

    all-arg

    added in 8.12.4-0

    Mapping of supported regions (keywords) to region values (strings) suitable to be used as arguments.

    +

    all-arg-vec

    added in 8.12.4-0

    Vector of regions (keywords).

    +

    all-vec

    added in 8.12.4-0

    Vector of regions (keywords).

    +

    by-val

    added in 8.12.4-0

    Mapping of supported region values (strings) to regions (keywords).

    +

    by-val-arg

    added in 8.12.4-0

    Mapping of supported region values (strings) to regions (keywords).

    +

    by-val-arg-vec

    added in 8.12.4-0

    Vector of regions (string values).

    +

    by-val-vec

    added in 8.12.4-0

    Vector of regions (string values).

    +

    default

    added in 8.12.4-0

    default-val

    added in 8.12.4-0

    generate-arg-sample

    added in 8.12.4-0

    (generate-arg-sample)(generate-arg-sample rng)

    Generates random region code.

    +

    generate-arg-sample-val

    added in 8.12.4-0

    (generate-arg-sample-val)(generate-arg-sample-val rng)

    Generates random region code (string value).

    +

    generate-sample

    added in 8.12.4-0

    (generate-sample)(generate-sample rng)

    Generates random region code.

    +

    generate-sample-val

    added in 8.12.4-0

    (generate-sample-val)(generate-sample-val rng)

    Generates random region code (string value).

    +

    non-geo

    added in 8.12.16-1

    non-geo-val

    added in 8.12.16-1

    normalize

    added in 8.12.16-1

    (normalize k)(normalize k use-infer)

    Parses a region code and returns its normalized version.

    +

    normalize-arg

    added in 8.12.16-1

    (normalize-arg k)(normalize-arg k use-infer)

    Parses a region code and returns its normalized version that can be used as an argument.

    +

    parse

    added in 8.12.4-0

    (parse k)(parse k use-infer)

    Parses a region code and returns a value that can be supplied to Libphonenumber methods.

    +

    valid-arg?

    added in 8.12.4-0

    (valid-arg? region-specification)(valid-arg? region-specification use-infer)

    Returns true if the given region-specification is a valid region code, false otherwise. In its binary form it uses namespace inference.

    +

    valid?

    added in 8.12.4-0

    (valid? region-specification)(valid? region-specification use-infer)

    Returns true if the given region-specification is a valid region code, false otherwise. In its binary form it uses namespace inference.

    +
    \ No newline at end of file diff --git a/docs/phone-number.type.html b/docs/phone-number.type.html index 6416a6d..3f926e8 100644 --- a/docs/phone-number.type.html +++ b/docs/phone-number.type.html @@ -1,19 +1,19 @@ -phone-number.type documentation

    phone-number.type

    added in 8.12.4-0

    Phone number types for phone-number.

    +phone-number.type documentation

    phone-number.type

    added in 8.12.4-0

    Phone number types for phone-number.

    all

    added in 8.12.4-0

    Map of phone number types (keywords) to PhoneNumberType values.

    -

    all-arg

    added in 8.12.4-0

    Map of PhoneNumberType values to phone number types (keywords) suitable to be passed as arguments.

    -

    all-arg-vec

    added in 8.12.4-0

    Vector of types (keywords).

    -

    all-vec

    added in 8.12.4-0

    Vector of types (keywords).

    -

    by-val

    added in 8.12.4-0

    Map of PhoneNumberType values to phone number types (keywords).

    -

    by-val-arg

    added in 8.12.4-0

    Map of PhoneNumberType values to phone number types (keywords).

    -

    by-val-arg-vec

    added in 8.12.4-0

    Vector of types (PhoneNumberType values).

    -

    by-val-vec

    added in 8.12.4-0

    Vector of types (PhoneNumberType values).

    -

    default

    added in 8.12.4-0

    default-val

    added in 8.12.4-0

    generate-arg-sample

    added in 8.12.4-0

    (generate-arg-sample)(generate-arg-sample rng)

    Generates random number type suitable to be used as value of an argument.

    -

    generate-arg-sample-val

    added in 8.12.16-1

    (generate-arg-sample-val)(generate-arg-sample-val rng)

    Generates random number type (PhoneNumberType value) suitable to be used as value of an argument.

    -

    generate-sample

    added in 8.12.4-0

    (generate-sample)(generate-sample rng)

    Generates random number type.

    -

    generate-sample-val

    added in 8.12.4-0

    (generate-sample-val)(generate-sample-val rng)

    Generates random number type (PhoneNumberType value).

    -

    parse

    added in 8.12.4-0

    (parse k)(parse k use-infer)

    Parses a type and returns a value that can be supplied to Libphonenumber methods. If nil is given it returns the default value.

    -

    unknown

    added in 8.12.16-1

    unknown-val

    added in 8.12.16-1

    valid-arg?

    added in 8.12.4-0

    (valid-arg? number-type)(valid-arg? number-type use-infer)

    Returns true if the given number-type is valid, false otherwise. Excludes unknown type from the valid list.

    -

    valid?

    added in 8.12.4-0

    (valid? number-type)(valid? number-type use-infer)

    Returns true if the given number-type is valid, false otherwise. Use valid-arg? for argument testing when building phone numbers.

    -
    \ No newline at end of file +

    all-arg

    added in 8.12.4-0

    Map of PhoneNumberType values to phone number types (keywords) suitable to be passed as arguments.

    +

    all-arg-vec

    added in 8.12.4-0

    Vector of types (keywords).

    +

    all-vec

    added in 8.12.4-0

    Vector of types (keywords).

    +

    by-val

    added in 8.12.4-0

    Map of PhoneNumberType values to phone number types (keywords).

    +

    by-val-arg

    added in 8.12.4-0

    Map of PhoneNumberType values to phone number types (keywords).

    +

    by-val-arg-vec

    added in 8.12.4-0

    Vector of types (PhoneNumberType values).

    +

    by-val-vec

    added in 8.12.4-0

    Vector of types (PhoneNumberType values).

    +

    default

    added in 8.12.4-0

    default-val

    added in 8.12.4-0

    generate-arg-sample

    added in 8.12.4-0

    (generate-arg-sample)(generate-arg-sample rng)

    Generates random number type suitable to be used as value of an argument.

    +

    generate-arg-sample-val

    added in 8.12.16-1

    (generate-arg-sample-val)(generate-arg-sample-val rng)

    Generates random number type (PhoneNumberType value) suitable to be used as value of an argument.

    +

    generate-sample

    added in 8.12.4-0

    (generate-sample)(generate-sample rng)

    Generates random number type.

    +

    generate-sample-val

    added in 8.12.4-0

    (generate-sample-val)(generate-sample-val rng)

    Generates random number type (PhoneNumberType value).

    +

    parse

    added in 8.12.4-0

    (parse k)(parse k use-infer)

    Parses a type and returns a value that can be supplied to Libphonenumber methods. If nil is given it returns the default value.

    +

    unknown

    added in 8.12.16-1

    unknown-val

    added in 8.12.16-1

    valid-arg?

    added in 8.12.4-0

    (valid-arg? number-type)(valid-arg? number-type use-infer)

    Returns true if the given number-type is valid, false otherwise. Excludes unknown type from the valid list.

    +

    valid?

    added in 8.12.4-0

    (valid? number-type)(valid? number-type use-infer)

    Returns true if the given number-type is valid, false otherwise. Use valid-arg? for argument testing when building phone numbers.

    +
    \ No newline at end of file diff --git a/docs/phone-number.tz-format.html b/docs/phone-number.tz-format.html index f0d0011..32f979a 100644 --- a/docs/phone-number.tz-format.html +++ b/docs/phone-number.tz-format.html @@ -1,16 +1,16 @@ -phone-number.tz-format documentation

    phone-number.tz-format

    added in 8.12.4-0

    Time zone formats for phone-number.

    +phone-number.tz-format documentation

    phone-number.tz-format

    added in 8.12.4-0

    Time zone formats for phone-number.

    all

    added in 8.12.4-0

    Map of time zone formats (keywords) to TextStyle objects for time zone formatting.

    -

    all-arg

    added in 8.12.16-1

    Map of TextStyle objects to time zone formats (keywords) for time zone formatting (to be used as arguments).

    -

    all-arg-vec

    added in 8.12.16-1

    Vector of time zone formats (keywords) to be used as arguments.

    -

    all-vec

    added in 8.12.4-0

    Vector of time zone formats (keywords).

    -

    by-val

    added in 8.12.16-1

    Map of time zone formats to TextStyle objects.

    -

    by-val-arg

    added in 8.12.16-1

    Map of time zone formats as TextStyle objects mapped to keywords (values accepted by Libphonenumber methods).

    -

    by-val-arg-vec

    added in 8.12.16-1

    Vector of time zone values suitable to be passed as arguments to methods of Libphonenumber.

    -

    by-val-vec

    added in 8.12.16-1

    Vector of time zone values.

    -

    default

    added in 8.12.4-0

    default-val

    added in 8.12.4-0

    parse

    added in 8.12.4-0

    (parse k)(parse k use-infer)

    Parses a time zone format specification and returns a value that can be supplied to phone-number functions. If nil is given it returns the default value.

    -

    transform

    added in 8.12.4-0

    (transform zone-id l style)

    For the given Locale object and TextStyle object renders a string describing a time zone identifier (given as a string) passed as the first argument. If the style is nil then the original object passed as a zone-id argument is returned.

    -

    valid-arg?

    added in 8.12.16-1

    (valid-arg? tz-format)(valid-arg? tz-format use-infer)

    Returns true if the given tz-format is valid as an argument, false otherwise.

    -

    valid?

    added in 8.12.4-0

    (valid? tz-format)(valid? tz-format use-infer)

    Returns true if the given tz-format is valid, false otherwise.

    -
    \ No newline at end of file +

    all-arg

    added in 8.12.16-1

    Map of TextStyle objects to time zone formats (keywords) for time zone formatting (to be used as arguments).

    +

    all-arg-vec

    added in 8.12.16-1

    Vector of time zone formats (keywords) to be used as arguments.

    +

    all-vec

    added in 8.12.4-0

    Vector of time zone formats (keywords).

    +

    by-val

    added in 8.12.16-1

    Map of time zone formats to TextStyle objects.

    +

    by-val-arg

    added in 8.12.16-1

    Map of time zone formats as TextStyle objects mapped to keywords (values accepted by Libphonenumber methods).

    +

    by-val-arg-vec

    added in 8.12.16-1

    Vector of time zone values suitable to be passed as arguments to methods of Libphonenumber.

    +

    by-val-vec

    added in 8.12.16-1

    Vector of time zone values.

    +

    default

    added in 8.12.4-0

    default-val

    added in 8.12.4-0

    parse

    added in 8.12.4-0

    (parse k)(parse k use-infer)

    Parses a time zone format specification and returns a value that can be supplied to phone-number functions. If nil is given it returns the default value.

    +

    transform

    added in 8.12.4-0

    (transform zone-id l style)

    For the given Locale object and TextStyle object renders a string describing a time zone identifier (given as a string) passed as the first argument. If the style is nil then the original object passed as a zone-id argument is returned.

    +

    valid-arg?

    added in 8.12.16-1

    (valid-arg? tz-format)(valid-arg? tz-format use-infer)

    Returns true if the given tz-format is valid as an argument, false otherwise.

    +

    valid?

    added in 8.12.4-0

    (valid? tz-format)(valid? tz-format use-infer)

    Returns true if the given tz-format is valid, false otherwise.

    +
    \ No newline at end of file diff --git a/docs/phone-number.util.html b/docs/phone-number.util.html index a2acdd4..2bd2194 100644 --- a/docs/phone-number.util.html +++ b/docs/phone-number.util.html @@ -1,27 +1,27 @@ -phone-number.util documentation

    phone-number.util

    added in 8.12.4-0

    Singleton wrappers and helpers for phone-number.

    +phone-number.util documentation

    phone-number.util

    added in 8.12.4-0

    Singleton wrappers and helpers for phone-number.

    available-locales

    added in 8.12.4-1

    deprecated in 8.12.4-3

    DEPRECATED: Please use phone-number.locale/by-val-vec.

    -

    available-locales-vec

    added in 8.12.4-1

    deprecated in 8.12.4-3

    DEPRECATED: Please use phone-number.locale/by-val-vec.

    -

    carrier-mapper

    added in 8.12.4-0

    (carrier-mapper)

    char-ranges->set

    added in 8.12.4-1

    (char-ranges->set & ranges)

    Returns a set of characters defined as a collection of collections with start and stop character, e.g.: \A \Z

    -

    count-digits

    added in 8.12.4-1

    (count-digits n)

    fmap-k

    added in 8.12.4-0

    (fmap-k f m)(fmap-k f m dst)

    For each key and value of the given map m calls a function passed as the first argument (passing successive keys during calls to it) and generates a map with values updated by the results returned by the function. When the third argument is given it should be a map on which operations are performed instead of using the original map. This may be helpful when we want to avoid merging the results with another map.

    -

    fmap-v

    added in 8.12.16-1

    (fmap-v f m)(fmap-v f m dst)

    For each key and value of the given map m calls a function passed as the first argument (passing successive values during calls to it) and generates a map with values updated by the results returned by the function. When the third argument is given it should be a map on which operations are performed instead of using the original map. This may be helpful when we want to avoid merging the results with another map.

    -

    gen-digits

    added in 8.12.4-0

    (gen-digits num)(gen-digits num rng)

    Generates the given number of random digits and converts all into a single string. When the second argument is present it should be an instance of random number generator used to get the digits.

    -

    gen-is

    macro

    added in 8.12.4-0

    (gen-is k f)

    For the given keyword k and function name f uses gen-is-sexp to generate predicate function definitions.

    -

    gen-ises

    macro

    added in 8.12.4-0

    (gen-ises coll f)

    Takes a collection of keywords (evaluated) and a function expressed as a symbol (not evaluated) and generates bunch of function definitions using gen-is-sexp.

    -

    geo-coder

    added in 8.12.4-0

    (geo-coder)

    get-rand-int

    added in 8.12.4-0

    (get-rand-int n)(get-rand-int n rng)

    Like rand-int but optionally uses random number generator.

    -

    get-rand-nth

    added in 8.12.4-0

    (get-rand-nth v)(get-rand-nth v rng)

    Returns a random element of the given vector. When the second argument is present it should be an instance of random number generator used to get the random position.

    -

    inferred-contains?

    added in 8.12.4-0

    (inferred-contains? coll k)

    Just like the contains? but if the keyword is namespace-qualified it also checks if the collection contains the same keyword as its key but without a namespace.

    -

    inferred-get

    added in 8.12.4-0

    (inferred-get coll k)(inferred-get coll k default)

    Just like the get function but if the keyword is namespace-qualified it first attempts to look for the value associated with it. If that fails it uses the variant of the keyword without any namespace.

    -

    instance

    added in 8.12.4-0

    (instance)

    lazy-iterator-seq

    added in 8.12.4-0

    (lazy-iterator-seq coll)(lazy-iterator-seq coll iter)

    Returns a lazy sequence as an interface to the given iterable Java object.

    -

    map-of-sets-invert

    added in 8.12.16-1

    (map-of-sets-invert m)

    Like clojure.set/map-invert but for map of sets (as values) to preserve all possible values (as keys of newly created map).

    -

    ns-infer

    added in 8.12.4-0

    (ns-infer ns-name k)(ns-infer ns-name k use-infer)

    Takes a string of namespace name and a keyword. If the given keyword is not namespace-qualified it returns a new keyword with the given namespace added. If the given keyword is already equipped with a namespace it returns it.

    -

    random-digits-len

    added in 8.12.4-0

    (random-digits-len x iteration shrink-now)(random-digits-len x iteration shrink-now rng)

    For 0 or 1 it returns its argument. For other positive numbers it returns a random natural number from 1 to this number (inclusive) in 50% cases. In other 50% cases it returns its argument.

    -

    remove-empty-vals

    added in 8.12.4-0

    (remove-empty-vals m)

    Removes empty values from a map.

    -

    short

    added in 8.12.4-0

    (short)

    time-zones-mapper

    added in 8.12.4-0

    (time-zones-mapper)

    try-null

    macro

    added in 8.12.4-0

    (try-null & body)

    Evaluates body and if NullPointerException exception is caught it returns nil. Otherwise it returns the value of last expression in the body.

    -

    try-parse

    macro

    added in 8.12.4-0

    (try-parse & body)

    Evaluates body and if NumberParseException or NumberFormatException exception is caught it returns nil.

    -

    try-parse-or-false

    macro

    added in 8.12.4-0

    (try-parse-or-false & body)

    Evaluates body and if NumberParseException or NumberFormatException exception is caught it returns false.

    -

    valid-locale?

    added in 8.12.4-1

    deprecated in 8.12.4-3

    (valid-locale? locale-specification)

    DEPRECATED: Please use phone-number.locale/valid?.

    -

    when-not-empty

    macro

    added in 8.12.16-1

    (when-not-empty val & body)

    Evaluates body when the given value is a non-empty collection.

    -

    with-not-empty

    added in 8.12.16-1

    (with-not-empty obj)

    Returns the collection if it’s not empty. Otherwise returns nil.

    -
    \ No newline at end of file +

    available-locales-vec

    added in 8.12.4-1

    deprecated in 8.12.4-3

    DEPRECATED: Please use phone-number.locale/by-val-vec.

    +

    carrier-mapper

    added in 8.12.4-0

    (carrier-mapper)

    char-ranges->set

    added in 8.12.4-1

    (char-ranges->set & ranges)

    Returns a set of characters defined as a collection of collections with start and stop character, e.g.: \A \Z

    +

    count-digits

    added in 8.12.4-1

    (count-digits n)

    fmap-k

    added in 8.12.4-0

    (fmap-k f m)(fmap-k f m dst)

    For each key and value of the given map m calls a function passed as the first argument (passing successive keys during calls to it) and generates a map with values updated by the results returned by the function. When the third argument is given it should be a map on which operations are performed instead of using the original map. This may be helpful when we want to avoid merging the results with another map.

    +

    fmap-v

    added in 8.12.16-1

    (fmap-v f m)(fmap-v f m dst)

    For each key and value of the given map m calls a function passed as the first argument (passing successive values during calls to it) and generates a map with values updated by the results returned by the function. When the third argument is given it should be a map on which operations are performed instead of using the original map. This may be helpful when we want to avoid merging the results with another map.

    +

    gen-digits

    added in 8.12.4-0

    (gen-digits num)(gen-digits num rng)

    Generates the given number of random digits and converts all into a single string. When the second argument is present it should be an instance of random number generator used to get the digits.

    +

    gen-is

    macro

    added in 8.12.4-0

    (gen-is k f)

    For the given keyword k and function name f uses gen-is-sexp to generate predicate function definitions.

    +

    gen-ises

    macro

    added in 8.12.4-0

    (gen-ises coll f)

    Takes a collection of keywords (evaluated) and a function expressed as a symbol (not evaluated) and generates bunch of function definitions using gen-is-sexp.

    +

    geo-coder

    added in 8.12.4-0

    (geo-coder)

    get-rand-int

    added in 8.12.4-0

    (get-rand-int n)(get-rand-int n rng)

    Like rand-int but optionally uses random number generator.

    +

    get-rand-nth

    added in 8.12.4-0

    (get-rand-nth v)(get-rand-nth v rng)

    Returns a random element of the given vector. When the second argument is present it should be an instance of random number generator used to get the random position.

    +

    inferred-contains?

    added in 8.12.4-0

    (inferred-contains? coll k)

    Just like the contains? but if the keyword is namespace-qualified it also checks if the collection contains the same keyword as its key but without a namespace.

    +

    inferred-get

    added in 8.12.4-0

    (inferred-get coll k)(inferred-get coll k default)

    Just like the get function but if the keyword is namespace-qualified it first attempts to look for the value associated with it. If that fails it uses the variant of the keyword without any namespace.

    +

    instance

    added in 8.12.4-0

    (instance)

    lazy-iterator-seq

    added in 8.12.4-0

    (lazy-iterator-seq coll)(lazy-iterator-seq coll iter)

    Returns a lazy sequence as an interface to the given iterable Java object.

    +

    map-of-sets-invert

    added in 8.12.16-1

    (map-of-sets-invert m)

    Like clojure.set/map-invert but for map of sets (as values) to preserve all possible values (as keys of newly created map).

    +

    ns-infer

    added in 8.12.4-0

    (ns-infer ns-name k)(ns-infer ns-name k use-infer)

    Takes a string of namespace name and a keyword. If the given keyword is not namespace-qualified it returns a new keyword with the given namespace added. If the given keyword is already equipped with a namespace it returns it.

    +

    random-digits-len

    added in 8.12.4-0

    (random-digits-len x iteration shrink-now)(random-digits-len x iteration shrink-now rng)

    For 0 or 1 it returns its argument. For other positive numbers it returns a random natural number from 1 to this number (inclusive) in 50% cases. In other 50% cases it returns its argument.

    +

    remove-empty-vals

    added in 8.12.4-0

    (remove-empty-vals m)

    Removes empty values from a map.

    +

    short

    added in 8.12.4-0

    (short)

    time-zones-mapper

    added in 8.12.4-0

    (time-zones-mapper)

    try-null

    macro

    added in 8.12.4-0

    (try-null & body)

    Evaluates body and if NullPointerException exception is caught it returns nil. Otherwise it returns the value of last expression in the body.

    +

    try-parse

    macro

    added in 8.12.4-0

    (try-parse & body)

    Evaluates body and if NumberParseException or NumberFormatException exception is caught it returns nil.

    +

    try-parse-or-false

    macro

    added in 8.12.4-0

    (try-parse-or-false & body)

    Evaluates body and if NumberParseException or NumberFormatException exception is caught it returns false.

    +

    valid-locale?

    added in 8.12.4-1

    deprecated in 8.12.4-3

    (valid-locale? locale-specification)

    DEPRECATED: Please use phone-number.locale/valid?.

    +

    when-not-empty

    macro

    added in 8.12.16-1

    (when-not-empty val & body)

    Evaluates body when the given value is a non-empty collection.

    +

    with-not-empty

    added in 8.12.16-1

    (with-not-empty obj)

    Returns the collection if it’s not empty. Otherwise returns nil.

    +
    \ No newline at end of file