View Source BibleEx.Verse (bible_ex v0.2.0)

A Bible verse struct.

Link to this section Summary

Functions

Make a new %Verse{} struct.

Link to this section Functions

Make a new %Verse{} struct.

parameters

Parameters

  • book: a string that is one of the four possible book name formats
  • "GEN" (abbr)
  • "Genesis" (name)
  • "Gen" (osis)
  • "Gn" (short)
  • chapter_number: an integer that is the chapter number
  • verse_number: an integer that is the verse number

examples

Examples

iex> alias BibleEx.Verse
iex> first = Verse(book: "Genesis", chapter_number: 1, verse_number: 1)

%BibleEx.Verse{
  book: "Genesis",
  book_names: %{abbr: "GEN", name: "Genesis", osis: "Gen", short: "Gn"},
  book_number: 1,
  reference_type: :verse,
  reference: "Genesis 1:1",
  chapter_number: 1,
  verse_number: 1,
  is_valid: true
}

iex> alias BibleEx.Verse
iex> matt24 = Verse.new(book: "Matt", chapter_number: 2, verse_number: 4)

%BibleEx.Verse{
  book: "Matt",
  book_names: %{abbr: "MAT", name: "Matthew", osis: "Matt", short: "Mt"},
  book_number: 40,
  reference_type: :verse,
  reference: "Matt 2:4",
  chapter_number: 2,
  verse_number: 4,
  is_valid: true
}