diff --git a/package-lock.json b/package-lock.json index da2d0af..3891920 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "best-bible", - "version": "1.5.8", + "version": "1.5.9", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "best-bible", - "version": "1.5.8", + "version": "1.5.9", "license": "GPL-3.0-or-later", "devDependencies": { "@types/node": "^22.2.0", diff --git a/package.json b/package.json index b8918f0..23a5c36 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "best-bible", - "version": "1.5.8", + "version": "1.5.9", "description": "Fetch, parse, and analyze the Bible easily with JavaScript", "scripts": { "build:cjs": "tsc --project tsconfig.cjs.json || true && mkdir -p dist/cjs/data && cp src/data/bible.json dist/cjs/data/", diff --git a/src/index.ts b/src/index.ts index 9e120b0..ec07661 100644 --- a/src/index.ts +++ b/src/index.ts @@ -17,6 +17,7 @@ const { * @param {string} verse - The verse string to parse. * @param {string} [outputType="default"] - The type of output. Can be "default", "string", or "indexed". * @return {Array|String} The parsed verse based on the output type. + * @deprecated The bible.json file no longer has translation markers, so this function is not needed. */ function parseVerse(verse: string, outputType: string = "default") { /* @deprecated: The bible.json file will resolve these errors itself. */ @@ -66,6 +67,9 @@ function getVerse( chapterNumber: number, verseNumber: number, outputType: string = "default", + /** + * @deprecated Use of `cleanVerse` will be removed in a future version. Verses are now always cleaned by default. + */ cleanVerse: boolean = true ) { if (!isValidVerse(bookName, chapterNumber, verseNumber)) { @@ -106,6 +110,9 @@ function getChapter( bookName: string, chapterNumber: number, outputType: string = "default", + /** + * @deprecated Use of `cleanVerse` will be removed in a future version. Verses are now always cleaned by default. + */ cleanVerse: boolean = true ) { if (!isValidChapter(bookName, chapterNumber)) { @@ -145,6 +152,9 @@ function getChapter( function getBook( bookName: string, outputType: string = "default", + /** + * @deprecated Use of `cleanVerse` will be removed in a future version. Verses are now always cleaned by default. + */ cleanVerse: boolean = true ) { if (!isValidBook(bookName)) { @@ -239,6 +249,9 @@ function getRange( endChapterNumber: number, endVerseNumber: number, outputType: string = "default", + /** + * @deprecated Use of `cleanVerse` will be removed in a future version. Verses are now always cleaned by default. + */ cleanVerse: boolean = true ) { if (