taraskevizer/dist/pipelines.d.ts

Канвэртацыя акадэмічнага правапісу ў клясычны

/**
 * Builtin pipelines
 *
 * If you want to create your own pipeline
 * based on a builtin one and do it safely, use
 * `pipeline.steps.map` if you need replacing only or
 * `pipeline.steps.flatMap` if you also need to add or remove steps.
 *
 * Then pass the result to {@link pipe}.
 *
 * This way you will depend less on the
 * internal order of the builtin pipeline steps.
 *
 * For cases when you need to replace only {@link steps.taraskevize} in {@link tarask}
 * and have better tree-shaking, you can use {@link _pipe}.
 *
 * @module
 */
import { type TaraskStep } from './steps';
/**
 * Pipeline for changing only the alphabet.
 *
 * The property {@link TaraskConfig.doEscapeCapitalized} is set to `false` during the pipeline execution.
 *
 * To see the full list of steps, check the source code.
 */
export declare const alphabetic: import("./lib").Pipeline;
/**
 * For better tree-shaking instead of `Array.prototype.flatMap`
 *
 * Used by {@link tarask} and {@link phonetic}.
 *
 * @param subPipeline - Steps used instead of [{@link steps.taraskevize}].
 */
export declare const _pipe: (subPipeline: TaraskStep<any>[]) => import("./lib").Pipeline;
/**
 * Pipeline for taraskevizing.
 */
export declare const tarask: import("./lib").Pipeline;
/**
 * Pipeline for phonetizing.
 * @experimental
 */
export declare const phonetic: import("./lib").Pipeline;