node-sword-interface 1.0.40 → 1.0.41
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/build.yml +1 -1
- package/API.md +11 -2
- package/package.json +2 -2
- package/scripts/get_sword_build_win32.ps1 +1 -1
package/API.md
CHANGED
|
@@ -50,6 +50,7 @@ This is the main class of node-sword-interface and it provides a set of static f
|
|
|
50
50
|
* [.isModuleReadable(moduleCode)](#NodeSwordInterface+isModuleReadable) ⇒ <code>Boolean</code>
|
|
51
51
|
* [.getModuleDescription(moduleCode)](#NodeSwordInterface+getModuleDescription) ⇒ <code>String</code>
|
|
52
52
|
* [.enableMarkup()](#NodeSwordInterface+enableMarkup)
|
|
53
|
+
* [.disableMarkup()](#NodeSwordInterface+disableMarkup)
|
|
53
54
|
* [.enableStrongsWithNbsp()](#NodeSwordInterface+enableStrongsWithNbsp)
|
|
54
55
|
* [.getRawModuleEntry(moduleCode, key)](#NodeSwordInterface+getRawModuleEntry) ⇒ <code>String</code>
|
|
55
56
|
* [.getReferenceText(moduleCode, key)](#NodeSwordInterface+getReferenceText) ⇒ [<code>VerseObject</code>](#VerseObject)
|
|
@@ -67,7 +68,7 @@ This is the main class of node-sword-interface and it provides a set of static f
|
|
|
67
68
|
* [.getBookIntroduction(moduleCode, bookCode)](#NodeSwordInterface+getBookIntroduction) ⇒ <code>String</code>
|
|
68
69
|
* [.moduleHasBook(moduleCode, bookCode)](#NodeSwordInterface+moduleHasBook) ⇒ <code>Boolean</code>
|
|
69
70
|
* [.getDictModuleKeys(moduleCode)](#NodeSwordInterface+getDictModuleKeys) ⇒ <code>Array.<String></code>
|
|
70
|
-
* [.getModuleSearchResults(moduleCode, searchTerm, progressCB, searchType, searchScope, isCaseSensitive, useExtendedVerseBoundaries)](#NodeSwordInterface+getModuleSearchResults) ⇒ <code>Promise</code>
|
|
71
|
+
* [.getModuleSearchResults(moduleCode, searchTerm, progressCB, searchType, searchScope, isCaseSensitive, useExtendedVerseBoundaries, filterOnWordBoundaries)](#NodeSwordInterface+getModuleSearchResults) ⇒ <code>Promise</code>
|
|
71
72
|
* [.terminateModuleSearch()](#NodeSwordInterface+terminateModuleSearch)
|
|
72
73
|
* [.hebrewStrongsAvailable()](#NodeSwordInterface+hebrewStrongsAvailable) ⇒ <code>Boolean</code>
|
|
73
74
|
* [.greekStrongsAvailable()](#NodeSwordInterface+greekStrongsAvailable) ⇒ <code>Boolean</code>
|
|
@@ -311,6 +312,13 @@ Returns the description of a module.
|
|
|
311
312
|
Enables available markup (like Strongs, foot notes, etc.)
|
|
312
313
|
This influences the output for getChapterText, getBookText and getBibleText.
|
|
313
314
|
|
|
315
|
+
**Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)
|
|
316
|
+
<a name="NodeSwordInterface+disableMarkup"></a>
|
|
317
|
+
|
|
318
|
+
### nodeSwordInterface.disableMarkup()
|
|
319
|
+
Disable available markup (like Strongs, foot notes, etc.)
|
|
320
|
+
This influences the output for getChapterText, getBookText and getBibleText.
|
|
321
|
+
|
|
314
322
|
**Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)
|
|
315
323
|
<a name="NodeSwordInterface+enableStrongsWithNbsp"></a>
|
|
316
324
|
|
|
@@ -524,7 +532,7 @@ Returns the keys of a dictionary module.
|
|
|
524
532
|
|
|
525
533
|
<a name="NodeSwordInterface+getModuleSearchResults"></a>
|
|
526
534
|
|
|
527
|
-
### nodeSwordInterface.getModuleSearchResults(moduleCode, searchTerm, progressCB, searchType, searchScope, isCaseSensitive, useExtendedVerseBoundaries) ⇒ <code>Promise</code>
|
|
535
|
+
### nodeSwordInterface.getModuleSearchResults(moduleCode, searchTerm, progressCB, searchType, searchScope, isCaseSensitive, useExtendedVerseBoundaries, filterOnWordBoundaries) ⇒ <code>Promise</code>
|
|
528
536
|
Returns the results of a module search.
|
|
529
537
|
|
|
530
538
|
**Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)
|
|
@@ -538,6 +546,7 @@ Returns the results of a module search.
|
|
|
538
546
|
| searchScope | <code>String</code> | <code>BIBLE</code> | Options: BIBLE, OT, NT |
|
|
539
547
|
| isCaseSensitive | <code>Boolean</code> | <code>false</code> | Whether the search is case sensitive |
|
|
540
548
|
| useExtendedVerseBoundaries | <code>Boolean</code> | <code>false</code> | Whether the search should use extended verse boundaries (Two verses instead of one) in case of a multi word search. |
|
|
549
|
+
| filterOnWordBoundaries | <code>Boolean</code> | <code>false</code> | Whether to filter results based on word boundaries. |
|
|
541
550
|
|
|
542
551
|
<a name="NodeSwordInterface+terminateModuleSearch"></a>
|
|
543
552
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "node-sword-interface",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.41",
|
|
4
4
|
"description": "Javascript (N-API) interface to SWORD library",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"C++",
|
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
"url": "git+https://github.com/ezra-bible-app/node-sword-interface.git"
|
|
32
32
|
},
|
|
33
33
|
"devDependencies": {
|
|
34
|
-
"jsdoc-to-markdown": "^
|
|
34
|
+
"jsdoc-to-markdown": "^9.1.1",
|
|
35
35
|
"node-gyp": "^9.1.0"
|
|
36
36
|
}
|
|
37
37
|
}
|
|
@@ -34,7 +34,7 @@ $headers = @{}
|
|
|
34
34
|
$github_token = $env:GITHUB_TOKEN
|
|
35
35
|
|
|
36
36
|
# --- Set the uri for the release
|
|
37
|
-
$URI = "https://api.github.com/repos/ezra-bible-app/sword-build-win32/releases/tags/v1.
|
|
37
|
+
$URI = "https://api.github.com/repos/ezra-bible-app/sword-build-win32/releases/tags/v1.8.900-2022-11-06"
|
|
38
38
|
|
|
39
39
|
if ($Env:CI -eq "true") {
|
|
40
40
|
Write-Host "GitHub actions build ... using GITHUB_TOKEN for authentication!"
|