Appearance
@gracious.tech/fetch-client / index / PassageReference
Class: PassageReference
index.PassageReference
Constructors
constructor
• new PassageReference(book, chapter?, verse?)
Parameters
| Name | Type |
|---|---|
book | string |
chapter? | number |
verse? | number |
Defined in
references/dist/esm/passage.d.ts:29
• new PassageReference(reference)
Parameters
| Name | Type |
|---|---|
reference | PassageArgs |
Defined in
references/dist/esm/passage.d.ts:30
Properties
type
• Readonly type: ReferenceType
Defined in
references/dist/esm/passage.d.ts:18
range
• Readonly range: boolean
Defined in
references/dist/esm/passage.d.ts:19
book
• Readonly book: string
Defined in
references/dist/esm/passage.d.ts:20
ot
• Readonly ot: boolean
Defined in
references/dist/esm/passage.d.ts:21
nt
• Readonly nt: boolean
Defined in
references/dist/esm/passage.d.ts:22
start_chapter
• Readonly start_chapter: number
Defined in
references/dist/esm/passage.d.ts:23
start_verse
• Readonly start_verse: number
Defined in
references/dist/esm/passage.d.ts:24
end_chapter
• Readonly end_chapter: number
Defined in
references/dist/esm/passage.d.ts:25
end_verse
• Readonly end_verse: number
Defined in
references/dist/esm/passage.d.ts:26
args_valid
• Readonly args_valid: boolean
Defined in
references/dist/esm/passage.d.ts:27
_args
• Readonly _args: PassageArgs
Defined in
references/dist/esm/passage.d.ts:28
Methods
from_string
▸ Static from_string(reference, book_names?, exclude_book_names?, min_chars?, match_from_start?): null | PassageReference
Parameters
| Name | Type |
|---|---|
reference | string |
book_names? | BookNamesArg |
exclude_book_names? | string[] |
min_chars? | number |
match_from_start? | boolean |
Returns
null | PassageReference
Defined in
references/dist/esm/passage.d.ts:31
from_refs
▸ Static from_refs(start, end): PassageReference
Parameters
| Name | Type |
|---|---|
start | PassageReference |
end | PassageReference |
Returns
Defined in
references/dist/esm/passage.d.ts:32
get_book_string
▸ get_book_string(book_names?): string
Parameters
| Name | Type |
|---|---|
book_names? | Record<string, string> |
Returns
string
Defined in
references/dist/esm/passage.d.ts:33
get_verses_string
▸ get_verses_string(verse_sep?, range_sep?): string
Parameters
| Name | Type |
|---|---|
verse_sep? | string |
range_sep? | string |
Returns
string
Defined in
references/dist/esm/passage.d.ts:34
toString
▸ toString(book_names?, verse_sep?, range_sep?): string
Parameters
| Name | Type |
|---|---|
book_names? | Record<string, string> |
verse_sep? | string |
range_sep? | string |
Returns
string
Defined in
references/dist/esm/passage.d.ts:35
is_before
▸ is_before(chapter, verse): boolean
Parameters
| Name | Type |
|---|---|
chapter | number |
verse | number |
Returns
boolean
Defined in
references/dist/esm/passage.d.ts:36
is_after
▸ is_after(chapter, verse): boolean
Parameters
| Name | Type |
|---|---|
chapter | number |
verse | number |
Returns
boolean
Defined in
references/dist/esm/passage.d.ts:37
includes
▸ includes(chapter, verse): boolean
Parameters
| Name | Type |
|---|---|
chapter | number |
verse | number |
Returns
boolean
Defined in
references/dist/esm/passage.d.ts:38
get_start
▸ get_start(): PassageReference
Returns
Defined in
references/dist/esm/passage.d.ts:39
get_end
▸ get_end(): PassageReference
Returns
Defined in
references/dist/esm/passage.d.ts:40
get_prev_verse
▸ get_prev_verse(prev_to_end?): null | PassageReference
Parameters
| Name | Type |
|---|---|
prev_to_end? | boolean |
Returns
null | PassageReference
Defined in
references/dist/esm/passage.d.ts:41
get_next_verse
▸ get_next_verse(after_end?): null | PassageReference
Parameters
| Name | Type |
|---|---|
after_end? | boolean |
Returns
null | PassageReference
Defined in
references/dist/esm/passage.d.ts:42