hebrew-transliteration 2.1.2 → 2.2.0

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.
Files changed (31) hide show
  1. package/README.md +17 -0
  2. package/dist/hebCharsTrans.d.ts +6 -0
  3. package/dist/hebCharsTrans.js +56 -0
  4. package/dist/index.d.ts +6 -659
  5. package/dist/index.js +12 -434
  6. package/dist/mapChars.d.ts +10 -0
  7. package/dist/mapChars.js +14 -0
  8. package/dist/remove.d.ts +65 -0
  9. package/dist/remove.js +45 -0
  10. package/dist/rules.d.ts +5 -0
  11. package/dist/rules.js +242 -0
  12. package/dist/schema.d.ts +476 -0
  13. package/dist/schema.js +161 -0
  14. package/dist/schemas/brillAcademic.d.ts +2 -0
  15. package/dist/schemas/brillAcademic.js +74 -0
  16. package/dist/schemas/brillSimple.d.ts +2 -0
  17. package/dist/schemas/brillSimple.js +73 -0
  18. package/dist/schemas/index.d.ts +5 -0
  19. package/dist/schemas/index.js +11 -0
  20. package/dist/schemas/michiganClaremont.d.ts +2 -0
  21. package/dist/schemas/michiganClaremont.js +67 -0
  22. package/dist/schemas/sblAcademicSpirantization.d.ts +2 -0
  23. package/dist/schemas/sblAcademicSpirantization.js +73 -0
  24. package/dist/schemas/sblSimple.d.ts +2 -0
  25. package/dist/schemas/sblSimple.js +70 -0
  26. package/dist/sequence.d.ts +18 -0
  27. package/dist/sequence.js +25 -0
  28. package/dist/transliterate.d.ts +45 -0
  29. package/dist/transliterate.js +88 -0
  30. package/package.json +19 -4
  31. package/dist/index.esm.js +0 -406
package/README.md CHANGED
@@ -68,6 +68,23 @@ heb.transliterate("שָׁלוֹם", { SHIN: "sh" });
68
68
  // shālôm
69
69
  ```
70
70
 
71
+ There are premade schemas as well.
72
+
73
+ ```javascript
74
+ const brillAcademic = require("hebrew-transliteration/schemas").brillAcademic;
75
+
76
+ heb.transliterate("בְּבֵית", brillAcademic)
77
+ // bᵉḇêṯ
78
+ ```
79
+ **Note**: schemas are not endorsed by publishers.
80
+
81
+ The available schemas are:
82
+
83
+ - brillAcademic
84
+ - brillSimple
85
+ - sblAcademicSpirantization
86
+ - sblSimple
87
+
71
88
  If you need a fully customized transliteration, it is best to use the [`Schema`](#schema) constructor:
72
89
 
73
90
  ```javascript
package/dist/hebCharsTrans.d.ts ADDED
@@ -0,0 +1,6 @@
1
+ import { Schema } from "./schema";
2
+ interface map {
3
+ [k: string]: keyof Schema;
4
+ }
5
+ export declare const transliterateMap: map;
6
+ export {};
package/dist/hebCharsTrans.js ADDED
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.transliterateMap = void 0;
4
+ exports.transliterateMap = {
5
+ // niqqud
6
+ "\u{05B0}": "VOCAL_SHEVA",
7
+ "\u{05B1}": "HATAF_SEGOL",
8
+ "\u{05B2}": "HATAF_PATAH",
9
+ "\u{05B3}": "HATAF_QAMATS",
10
+ "\u{05B4}": "HIRIQ",
11
+ "\u{05B5}": "TSERE",
12
+ "\u{05B6}": "SEGOL",
13
+ "\u{05B7}": "PATAH",
14
+ "\u{05B8}": "QAMATS",
15
+ "\u{05B9}": "HOLAM",
16
+ "\u{05BA}": "HOLAM",
17
+ "\u{05BB}": "QUBUTS",
18
+ "\u{05BC}": "DAGESH",
19
+ // "\u{05BD}": "", // HEBREW POINT METEG (U+05BD)
20
+ "\u{05BE}": "MAQAF",
21
+ "\u{05C0}": "PASEQ",
22
+ "\u{05C3}": "SOF_PASUQ",
23
+ "\u{05C7}": "QAMATS_QATAN",
24
+ // consonants
25
+ א: "ALEF",
26
+ ב: "BET",
27
+ ג: "GIMEL",
28
+ ד: "DALET",
29
+ ה: "HE",
30
+ ו: "VAV",
31
+ ז: "ZAYIN",
32
+ ח: "HET",
33
+ ט: "TET",
34
+ י: "YOD",
35
+ ך: "FINAL_KAF",
36
+ כ: "KAF",
37
+ ל: "LAMED",
38
+ ם: "FINAL_MEM",
39
+ מ: "MEM",
40
+ ן: "FINAL_NUN",
41
+ נ: "NUN",
42
+ ס: "SAMEKH",
43
+ ע: "AYIN",
44
+ ף: "FINAL_PE",
45
+ פ: "PE",
46
+ ץ: "FINAL_TSADI",
47
+ צ: "TSADI",
48
+ ק: "QOF",
49
+ ר: "RESH",
50
+ ש: "SHIN",
51
+ ת: "TAV" // HEBREW LETTER TAV (U+05EA)
52
+ // "\u{05EF}": "", // HEBREW YOD TRIANGLE (U+05EF)
53
+ // װ: "", // HEBREW LIGATURE YIDDISH DOUBLE VAV (U+05F0)
54
+ // ױ: "", // HEBREW LIGATURE YIDDISH VAV YOD (U+05F1)
55
+ // ײ: "" // HEBREW LIGATURE YIDDISH DOUBLE YOD (U+05F2)
56
+ };