feat: make validate/2 typespec more specific

floatpays · Aug 15, 2023 · 2bce1fc · 2bce1fc
1 parent 4ea8176
commit 2bce1fc
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/lib/za_id_number.ex b/lib/za_id_number.ex
@@ -3,6 +3,8 @@ defmodule ZaIdNumber do
  Documentation for `ZaIdNumber`.
  """
 
+ @spec validate(binary, keyword) ::
+ {:ok, ZaIdNumber.Validator.result()} | {:error, binary()}
  @doc """
  ZaIdNumber validates and retrieves South African ID Number data
 

diff --git a/lib/za_id_number/validator.ex b/lib/za_id_number/validator.ex
@@ -31,7 +31,7 @@ defmodule ZaIdNumber.Validator do
 
  @type result :: %{
  gender: :female | :male,
- age: number(),
+ age: pos_integer(),
  date_of_birth: Date.t(),
  citizen_status: :born_citizen | :permanent_resident
  }