# sedra-model [![npm version](https://badge.fury.io/js/sedra-model.svg)](https://badge.fury.io/js/sedra-model) [![npm module downloads](http://img.shields.io/npm/dt/sedra-model.svg)](https://www.npmjs.org/package/sedra-model) [![Build Status](https://travis-ci.org/peshitta/sedra-model.svg?branch=master)](https://travis-ci.org/peshitta/sedra-model) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/peshitta/sedra-model/blob/master/LICENSE) [![Dependency Status](https://david-dm.org/peshitta/sedra-model.svg)](https://david-dm.org/peshitta/sedra-model) [![Coverage Status](https://coveralls.io/repos/github/peshitta/sedra-model/badge.svg?branch=master)](https://coveralls.io/github/peshitta/sedra-model?branch=master) [![Gitter](https://badges.gitter.im/peshitta/peshitta.svg "Join the chat at https://gitter.im/peshitta/Lobby")](https://gitter.im/peshitta/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) Sedra models and related utility functions ## Installation In order to use this library, [Node.js](https://nodejs.org) should be installed. Then run: ``` npm install sedra-model --save ``` Following bundles are available: * `sedra-model.js` - UMD ES5 version for use in browser, node, etc. * `sedra-model.min.js` - minified version of `sedra-model.js` * `sedra-model.esm.js` - ES6 module version, suitable for bundling with other libraries and applications The package could also be downloaded directly from: [https://registry.npmjs.org/sedra-model/-/sedra-model-1.2.0.tgz](https://registry.npmjs.org/sedra-model/-/sedra-model-1.2.0.tgz) ## More information [Peshitta App](https://peshitta.github.io) [Beth Mardutho](https://sedra.bethmardutho.org/about/fonts) [CAL](http://cal1.cn.huc.edu/searching/fullbrowser.html) ## License [MIT](https://github.com/peshitta/sedra-model/blob/master/LICENSE) ## Contributing The final goal for this work is to learn the Word of God as recorded by [Peshitta](https://en.wikipedia.org/wiki/Peshitta). You are welcomed to improve this implementation or provide feedback. Please feel free to [Fork](https://help.github.com/articles/fork-a-repo/), create a [Pull Request](https://help.github.com/articles/about-pull-requests/) or submit [Issues](https://github.com/peshitta/sedra-model/issues). To read quick updates about Peshitta app or post questions or feedback, follow [@peshittap](https://www.twitter.com/peshittap) at [![@peshittap](http://i.imgur.com/wWzX9uB.png "@peshittap")](https://www.twitter.com/peshittap)or [![Gitter](https://badges.gitter.im/peshitta/peshitta.svg "Join the chat at https://gitter.im/peshitta/Lobby")](https://gitter.im/peshitta/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) ## Development ``` npm install ``` ``` npm run build ``` ## API Reference * [sedraModel](#module_sedraModel) * [.wordType](#module_sedraModel.wordType) : Array.<string> * [.vowel](#module_sedraModel.vowel) : Array.<string> * [.wordNumber](#module_sedraModel.wordNumber) : Array.<string> * [.wordGender](#module_sedraModel.wordGender) : Array.<string> * [.wordForm](#module_sedraModel.wordForm) : Array.<string> * [.lexemeGrammaticalCategory](#module_sedraModel.lexemeGrammaticalCategory) : Array.<string> * [.lexemeFirstSuffix](#module_sedraModel.lexemeFirstSuffix) : Array.<string> * [.lexemeSecondSuffix](#module_sedraModel.lexemeSecondSuffix) : Array.<string> * [.lexemeThirdSuffix](#module_sedraModel.lexemeThirdSuffix) : Array.<string> * [.lexemePrefix](#module_sedraModel.lexemePrefix) : Array.<string> * [.lexemeRadicalType](#module_sedraModel.lexemeRadicalType) : Array.<string> * [.lexemeForm](#module_sedraModel.lexemeForm) : Array.<string> * [.wordSuffixGender](#module_sedraModel.wordSuffixGender) : Array.<string> * [.wordSuffixPerson](#module_sedraModel.wordSuffixPerson) : Array.<string> * [.wordSuffixNumber](#module_sedraModel.wordSuffixNumber) : Array.<string> * [.wordSuffixType](#module_sedraModel.wordSuffixType) : Array.<string> * [.wordPerson](#module_sedraModel.wordPerson) : Array.<string> * [.wordState](#module_sedraModel.wordState) : Array.<string> * [.wordTense](#module_sedraModel.wordTense) : Array.<string> * [.textPosition](#module_sedraModel.textPosition) : Array.<string> * [.fontType](#module_sedraModel.fontType) : Array.<string> * [.verbType](#module_sedraModel.verbType) : Array.<string> * [.etymologyLanguage](#module_sedraModel.etymologyLanguage) : Array.<string> * [.books](#module_sedraModel.books) : Array.<string> * [.peshittaBooks](#module_sedraModel.peshittaBooks) : Array.<Book> * [.bookGroups](#module_sedraModel.bookGroups) : Object * [.makeRoot(root, sort, attributes)](#module_sedraModel.makeRoot) ⇒ Root * [.makeRootAttribute(seyame, rootType)](#module_sedraModel.makeRootAttribute) ⇒ RootAttribute * [.getRootAttribute(attributes)](#module_sedraModel.getRootAttribute) ⇒ RootAttribute * [.getRoot(id, root)](#module_sedraModel.getRoot) ⇒ FlatRoot * [.makeLexeme(rootId, lexeme, morphologicalType, attributes)](#module_sedraModel.makeLexeme) ⇒ Lexeme * [.makeLexemeAttribute(seyame, wordType, grammaticalCategory, listing)](#module_sedraModel.makeLexemeAttribute) ⇒ LexemeAttribute * [.getLexemeAttribute(attributes)](#module_sedraModel.getLexemeAttribute) ⇒ LexemeAttribute * [.makeLexemeMorphologicalType(firstSuffix, secondSuffix, thirdSuffix, prefix, firstVowel, secondVowel, thirdVowel, fourthVowel, vowelCount, radicalType, form)](#module_sedraModel.makeLexemeMorphologicalType) ⇒ LexemeMorphologicalType * [.getLexemeMorphologicalType(morphologicalType)](#module_sedraModel.getLexemeMorphologicalType) ⇒ LexemeMorphologicalType * [.getLexeme(id, lexeme, roots)](#module_sedraModel.getLexeme) ⇒ FlatLexeme * [.makeWord(lexemeId, word, vocalised, morphologicalType, attributes)](#module_sedraModel.makeWord) ⇒ Word * [.makeWordAttribute(seyame, listing, enclitic, lexeme)](#module_sedraModel.makeWordAttribute) ⇒ WordAttribute * [.getWordAttribute(attributes)](#module_sedraModel.getWordAttribute) ⇒ WordAttribute * [.makeWordMorphologicalType(suffixGender, suffixPerson, suffixNumber, suffixType, prefixCode, gender, person, number, state, tense, form)](#module_sedraModel.makeWordMorphologicalType) ⇒ WordMorphologicalType * [.getWordMorphologicalType(attributes)](#module_sedraModel.getWordMorphologicalType) ⇒ WordMorphologicalType * [.getWord(id, lexeme, lexemes)](#module_sedraModel.getWord) ⇒ FlatWord * [.makeEnglish(lexemeId, word, before, after, comment, attributes, flag)](#module_sedraModel.makeEnglish) ⇒ English * [.makeEnglishAttribute(commentPosition, commentFont, stringBeforeFont, stringAfterFont, verb, number, gender, form)](#module_sedraModel.makeEnglishAttribute) ⇒ EnglishAttribute * [.getEnglishAttribute(attributes)](#module_sedraModel.getEnglishAttribute) ⇒ EnglishAttribute * [.getEnglish(id, english, lexemes)](#module_sedraModel.getEnglish) ⇒ FlatEnglish * [.makeEtymology(lexemeId, word, attributes)](#module_sedraModel.makeEtymology) ⇒ Etymology * [.makeEtymologyAttribute(language, type)](#module_sedraModel.makeEtymologyAttribute) ⇒ EtymologyAttribute * [.getEtymologyAttribute(attributes)](#module_sedraModel.getEtymologyAttribute) ⇒ EtymologyAttribute * [.getEtymology(id, etymology, lexemes)](#module_sedraModel.getEtymology) ⇒ FlatEtymology * [.makeBook(id, peshittaId, name, vocalised, english, stats)](#module_sedraModel.makeBook) ⇒ Book * [.sorter(a, b)](#module_sedraModel.sorter) ⇒ number * [.getBook(id)](#module_sedraModel.getBook) ⇒ Book * [.getBooksByEnglish()](#module_sedraModel.getBooksByEnglish) ⇒ Object * [.getBookByEnglish(name)](#module_sedraModel.getBookByEnglish) ⇒ Book * [.getBookEnglishNames()](#module_sedraModel.getBookEnglishNames) ⇒ Array * [.getNamedReferences()](#module_sedraModel.getNamedReferences) ⇒ Array * [.makeBookGroup(id, name, bookSet)](#module_sedraModel.makeBookGroup) ⇒ BookGroup * [.getVerseByIndex(index, ubs)](#module_sedraModel.getVerseByIndex) ⇒ object * [.getIndexByVerseWoChapter(reference, ubs)](#module_sedraModel.getIndexByVerseWoChapter) ⇒ number * [.getIndexByVerse(reference, ubs)](#module_sedraModel.getIndexByVerse) ⇒ number ### sedraModel.wordType : Array.<string> Word Type enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.vowel : Array.<string> Vowel enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.wordNumber : Array.<string> Word Number enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.wordGender : Array.<string> Word Gender enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.wordForm : Array.<string> Word Form enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.lexemeGrammaticalCategory : Array.<string> Lexeme Grammatical Category enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.lexemeFirstSuffix : Array.<string> Lexeme First Suffix enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.lexemeSecondSuffix : Array.<string> Second Second Suffix enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.lexemeThirdSuffix : Array.<string> Lexeme Third Suffix enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.lexemePrefix : Array.<string> Lexeme Prefix enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.lexemeRadicalType : Array.<string> Lexeme Radical Type enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.lexemeForm : Array.<string> Lexeme Form enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.wordSuffixGender : Array.<string> Word Suffix Gender enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.wordSuffixPerson : Array.<string> Word Suffix Person enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.wordSuffixNumber : Array.<string> Word Suffix Number enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.wordSuffixType : Array.<string> Word Suffix Type enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.wordPerson : Array.<string> Word Person enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.wordState : Array.<string> Word State enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.wordTense : Array.<string> Word Tense enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.textPosition : Array.<string> Text position enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.fontType : Array.<string> Font type enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.verbType : Array.<string> Verb type enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.etymologyLanguage : Array.<string> Etymology Language enumeration **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.books : Array.<string> Peshitta books **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.peshittaBooks : Array.<Book> Peshitta books sorted according to Eastern Peshitta ordering **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.bookGroups : Object Eastern New Testament Peshitta book groups **Kind**: static constant of [sedraModel](#module_sedraModel) ### sedraModel.makeRoot(root, sort, attributes) ⇒ Root Root records, e.g. 0:2,"AB","ab |A",0 Id is the position in the containing array so it is not stored **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: Root - Sedra Root row | Param | Type | Description | | --- | --- | --- | | root | string | e.g. "AB" | | sort | string | e.g. "ab |A" | | attributes | number | 16-bit map | ### sedraModel.makeRootAttribute(seyame, rootType) ⇒ RootAttribute Build Root Attribute object **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: RootAttribute - Root Attribute object | Param | Type | Description | | --- | --- | --- | | seyame | boolean | true if root has seyame | | rootType | string | word type enumeration | ### sedraModel.getRootAttribute(attributes) ⇒ RootAttribute Get Root Attribute object from root attribute bit map **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: RootAttribute - Root Attribute object | Param | Type | Description | | --- | --- | --- | | attributes | number | 16-bit map | ### sedraModel.getRoot(id, root) ⇒ FlatRoot Return flatten root object with parsed attribute values **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: FlatRoot - the flatten root model | Param | Type | Description | | --- | --- | --- | | id | number | the id of current root object | | root | Root | root raw object | ### sedraModel.makeLexeme(rootId, lexeme, morphologicalType, attributes) ⇒ Lexeme Lexeme records, e.g. 1:2,0:2,"ABA",41960448,16 Id is the position in the array so it is not stored **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: Lexeme - Sedra Lexeme row | Param | Type | Description | | --- | --- | --- | | rootId | number | Root Address, e.g. 2 | | lexeme | string | e.g. "ABA" | | morphologicalType | number | 32-bit map | | attributes | number | 16-bit map | ### sedraModel.makeLexemeAttribute(seyame, wordType, grammaticalCategory, listing) ⇒ LexemeAttribute Build Lexeme Attribute object **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: LexemeAttribute - Lexeme Attribute object | Param | Type | Description | | --- | --- | --- | | seyame | boolean | true if lexeme has seyame | | wordType | string | word type enumeration | | grammaticalCategory | string | grammatical category enumeration | | listing | boolean | not clear yet what this is used for | ### sedraModel.getLexemeAttribute(attributes) ⇒ LexemeAttribute Get Lexeme Attribute object from lexeme attribute bit map **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: LexemeAttribute - Lexeme Attribute object | Param | Type | Description | | --- | --- | --- | | attributes | number | 16-bit map | ### sedraModel.makeLexemeMorphologicalType(firstSuffix, secondSuffix, thirdSuffix, prefix, firstVowel, secondVowel, thirdVowel, fourthVowel, vowelCount, radicalType, form) ⇒ LexemeMorphologicalType Build Lexeme Morphological Type object **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: LexemeMorphologicalType - Lexeme Morphological Type object | Param | Type | Description | | --- | --- | --- | | firstSuffix | string | First suffix enumeration | | secondSuffix | string | Second suffix enumeration | | thirdSuffix | string | Third suffix enumeration | | prefix | string | M, T, ? enumeration | | firstVowel | string | First Vowel | | secondVowel | string | Second Vowel | | thirdVowel | string | Third Vowel | | fourthVowel | string | Forth Vowel | | vowelCount | number | Total no of vowels in lexeme | | radicalType | string | Radical type enumeration | | form | string | Word form enumeration | ### sedraModel.getLexemeMorphologicalType(morphologicalType) ⇒ LexemeMorphologicalType Get Lexeme Morphological Type object from lexeme bit map **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: LexemeMorphologicalType - Lexeme Morphological Type object | Param | Type | Description | | --- | --- | --- | | morphologicalType | number | Morphological Type 32-bit map | ### sedraModel.getLexeme(id, lexeme, roots) ⇒ FlatLexeme Return flatten lexeme object with parsed attribute and morphological values **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: FlatLexeme - the flatten lexeme model | Param | Type | Description | | --- | --- | --- | | id | number | the id of current lexeme object | | lexeme | Lexeme | lexeme raw object | | roots | Array.<Root> | root list | ### sedraModel.makeWord(lexemeId, word, vocalised, morphologicalType, attributes) ⇒ Word Word records, e.g. 2:8,1:2,"ABHOH;","AaB,oHaOH_;",7405716,129 Id is the position in the array so it is not stored **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: Word - Sedra Word row | Param | Type | Description | | --- | --- | --- | | lexemeId | number | Lexeme Address, e.g. 2 | | word | string | Word, e.g. "ABHOH;" | | vocalised | string | Vocalised Word, e.g. "AaB,oHaOH_;" | | morphologicalType | number | 32-bit map | | attributes | number | 16-bit map | ### sedraModel.makeWordAttribute(seyame, listing, enclitic, lexeme) ⇒ WordAttribute Build Word Attribute object **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: WordAttribute - Word Attribute object | Param | Type | Description | | --- | --- | --- | | seyame | boolean | true if word has seyame | | listing | number | Undocumented | | enclitic | boolean | true if word has enclitics | | lexeme | boolean | true if current word is lexeme | ### sedraModel.getWordAttribute(attributes) ⇒ WordAttribute Get Word Attribute object from word attribute bit map **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: WordAttribute - Word Attribute object | Param | Type | Description | | --- | --- | --- | | attributes | number | 16-bit map | ### sedraModel.makeWordMorphologicalType(suffixGender, suffixPerson, suffixNumber, suffixType, prefixCode, gender, person, number, state, tense, form) ⇒ WordMorphologicalType Build Word Morphological Type object **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: WordMorphologicalType - Word Morphological Type object | Param | Type | Description | | --- | --- | --- | | suffixGender | string | Word Suffix Gender enumeration | | suffixPerson | string | Word Suffix Person enumeration | | suffixNumber | string | Word Suffix Number enumeration | | suffixType | string | Word Suffix Type enumeration | | prefixCode | number | Word Prefix Code | | gender | string | Word Gender enumeration | | person | string | Word Person enumeration | | number | string | Word Number enumeration | | state | string | Word State enumeration | | tense | string | Word Tense enumeration | | form | string | Word Form enumeration | ### sedraModel.getWordMorphologicalType(attributes) ⇒ WordMorphologicalType Get Word Morphological Type object from word bit map **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: WordMorphologicalType - Word Morphological Type object | Param | Type | Description | | --- | --- | --- | | attributes | number | Morphological Type 32-bit map | ### sedraModel.getWord(id, lexeme, lexemes) ⇒ FlatWord Return flatten word object with parsed attribute and morphological values **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: FlatWord - the flatten word model | Param | Type | Description | | --- | --- | --- | | id | number | the id of current word object | | lexeme | Word | word raw object | | lexemes | Array.<Lexeme> | lexeme list | ### sedraModel.makeEnglish(lexemeId, word, before, after, comment, attributes, flag) ⇒ English English meaning, e.g. 3:165,1:97,"cause","without","","",0,0 Id is the position in the database array so it is not stored **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: English - Sedra English row | Param | Type | Description | | --- | --- | --- | | lexemeId | number | Lexeme address, e.g. 97 | | word | string | Meaning, e.g. "cause" | | before | string | String before meaning, e.g. "without" (i.e. without cause) | | after | number | String after meaning, e.g. "" | | comment | number | Comment, e.g. "" | | attributes | number | 16-bit map | | flag | number | 1 bit flag | ### sedraModel.makeEnglishAttribute(commentPosition, commentFont, stringBeforeFont, stringAfterFont, verb, number, gender, form) ⇒ EnglishAttribute Build English Attribute object **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: EnglishAttribute - English Attribute object | Param | Type | Description | | --- | --- | --- | | commentPosition | string | Comment before or after word meaning | | commentFont | string | Normal or Italic | | stringBeforeFont | string | Normal or Italic string before text font | | stringAfterFont | string | Normal or Italic string after text font | | verb | string | None, Transitive or Intransitive | | number | string | Word Number enumeration | | gender | string | Word Gender enumeration | | form | string | Word Form enumeration | ### sedraModel.getEnglishAttribute(attributes) ⇒ EnglishAttribute Get English Attribute object from english attribute bit map **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: EnglishAttribute - English Attribute object | Param | Type | Description | | --- | --- | --- | | attributes | number | 16-bit map | ### sedraModel.getEnglish(id, english, lexemes) ⇒ FlatEnglish Return flatten english object with parsed attribute values **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: FlatEnglish - the flatten english model | Param | Type | Description | | --- | --- | --- | | id | number | the id of current english object | | english | English | english raw object | | lexemes | Array.<Lexeme> | lexeme list | ### sedraModel.makeEtymology(lexemeId, word, attributes) ⇒ Etymology Etymology records, e.g. 4:1,1:1,"a\255h\256r",5 Id is the position in the array so it is not stored **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: Etymology - Sedra Etymology row | Param | Type | Description | | --- | --- | --- | | lexemeId | number | Lexeme address, e.g. 1 | | word | string | Word Origin, e.g. "a\255h\256r" | | attributes | number | 16-bit map | ### sedraModel.makeEtymologyAttribute(language, type) ⇒ EtymologyAttribute Build Etymology Attribute object **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: EtymologyAttribute - Etymology Attribute object | Param | Type | Description | | --- | --- | --- | | language | string | the source language | | type | string | word type enumeration | ### sedraModel.getEtymologyAttribute(attributes) ⇒ EtymologyAttribute Get Etymology Attribute object from etymology attribute bit map **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: EtymologyAttribute - Etymology Attribute object | Param | Type | Description | | --- | --- | --- | | attributes | number | 16-bit map | ### sedraModel.getEtymology(id, etymology, lexemes) ⇒ FlatEtymology Return flatten etymology object with parsed attribute values **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: FlatEtymology - the flatten etymology model | Param | Type | Description | | --- | --- | --- | | id | number | the id of current etymology object | | etymology | Etymology | etymology raw object | | lexemes | Array.<Lexeme> | lexeme list | ### sedraModel.makeBook(id, peshittaId, name, vocalised, english, stats) ⇒ Book Build a Book object **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: Book - Book object | Param | Type | Description | | --- | --- | --- | | id | number | Book Id | | peshittaId | number | Book Eastern Peshitta Id | | name | string | Book Aramaic name | | vocalised | string | Book vocalised Aramaic name | | english | Array.<string> | Book English names: full name followed by abbreviations | | stats | object | Book statistics { chapters, verses, words } | ### sedraModel.sorter(a, b) ⇒ number Callback to sort books by Eastern Peshitta ordering **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: number - sort order | Param | Type | Description | | --- | --- | --- | | a | Book | a book | | b | Book | another book | ### sedraModel.getBook(id) ⇒ Book Get book record with the given id from books array **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: Book - Book object from books array | Param | Type | Description | | --- | --- | --- | | id | number | Book id | ### sedraModel.getBooksByEnglish() ⇒ Object **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: Object - English name to Book hash ### sedraModel.getBookByEnglish(name) ⇒ Book **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: Book - Book object from books array | Param | Type | Description | | --- | --- | --- | | name | string | book English full or short name | ### sedraModel.getBookEnglishNames() ⇒ Array **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: Array - sorted list of book English names ### sedraModel.getNamedReferences() ⇒ Array **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: Array - list of named references ### sedraModel.makeBookGroup(id, name, bookSet) ⇒ BookGroup Build a BookGroup object - a grouping of Peshitta books **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: BookGroup - A Book Group object | Param | Type | Description | | --- | --- | --- | | id | number \| string | Book Group assigned Id | | name | string | Book Group name | | bookSet | Array.<Book> | Book subset from books array | ### sedraModel.getVerseByIndex(index, ubs) ⇒ object Get a verse by its index inside the whole of NT Peshitta **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: object - a hash with verse content, verse, chapter and book number | Param | Type | Description | | --- | --- | --- | | index | number | verse index overall NT Peshitta | | ubs | object | NT Peshitta object hash | ### sedraModel.getIndexByVerseWoChapter(reference, ubs) ⇒ number Get an index by verse reference, leaving out chapter reference indexes **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: number - index | Param | Type | Description | | --- | --- | --- | | reference | object | {book:number, chapter:number, verse:number} reference | | ubs | object | NT Peshitta object hash | ### sedraModel.getIndexByVerse(reference, ubs) ⇒ number Get an index by verse reference with chapter references included **Kind**: static method of [sedraModel](#module_sedraModel) **Returns**: number - index | Param | Type | Description | | --- | --- | --- | | reference | object | {book:number, chapter:number, verse:number} reference | | ubs | object | NT Peshitta object hash |