Skip to content

@gracious.tech/fetch-client


@gracious.tech/fetch-client / other/sections / SectionData

Class: SectionData ​

Defined in: client/src/other/sections.ts:27

Access to translation-independent section importance/popularity stats

Properties ​

model ​

readonly model: string

Defined in: client/src/other/sections.ts:32


generated ​

readonly generated: string

Defined in: client/src/other/sections.ts:33

Methods ​

get_sections() ​

get_sections(options?): LocatedSectionStat[]

Defined in: client/src/other/sections.ts:55

Get sections (whole Bible, or a single book), optionally filtered and sorted

Parameters ​

options? ​

GetSectionsOptions = {}

Returns ​

LocatedSectionStat[]


get_for_verse() ​

get_for_verse(book, chapter, verse): LocatedSectionStat | undefined

Defined in: client/src/other/sections.ts:103

Get the section containing a specific verse (or undefined if none)

Parameters ​

book ​

string

chapter ​

number

verse ​

number

Returns ​

LocatedSectionStat | undefined


get_for_ref() ​

get_for_ref(ref): LocatedSectionStat[]

Defined in: client/src/other/sections.ts:119

Get all sections that overlap a reference (a PassageReference or a reference string) Strings are auto-parsed with English book names (e.g. “John 3:16”, “Jonah 1”).

Parameters ​

ref ​

string | PassageReference

Returns ​

LocatedSectionStat[]