Skip to content

Commit

Permalink
Update API.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tobias-klein committed Aug 12, 2024
1 parent 94f0165 commit e949b44
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ This is the main class of node-sword-interface and it provides a set of static f
* [.getVersesFromReferences(moduleCode, references)](#NodeSwordInterface+getVersesFromReferences)[<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
* [.getReferencesFromReferenceRange(referenceRange)](#NodeSwordInterface+getReferencesFromReferenceRange) ⇒ <code>Array.&lt;String&gt;</code>
* [.getBookList(moduleCode)](#NodeSwordInterface+getBookList) ⇒ <code>Array.&lt;String&gt;</code>
* [.getBookHeaderList(moduleCode, bookCode, withAbsoluteVerseNumbers)](#NodeSwordInterface+getBookHeaderList)[<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
* [.getBookHeaderList(moduleCode, bookCode, startVerseNumber, verseCount)](#NodeSwordInterface+getBookHeaderList)[<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
* [.getBookChapterCount(moduleCode, bookCode)](#NodeSwordInterface+getBookChapterCount)
* [.getChapterVerseCount(moduleCode, bookCode, chapter)](#NodeSwordInterface+getChapterVerseCount)
* [.getAllChapterVerseCounts(moduleCode, bookCode)](#NodeSwordInterface+getAllChapterVerseCounts) ⇒ <code>Number</code>
Expand Down Expand Up @@ -404,16 +404,17 @@ Returns the list of books available in the given module. By default the book cod

<a name="NodeSwordInterface+getBookHeaderList"></a>

### nodeSwordInterface.getBookHeaderList(moduleCode, bookCode, withAbsoluteVerseNumbers) ⇒ [<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
### nodeSwordInterface.getBookHeaderList(moduleCode, bookCode, startVerseNumber, verseCount) ⇒ [<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
Returns the list of headers available in the given book. The headers are returned as an array of VerseObjects.

**Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)

| Param | Type | Default |
| --- | --- | --- |
| moduleCode | <code>String</code> | |
| bookCode | <code>String</code> | |
| withAbsoluteVerseNumbers | <code>Boolean</code> | <code>false</code> |
| Param | Type |
| --- | --- |
| moduleCode | <code>String</code> |
| bookCode | <code>String</code> |
| startVerseNumber | <code>Number</code> |
| verseCount | <code>Number</code> |

<a name="NodeSwordInterface+getBookChapterCount"></a>

Expand Down

0 comments on commit e949b44

Please sign in to comment.