AsyncPipeline
AsyncPipeline =
Promise<string>
Defined in: lib/pipe.ts:10
AsyncPipeline(
text,cfg?):Promise<string>
Parameters
Section titled “Parameters”string
{ lower: CallableDict<LowerPattern>; upper?: CallableDict<UpperPattern>; } = ...
Predefined alphabets are in dicts.alphabets.
Default
alphabets.cyrillicabc.lower
Section titled “abc.lower”CallableDict<LowerPattern>
abc.upper?
Section titled “abc.upper?”CallableDict<UpperPattern>
doEscapeCapitalized?
Section titled “doEscapeCapitalized?”boolean = ...
If set to false, may cause unwanted changes in acronyms.
Default
trueboolean = ...
Do replace ґ(g) by г(h) in cyrillic alphabet?
| Value | Example |
|---|---|
| true | Ґвалт ґвалт |
| false | Гвалт гвалт |
| true | <tarH>ґ</tarH>валт <tarH>Ґ</tarH>валт |
| false | <tarH>г</tarH>валт <tarH>Г</tarH>валт |
Default
falseOptionJ = ...
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"leftAngleBracket?
Section titled “leftAngleBracket?”string = ...
String to replace "<" with.
Default
"<"Example
"<"newLine?
Section titled “newLine?”string = ...
String to replace "\n" with.
Default
"\n"Example
"<br>"noFixPlaceholder?
Section titled “noFixPlaceholder?”string = ...
Placeholder for parts that should not be fixed like those enclosed in < >.
Change only if the default value interferes with your text.
Default
" \ue0fe "variations?
Section titled “variations?”Variation = ...
| Which variation is used if a part of word is variable | Example |
|---|---|
| Гродна | |
| no (main) | Гродна |
| first | Горадня |
| all | (Гродна|Горадня) |
Default
"all"wrappers?
Section titled “wrappers?”{ fix?: TransformString; letterH?: TransformString; variable?: VariationWrappers; } | null = ...
Used for wrapping changed parts. Predefined dicts are in wrappers.
If null, wrapping changes will be skipped.
Default
nullReturns
Section titled “Returns”Promise<string>
Properties
Section titled “Properties”steps:
AsyncTaraskStep<any>[]
Defined in: lib/pipe.ts:12