TaraskConfig
Defined in: config.ts:9
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new TaraskConfig(
options?):TaraskConfig
Defined in: config.ts:10
Parameters
Section titled “Parameters”options?
Section titled “options?”Partial<{ abc: { lower: CallableDict<RegExp>; upper?: CallableDict<RegExp>; }; doEscapeCapitalized: boolean; g: boolean; j: OptionJ; leftAngleBracket: string; newLine: string; noFixPlaceholder: string; variations: Variation; wrappers: { fix?: TransformString; letterH?: TransformString; variable?: { all: TransformString; first: TransformString; no: TransformString; }; } | null; }>
Returns
Section titled “Returns”TaraskConfig
Properties
Section titled “Properties”abc:
Alphabet
Defined in: config.ts:22
Predefined alphabets are in dicts.alphabets.
Default
Section titled “Default”alphabets.cyrillicdoEscapeCapitalized
Section titled “doEscapeCapitalized”doEscapeCapitalized:
boolean
Defined in: config.ts:43
If set to false, may cause unwanted changes in acronyms.
Default
Section titled “Default”trueg:
boolean
Defined in: config.ts:67
Do replace ґ(g) by г(h) in cyrillic alphabet?
| Value | Example |
|---|---|
| true | Ґвалт ґвалт |
| false | Гвалт гвалт |
| true | <tarH>ґ</tarH>валт <tarH>Ґ</tarH>валт |
| false | <tarH>г</tarH>валт <tarH>Г</tarH>валт |
Default
Section titled “Default”falsej:
OptionJ
Defined in: config.ts:36
When to replace і(i) by й(j) after vowels |
Example |
|---|---|
яна і ён |
|
| never | яна і ён |
| random | яна і ён or яна й ён |
| always | яна й ён |
Has no effect with abc set to dicts.alphabets.latinJi.
Default
Section titled “Default”"never"leftAngleBracket
Section titled “leftAngleBracket”leftAngleBracket:
string
Defined in: config.ts:95
String to replace "<" with.
Default
Section titled “Default”"<"Example
Section titled “Example”"<"newLine
Section titled “newLine”newLine:
string
Defined in: config.ts:87
String to replace "\n" with.
Default
Section titled “Default”"\n"Example
Section titled “Example”"<br>"noFixPlaceholder
Section titled “noFixPlaceholder”noFixPlaceholder:
string
Defined in: config.ts:104
Placeholder for parts that should not be fixed like those enclosed in < >.
Change only if the default value interferes with your text.
Default
Section titled “Default”" \ue0fe "variations
Section titled “variations”variations:
Variation
Defined in: config.ts:79
| Which variation is used if a part of word is variable | Example |
|---|---|
| Гродна | |
| no (main) | Гродна |
| first | Горадня |
| all | (Гродна|Горадня) |
Default
Section titled “Default”"all"wrappers
Section titled “wrappers”wrappers:
Partial<Wrappers> |null
Defined in: config.ts:53
Used for wrapping changed parts. Predefined dicts are in wrappers.
If null, wrapping changes will be skipped.
Default
Section titled “Default”null