UNPKG

1.17 kBTypeScriptView Raw
1import { AbstractTextLintEngine } from "./engine/textlint-engine-core";
2import { TextLintCore } from "./textlint-core";
3import { TextLintFormatterOption } from "../textlint-interface";
4import { TextlintResult } from "@textlint/kernel";
5/**
6 * TextLintEngine a adapter for TextLintEngineCore.
7 * It aim to pull the whole look together. (TextLintEngine and TextFixEngine)
8 * @deprecated use new APIs https://textlint.github.io/docs/use-as-modules.html#new-apis
9 */
10export declare class TextLintEngine extends AbstractTextLintEngine<TextlintResult> {
11 constructor(...args: any[]);
12 /**
13 * @param {TextLintCore} textlintCore
14 * @returns {function()}
15 */
16 onFile: (textlintCore: TextLintCore) => (file: string) => Promise<TextlintResult>;
17 /**
18 * @param {TextLintCore} textlintCore
19 * @returns {function()}
20 */
21 onText: (textlintCore: TextLintCore) => (text: string, ext: string | undefined) => Promise<TextlintResult>;
22 /**
23 * @param {TextLintFormatterOption} formatterConfig
24 */
25 onFormat: (formatterConfig: TextLintFormatterOption) => (results: TextlintResult[]) => string;
26}
27//# sourceMappingURL=textlint-engine.d.ts.map
\No newline at end of file