SBL

Defined in: src/schemas/sblAcademic.ts:26

The default schema according to SBL’s academic style guide.

Whereas a new Schema must have all required properties when constructed, this schema is meant to be used as a default so particular properties can be overidden (see example).

If the property is not set, the default value will be used. Each property is documented below with their default values.

Click into each property’s “Overrides” for more information about that property.

Param

schema

a Partial<Schema>

Example

Extend the default schema

 transliterate("שָׁלוֹם", { SHIN: "sh" });
// shālôm

Extends

Schema

Constructors

Constructor

new SBL(schema): SBL

Defined in: src/schemas/sblAcademic.ts:244

Parameters

Parameter	Type
`schema`	`Partial`<`Schema`>

Returns

SBL

Overrides

Schema.constructor

Consonants

ALEF

ALEF: string

Defined in: src/schemas/sblAcademic.ts:86

Default

"ʾ"

Overrides

Schema.ALEF

AYIN

AYIN: string

Defined in: src/schemas/sblAcademic.ts:130

Default

"ʿ"

Overrides

Schema.AYIN

BET

BET: string

Defined in: src/schemas/sblAcademic.ts:88

Default

"b"

Overrides

Schema.BET

BET_DAGESH

BET_DAGESH: string | undefined

Defined in: src/schemas/sblAcademic.ts:90

Default

undefined

Overrides

Schema.BET_DAGESH

DALET

DALET: string

Defined in: src/schemas/sblAcademic.ts:96

Default

"d"

Overrides

Schema.DALET

DALET_DAGESH

DALET_DAGESH: string | undefined

Defined in: src/schemas/sblAcademic.ts:98

Default

undefined

Overrides

Schema.DALET_DAGESH

FINAL_KAF

FINAL_KAF: string

Defined in: src/schemas/sblAcademic.ts:112

Default

"k"

Overrides

Schema.FINAL_KAF

FINAL_MEM

FINAL_MEM: string

Defined in: src/schemas/sblAcademic.ts:120

Default

"m"

Overrides

Schema.FINAL_MEM

FINAL_NUN

FINAL_NUN: string

Defined in: src/schemas/sblAcademic.ts:124

Default

"n"

Overrides

Schema.FINAL_NUN

FINAL_PE

FINAL_PE: string

Defined in: src/schemas/sblAcademic.ts:132

Default

"p"

Overrides

Schema.FINAL_PE

FINAL_TSADI

FINAL_TSADI: string

Defined in: src/schemas/sblAcademic.ts:138

Default

"ṣ"

Overrides

Schema.FINAL_TSADI

GIMEL

GIMEL: string

Defined in: src/schemas/sblAcademic.ts:92

Default

"g"

Overrides

Schema.GIMEL

GIMEL_DAGESH

GIMEL_DAGESH: string | undefined

Defined in: src/schemas/sblAcademic.ts:94

Default

undefined

Overrides

Schema.GIMEL_DAGESH

HE

HE: string

Defined in: src/schemas/sblAcademic.ts:100

Default

"h"

Overrides

Schema.HE

HET

HET: string

Defined in: src/schemas/sblAcademic.ts:106

Default

"ḥ"

Overrides

Schema.HET

KAF

KAF: string

Defined in: src/schemas/sblAcademic.ts:114

Default

"k"

Overrides

Schema.KAF

KAF_DAGESH

KAF_DAGESH: string | undefined

Defined in: src/schemas/sblAcademic.ts:116

Default

undefined

Overrides

Schema.KAF_DAGESH

LAMED

LAMED: string

Defined in: src/schemas/sblAcademic.ts:118

Default

"l"

Overrides

Schema.LAMED

MEM

MEM: string

Defined in: src/schemas/sblAcademic.ts:122

Default

"m"

Overrides

Schema.MEM

NUN

NUN: string

Defined in: src/schemas/sblAcademic.ts:126

Default

"n"

Overrides

Schema.NUN

PE

PE: string

Defined in: src/schemas/sblAcademic.ts:134

Default

"p"

Overrides

Schema.PE

PE_DAGESH

PE_DAGESH: string | undefined

Defined in: src/schemas/sblAcademic.ts:136

Default

undefined

Overrides

Schema.PE_DAGESH

QOF

QOF: string

Defined in: src/schemas/sblAcademic.ts:142

Default

"q"

Overrides

Schema.QOF

RESH

RESH: string

Defined in: src/schemas/sblAcademic.ts:144

Default

"r"

Overrides

Schema.RESH

SAMEKH

SAMEKH: string

Defined in: src/schemas/sblAcademic.ts:128

Default

"s"

Overrides

Schema.SAMEKH

SHIN

SHIN: string

Defined in: src/schemas/sblAcademic.ts:146

Default

"š"

Overrides

Schema.SHIN

SIN

SIN: string

Defined in: src/schemas/sblAcademic.ts:148

Default

"ś"

Overrides

Schema.SIN

TAV

TAV: string

Defined in: src/schemas/sblAcademic.ts:150

Default

"t"

Overrides

Schema.TAV

TAV_DAGESH

TAV_DAGESH: string | undefined

Defined in: src/schemas/sblAcademic.ts:152

Default

undefined

Overrides

Schema.TAV_DAGESH

TET

TET: string

Defined in: src/schemas/sblAcademic.ts:108

Default

"ṭ"

Overrides

Schema.TET

TSADI

TSADI: string

Defined in: src/schemas/sblAcademic.ts:140

Default

"ṣ"

Overrides

Schema.TSADI

VAV

VAV: string

Defined in: src/schemas/sblAcademic.ts:102

Default

"w"

Overrides

Schema.VAV

YOD

YOD: string

Defined in: src/schemas/sblAcademic.ts:110

Default

"y"

Overrides

Schema.YOD

ZAYIN

ZAYIN: string

Defined in: src/schemas/sblAcademic.ts:104

Default

"z"

Overrides

Schema.ZAYIN

Marks

DAGESH

DAGESH: string

Defined in: src/schemas/sblAcademic.ts:52

Default

""

Overrides

Schema.DAGESH

DAGESH_CHAZAQ

DAGESH_CHAZAQ: string | boolean

Defined in: src/schemas/sblAcademic.ts:54

Default

true

Overrides

Schema.DAGESH_CHAZAQ

MAQAF

MAQAF: string

Defined in: src/schemas/sblAcademic.ts:56

Default

"-"

Overrides

Schema.MAQAF

PASEQ

PASEQ: string

Defined in: src/schemas/sblAcademic.ts:58

Default

""

Overrides

Schema.PASEQ

SOF_PASUQ

SOF_PASUQ: string

Defined in: src/schemas/sblAcademic.ts:60

Default

""

Overrides

Schema.SOF_PASUQ

Orthographic Features

ADDITIONAL_FEATURES

ADDITIONAL_FEATURES: (WordFeature | SyllableFeature | ClusterFeature)[] | undefined

Defined in: src/schemas/sblAcademic.ts:219

Default

[
 {
   FEATURE: "syllable",
   HEBREW: /[\u{05B4}\u{05BB}]/u,
   TRANSLITERATION: (syllable, heb, schema) => {
       // matches any syllable with a hiriq or qubuts,
       // and checks for a "long" vowel (i.e a hiriq or qubuts in an accented syllable without a mater)
       const hasMater = syllable.clusters.some((cluster) => cluster.isMater);
       if (syllable.isAccented && !hasMater) {
         const macron = "\u0304";
         const output = syllable.hasVowelName("HIRIQ") ? schema["HIRIQ"] + macron : schema["QUBUTS"] + macron;
         return syllable.text.replace(heb, output.normalize("NFC"));
       }
       return syllable.text;
     }
   },
   {
     FEATURE: "syllable",
     HEBREW: "\u{05BC}",
     TRANSLITERATION: (syllable, heb) => {
       // matches any word with a dagesh,
       // and checks for a euphonic dagesh
       const currWord = syllable?.word?.value;
       const prevWord = currWord?.prev?.value;
       if (!currWord || !prevWord || !prevWord.isInConstruct) {
         return syllable.text;
       }

       if (syllable.prev) {
         return syllable.text;
       }

       return syllable.text.replace(heb, "");
     }
   }
]

Example

Extending SBL with a new feature and keeping the default features

import { SBL, transliterate } from "hebrew-transliteration";

const sbl = new SBL();
const oldFeatures = sbl.ADDITIONAL_FEATURES;
const newFeature = {
 FEATURE: "word",
 HEBREW: "הָאָרֶץ",
 TRANSLITERATION: "The Earth"
}

transliterate("הָאָרֶץ", {
 ADDITIONAL_FEATURES: [...oldFeatures, newFeature],
});

Overrides

Schema.ADDITIONAL_FEATURES

BET_DAGESH

BET_DAGESH: string | undefined

Defined in: src/schemas/sblAcademic.ts:90

Default

undefined

Overrides

Schema.BET_DAGESH

DAGESH_CHAZAQ

DAGESH_CHAZAQ: string | boolean

Defined in: src/schemas/sblAcademic.ts:54

Default

true

Overrides

Schema.DAGESH_CHAZAQ

DALET_DAGESH

DALET_DAGESH: string | undefined

Defined in: src/schemas/sblAcademic.ts:98

Default

undefined

Overrides

Schema.DALET_DAGESH

DIVINE_NAME

DIVINE_NAME: string

Defined in: src/schemas/sblAcademic.ts:154

Default

"yhwh"

Overrides

Schema.DIVINE_NAME

DIVINE_NAME_ELOHIM

DIVINE_NAME_ELOHIM: string | undefined

Defined in: src/schemas/sblAcademic.ts:156

Default

undefined

Overrides

Schema.DIVINE_NAME_ELOHIM

FURTIVE_PATAH

FURTIVE_PATAH: string

Defined in: src/schemas/sblAcademic.ts:64

Default

"a"

Overrides

Schema.FURTIVE_PATAH

GIMEL_DAGESH

GIMEL_DAGESH: string | undefined

Defined in: src/schemas/sblAcademic.ts:94

Default

undefined

Overrides

Schema.GIMEL_DAGESH

HIRIQ_YOD

HIRIQ_YOD: string

Defined in: src/schemas/sblAcademic.ts:66

Default

"î"

Overrides

Schema.HIRIQ_YOD

HOLAM_VAV

HOLAM_VAV: string

Defined in: src/schemas/sblAcademic.ts:74

Default

"ô"

Overrides

Schema.HOLAM_VAV

KAF_DAGESH

KAF_DAGESH: string | undefined

Defined in: src/schemas/sblAcademic.ts:116

Default

undefined

Overrides

Schema.KAF_DAGESH

MS_SUFX

MS_SUFX: string

Defined in: src/schemas/sblAcademic.ts:84

Default

"āyw"

Overrides

Schema.MS_SUFX

ON_COMPLETE?

optional ON_COMPLETE?: (result, context) => string

Defined in: src/schema.ts:1827

A callback that is invoked when transliteration is complete

Parameters

Parameter	Type
`result`	`string`
`context`	{ `original`: `string`; `schema`: `Omit`<`Schema`, `"ON_COMPLETE"`>; `text`: `Text`; }
`context.original`	`string`
`context.schema`	`Omit`<`Schema`, `"ON_COMPLETE"`>
`context.text`	`Text`

Returns

string

Examples

Modifying the result

const schema = new Schema({
  // truncated for brevity
  ON_COMPLETE: (result) => result.replace("th", "t'h"),
});
transliterate("תִתְהַלָּֽל", schema);
// tit'hallāl

Accessing callback arguments

const schema = new Schema({
  // truncated for brevity
  ON_COMPLETE: (result, { original, schema, text }) => {
    console.log("Original Hebrew:", original);
    console.log("Schema value:", schema.PATAH);
    console.log("Word count:", text.words.length);
    return result;
  },
});
transliterate("שָּׁלוֹם", schema);
// "šālôm"
// Original Hebrew: שָּׁלוֹם
// Schema value: a
// Word count: 1

Inherited from

Schema.ON_COMPLETE

PATAH_HE

PATAH_HE: string | undefined

Defined in: src/schemas/sblAcademic.ts:78

Default

undefined

Overrides

Schema.PATAH_HE

PE_DAGESH

PE_DAGESH: string | undefined

Defined in: src/schemas/sblAcademic.ts:136

Default

undefined

Overrides

Schema.PE_DAGESH

QAMATS_HE

QAMATS_HE: string

Defined in: src/schemas/sblAcademic.ts:76

Default

"â"

Overrides

Schema.QAMATS_HE

SEGOL_HE

SEGOL_HE: string | undefined

Defined in: src/schemas/sblAcademic.ts:80

Default

undefined

Overrides

Schema.SEGOL_HE

SEGOL_YOD

SEGOL_YOD: string

Defined in: src/schemas/sblAcademic.ts:70

Default

"ê"

Overrides

Schema.SEGOL_YOD

SHIN

SHIN: string

Defined in: src/schemas/sblAcademic.ts:146

Default

"š"

Overrides

Schema.SHIN

SHUREQ

SHUREQ: string

Defined in: src/schemas/sblAcademic.ts:72

Default

"û"

Overrides

Schema.SHUREQ

SIN

SIN: string

Defined in: src/schemas/sblAcademic.ts:148

Default

"ś"

Overrides

Schema.SIN

STRESS_MARKER

STRESS_MARKER: { exclude?: "never" | "final" | "single"; location: "before-syllable" | "after-syllable" | "before-vowel" | "after-vowel"; mark: string; } | undefined

Defined in: src/schemas/sblAcademic.ts:221

Union Members

Type Literal

{ exclude?: "never" | "final" | "single"; location: "before-syllable" | "after-syllable" | "before-vowel" | "after-vowel"; mark: string; }

exclude?

optional exclude?: "never" | "final" | "single"

Whether to exclude the mark on certain syllables

Default

"never"

Examples

undefined and "never" are the same

const schema = new Schema({
  STRESS_MARKER: {
    location: "after-vowel",
    mark: "\u0301",
   },
});
transliterate("בֹּ֖קֶר י֥וֹם אֶחָֽד׃ ", schema);
// bṓqer yốm ʾeḥā́d

Exclude only single syllable words using "single"

const schema = new Schema({
  STRESS_MARKER: {
    location: "after-vowel",
    mark: "\u0301",
    exclude: "single",
   },
});
transliterate("בֹּ֖קֶר י֥וֹם אֶחָֽד׃ ", schema);
// bṓqer yôm ʾeḥā́d

Exclude when accent is on the final syllable, implicitly excluding single syllable words using "final"

const schema = new Schema({
  STRESS_MARKER: {
    location: "after-vowel",
    mark: "\u0301",
    exclude: "final",
   },
});
transliterate("בֹּ֖קֶר י֥וֹם אֶחָֽד׃ ", schema);
// bṓqer yôm ʾeḥād