Package Exports

hebrew-transliteration

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hebrew-transliteration) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

hebrew-transliteration

Transliterate Unicode Hebrew text according to SBL's guidelines

install

npm install --save hebrew-transliteration

example

const heb = require('hebrew-transliteration')
const transliterate = heb.transliterate

transliterate('אֱלֹהִים')
>>> 'ʾĕlōhîm'

DOCS

transliterate

heb.transliterate(text, options = {isSequenced: true, qametsQatan: false})

Takes text <<String>> and [options] <<Object>>.

heb.transliterate('כָּל־הָעָם')
>>> 'kāl-hāʿām'

heb.transliterate('כָּל־הָעָם', {qametsQatan: true})
>>> 'kol-hāʿām'

remove

heb.remove(text, options = {removeVowels: false})

Takes text <<String>> and [options] <<Object>>. With {removeVowels: false}, will only remove cantillation (i.e., accent) marks.

heb.remove('כָּל־הָעָם', {removeVowels: true})
>>> 'כל־העם'

sequence

heb.sequence(text)

Takes text <<String>>. Returns a string of properly sequenced characters according to the SBL Hebrew Font manual.

heb.sequence('\u{5D1}\u{5B0}\u{5BC}\u{5E8}\u{5B5}\u{5D0}\u{5E9}\u{5B4}\u{5C1}\u{596}\u{5D9}\u{5EA}')
>>> '\u{5D1}\u{5BC}\u{5B0}\u{5E8}\u{5B5}\u{5D0}\u{5E9}\u{5C1}\u{5B4}\u{596}\u{5D9}\u{5EA}'

License

MIT

Live

Use it live at charlesLoder.github.io/hebrewTransliteration

v 1.1.0

While no functionality has changed, in transliterate() the options was changed from the misspelled isSeqeunced to isSequenced.

Contributing

Please feel free to Fork, create Pull Requests, or submit issues. This is my first npm package, so any feedback is appreciated!