Class Reference

constructor

• new Reference(book, chapter, verseStart?, verseEnd?, translation?): Reference

• Parameters

  • book: string | number
  • chapter: number
  • OptionalverseStart: number
  • OptionalverseEnd: number
  • Optionaltranslation: string

  Returns Reference

book

chapter

Optionaltranslation

OptionalverseEnd

OptionalverseStart

getBookName

• getBookName(): string

• Returns the English name of the book being referenced.

  Returns string

  Example

  let ref = new Reference("Malachi", 4)
  ref.getBookName() === "Malachi"
  Copy

getBookNameFromTranslation

• getBookNameFromTranslation(): Promise<string>

• Returns the name of the book being referenced according to the current translation. (See Reference.getTranslation)

  Returns Promise<string>

getTranslation

• getTranslation(): string

• Returns the TranslationID being referenced.

  Returns string

  If the translation is not defined in the reference, then returns the reading translation from the user's settings.

  Example

  let ref = new Reference("Genesis", 1, 1, 2, "WEB")
  ref.getTranslation() === "WEB"
  Copy

setBook

• setBook(book): Reference

• Sets the book being referenced.

  Parameters

  • book: string | number

  Returns Reference

  Example

  let ref = new Reference("Psalms", 1)
  
  ref.setBook("1 John")
  ref.toString() === "1 John 1"
  
  ref.setBook(1)
  ref.toString() === "Genesis 1"
  Copy

setTranslation

• setTranslation(translation?): Reference

• Sets the translation of the reference.

  Parameters

  • Optionaltranslation: string

  Returns Reference

setVerse

• setVerse(start?): Reference

• Sets the verse being referenced

  Parameters

  • Optionalstart: number

  Returns Reference

  Example

  let ref = new Reference("Psalms", 119)
  
  ref.setVerse(1)
  ref.toString() === "Psalms 119:1"
  
  ref.setVerse()
  ref.toString() === "Psalms 119"
  Copy

setVerseRange

• setVerseRange(start?, end?): Reference

• Sets the verse range being referenced.

  Parameters

  • Optionalstart: number
  • Optionalend: number

  Returns Reference

  Example

  let ref = new Reference("Psalms", 119)
  
  ref.setVerseRange(1)
  ref.toString() === "Psalms 119:1"
  
  ref.setVerseRange(2, 3)
  ref.toString() === "Psalms 119:2-3"
  
  ref.setVerseRange()
  ref.toString() === "Psalms 119"
  Copy

  Throws

  ReferenceError if end is defined but start is undefined.

text

• text(options?): Promise<string>

• Fetches the scripture being referenced as markdown.

  Parameters

  • Optionaloptions: ScriptureOptions

  Returns Promise<string>

  Example

  let ref = new Reference("Genesis", 1, 1)
  let text = await ref.text()
  text.startsWith("In the beginning") === true
  Copy

  See

  • scripture

toString

• toString(): Promise<string>

• Converts this reference to a string.

  Returns Promise<string>

  Example

  let ref = new Reference("John", 33, 3, 4, "WEB")
  String(ref) === "John 33:3-4 WEB"
  Copy

StaticfromString

• fromString(text): Reference

• Constructs a new Reference from text.

  Parameters

  • text: string

  Returns Reference

  Example

  let ref = Reference.fromString("Genesis 1:1")
  Copy

  Throws

  • ReferenceError if no book is supplied or if no chapter is supplied.
  • ReferenceError if ending verse is before starting verse.
  • ReferenceError if the book name does not exist in the current translation (See Reference.getTranslation.)