biblesdk/dist/index.d.ts

Typescript client for Bible SDK API

import { Phrase, Book, Chapter, Reading, PhraseWithConcordanceInfo, Verse, VerseMatch } from './types/index.js';
export { $defs, ConcordanceInfo, VerseRange, components, operations, paths, webhooks } from './types/index.js';

declare function joinPhrases(phrases: Phrase[]): string;
declare function listBooks(): Promise<Book[]>;
declare function listChapters(book: string): Promise<Chapter[]>;
declare function getBookMetadata(book: string): Promise<Book>;
declare function getChapterMetadata(book: string, chapter: number): Promise<Chapter>;
declare function read(book: string, chapter: number, cursor?: number, take?: number, withConcordanceInfo?: false): Promise<Reading<Phrase>>;
declare function read(book: string, chapter: number, cursor: number, take: number, withConcordanceInfo: true): Promise<Reading<PhraseWithConcordanceInfo>>;
declare function getPhrases(book: string, chapter: number, verseRange: [number, number], withConcordanceInfo?: false): Promise<Phrase[]>;
declare function getPhrases(book: string, chapter: number, verseRange: [number, number], withConcordanceInfo: true): Promise<PhraseWithConcordanceInfo[]>;
declare function getVerses(book: string, chapter: number, verseRange: [number, number]): Promise<Verse[]>;
declare function getSearchResults(query: string): Promise<VerseMatch[]>;

export { Book, Chapter, Phrase, PhraseWithConcordanceInfo, Reading, Verse, VerseMatch, getBookMetadata, getChapterMetadata, getPhrases, getSearchResults, getVerses, joinPhrases, listBooks, listChapters, read };