View Source HumanName (human_name v0.5.0)

Documentation for HumanName.

Summary

Functions

Returns the initial for the first (given) name.

Returns the initial for the first (given) name and the full last name (surname).

Returns just the formatted first (given) name.

Returns the combined initials for the first (given) name and last (surname) name.

Returns just the formatted last name (surname).

Returns a formatted version of just the first (given) and last (surname) names.

Returns a formatted version of the entire name.

Functions

Link to this function

first_initial(full_name)

View Source

Returns the initial for the first (given) name.

Example

  iex> HumanName.first_initial("Jimmy H Jenkins")
  {:ok, "J"}

  iex> HumanName.first_initial("Dr. Alibaster Cornelius Juniper III")
  {:ok, "A"}

  iex> HumanName.first_initial(12345)
  {:error, "No valid name found"}

  iex> HumanName.first_initial("")
  {:error, "No valid name found"}

  iex> HumanName.first_initial(nil)
  {:error, "No valid name found"}
Link to this function

first_initial_last(full_name)

View Source

Returns the initial for the first (given) name and the full last name (surname).

Example

  iex> HumanName.first_initial_last("Jimmy H Jenkins")
  {:ok, "J. Jenkins"}

  iex> HumanName.first_initial_last("Dr. Alibaster Cornelius Juniper III")
  {:ok, "A. Juniper"}

  iex> HumanName.first_initial_last("")
  {:error, "No valid name found"}

Returns just the formatted first (given) name.

Example

  iex> HumanName.first_name("Jimmy H Jenkins")
  {:ok, "Jimmy"}

  iex> HumanName.first_name("Dr. Alibaster Cornelius Juniper III")
  {:ok, "Alibaster"}

  iex> HumanName.first_name("")
  {:error, "No valid name found"}

Returns the combined initials for the first (given) name and last (surname) name.

Example

  iex> HumanName.initials("Jimmy H Jenkins")
  {:ok, "JJ"}

  iex> HumanName.initials("Dr. Alibaster Cornelius Juniper III")
  {:ok, "AJ"}

  iex> HumanName.initials("")
  {:error, "No valid name found"}

Returns just the formatted last name (surname).

Example

  iex> HumanName.last_name("Jimmy H Jenkins")
  {:ok, "Jenkins"}

  iex> HumanName.last_name("Dr. Alibaster Cornelius Juniper III")
  {:ok, "Juniper"}

  iex> HumanName.last_name("")
  {:error, "No valid name found"}

Returns a formatted version of just the first (given) and last (surname) names.

Example

  iex> HumanName.normalize("Jimmy H Jenkins")
  {:ok, "Jimmy Jenkins"}

  iex> HumanName.normalize("Dr. Alibaster Cornelius Juniper III")
  {:ok, "Alibaster Juniper"}

  iex> HumanName.normalize("fred mccalister  ")
  {:ok, "Fred McCalister"}

  iex> HumanName.normalize("")
  {:error, "No valid name found"}
Link to this function

normalize_full(full_name)

View Source

Returns a formatted version of the entire name.

Example

  iex> HumanName.normalize_full("JIMMY H JENKINS")
  {:ok, "Jimmy H. Jenkins"}

  iex> HumanName.normalize_full("Dr. Alibaster Cornelius Juniper III")
  {:ok, "Alibaster Cornelius Juniper, III"}

  iex> HumanName.normalize_full("")
  {:error, "No valid name found"}