@gracious.tech/fetch-client

---

@gracious.tech/fetch-client / index / PassageReference

Class: PassageReference

Defined in: references/dist/esm/passage.d.ts:17

Constructors

Constructor

new PassageReference(book, chapter?, verse?): PassageReference

Defined in: references/dist/esm/passage.d.ts:29

Parameters

book

string

chapter?

number

verse?

number

Returns

PassageReference

Constructor

new PassageReference(reference): PassageReference

Defined in: references/dist/esm/passage.d.ts:30

Parameters

reference

PassageArgs

Returns

PassageReference

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?): PassageReference | null

Defined in: references/dist/esm/passage.d.ts:31

Parameters

reference

string

book_names?

BookNamesArg

exclude_book_names?

string[]

min_chars?

number

match_from_start?

boolean

Returns

PassageReference | null

---

from_refs()

static from_refs(start, end): PassageReference

Defined in: references/dist/esm/passage.d.ts:32

Parameters

start

PassageReference

end

PassageReference

Returns

PassageReference

---

from_serialized()

static from_serialized(code): PassageReference

Defined in: references/dist/esm/passage.d.ts:33

Parameters

code

string

Returns

PassageReference

---

get_book_string()

get_book_string(book_names?): string

Defined in: references/dist/esm/passage.d.ts:34

Parameters

book_names?

Record<string, string>

Returns

string

---

get_verses_string()

get_verses_string(verse_sep?, range_sep?): string

Defined in: references/dist/esm/passage.d.ts:35

Parameters

verse_sep?

string

range_sep?

string

Returns

string

---

toString()

toString(book_names?, verse_sep?, range_sep?): string

Defined in: references/dist/esm/passage.d.ts:36

Parameters

book_names?

Record<string, string>

verse_sep?

string

range_sep?

string

Returns

string

---

to_serialized()

to_serialized(): string

Defined in: references/dist/esm/passage.d.ts:37

Returns

string

---

equals()

equals(ref): boolean

Defined in: references/dist/esm/passage.d.ts:38

Parameters

ref

PassageReference

Returns

boolean

---

is_before()

Call Signature

is_before(chapter, verse): boolean

Defined in: references/dist/esm/passage.d.ts:39

Parameters

chapter

number

verse

number

Returns

boolean

Call Signature

is_before(ref): boolean

Defined in: references/dist/esm/passage.d.ts:40

Parameters

ref

PassageReference

Returns

boolean

---

is_after()

Call Signature

is_after(chapter, verse): boolean

Defined in: references/dist/esm/passage.d.ts:41

Parameters

chapter

number

verse

number

Returns

boolean

Call Signature

is_after(ref): boolean

Defined in: references/dist/esm/passage.d.ts:42

Parameters

ref

PassageReference

Returns

boolean

---

includes()

Call Signature

includes(chapter, verse): boolean

Defined in: references/dist/esm/passage.d.ts:43

Parameters

chapter

number

verse

number

Returns

boolean

Call Signature

includes(ref): boolean

Defined in: references/dist/esm/passage.d.ts:44

Parameters

ref

PassageReference

Returns

boolean

---

overlaps()

overlaps(ref): boolean

Defined in: references/dist/esm/passage.d.ts:45

Parameters

ref

PassageReference

Returns

boolean

---

total_verses()

total_verses(): number

Defined in: references/dist/esm/passage.d.ts:46

Returns

number

---

get_start()

get_start(): PassageReference

Defined in: references/dist/esm/passage.d.ts:47

Returns

PassageReference

---

get_end()

get_end(): PassageReference

Defined in: references/dist/esm/passage.d.ts:48

Returns

PassageReference

---

get_prev_verse()

get_prev_verse(prev_to_end?): PassageReference | null

Defined in: references/dist/esm/passage.d.ts:49

Parameters

prev_to_end?

boolean

Returns

PassageReference | null

---

get_next_verse()

get_next_verse(after_end?): PassageReference | null

Defined in: references/dist/esm/passage.d.ts:50

Parameters

after_end?

boolean

Returns

PassageReference | null

---

simplify()

simplify(): PassageReference

Defined in: references/dist/esm/passage.d.ts:51

Returns

PassageReference