Class TaraskConfig

constructor

• new TaraskConfig(options?): TaraskConfig

• Parameters

  • Optionaloptions: {
        abc?: {
            lower?: CallableDict<RegExp>;
            upper?: CallableDict<RegExp>;
        };
        doEscapeCapitalized?: boolean;
        g?: boolean;
        j?: OptionJ;
        leftAngleBracket?: string;
        newLine?: string;
        noFixPlaceholder?: string;
        variations?: Variation;
        wrappers?: null | {
            fix?: TransformString;
            letterH?: TransformString;
            variable?: {
                all: undefined | TransformString;
                first: undefined | TransformString;
                no: undefined | TransformString;
            };
        };
    }

    • Optional Readonlyabc?: {
          lower?: CallableDict<RegExp>;
          upper?: CallableDict<RegExp>;
      }

      Predefined alphabets are in dicts.alphabets.

      Default

      alphabets.cyrillic
      Copy

      • Optional Readonlylower?: CallableDict<RegExp>

      • Optional Readonlyupper?: CallableDict<RegExp>

    • Optional ReadonlydoEscapeCapitalized?: boolean

      If set to false, may cause unwanted changes in acronyms.

      Default

      true
      Copy

    • Optional Readonlyg?: boolean

      Do replace ґ(g) by г(h) in cyrillic alphabet?

      Value	Example
      true	Ґвалт ґвалт
      false	Гвалт гвалт
      true	<tarH>ґ</tarH>валт <tarH>Ґ</tarH>валт
      false	<tarH>г</tarH>валт <tarH>Г</tarH>валт

      Default

      false
      Copy

    • Optional Readonlyj?: OptionJ

      When to replace і(i) by й(j) after vowels	Example
      	яна і ён
      never	яна і ён
      random	яна і ён or яна й ён
      always	яна й ён

      Has no effect with abc set to dicts.alphabets.latinJi.

      Default

      "never"
      Copy

    • Optional ReadonlyleftAngleBracket?: string

      String to replace "<" with.

      Default

      "<"
      Copy

      Example

      "<"
      Copy

    • Optional ReadonlynewLine?: string

      String to replace "\n" with.

      Default

      "\n"
      Copy

      Example

      "<br>"
      Copy

    • Optional ReadonlynoFixPlaceholder?: string

      Placeholder for parts that should not be fixed like those enclosed in < >.

      Not recommended to change.

      Default

      " \ue0fe "
      Copy

    • Optional Readonlyvariations?: Variation

      Which variation is used if a part of word is variable	Example
      	Гродна
      no (main)	Гродна
      first	Горадня
      all	(Гродна|Горадня)

      Default

      "all"
      Copy

    • Optional Readonlywrappers?: null | {
          fix?: TransformString;
          letterH?: TransformString;
          variable?: {
              all: undefined | TransformString;
              first: undefined | TransformString;
              no: undefined | TransformString;
          };
      }

      Used for wrapping changed parts. Predefined dicts are in wrappers.

      If null, wrapping changes will be skipped.

      Default

      null
      Copy

  Returns TaraskConfig

abc

alphabets.cyrillic
Copy

doEscapeCapitalized

true
Copy

g

false
Copy

j

"never"
Copy

leftAngleBracket

"<"
Copy

"<"
Copy

newLine

"\n"
Copy

"<br>"
Copy

noFixPlaceholder

" \ue0fe "
Copy

variations

"all"
Copy

wrappers

null
Copy