harper.js 0.13.0

package/dist/harper.d.ts

@@ -0,0 +1,89 @@
+import { Lint } from 'wasm';
+import { Span } from 'wasm';
+import { Suggestion } from 'wasm';
+
+export { Lint }
+
+export declare type LintConfig = Record<string, boolean | undefined>;
+
+/** A interface for an object that can perform linting actions. */
+export declare interface Linter {
+    /** Complete any setup that is necessary before linting. This may include downloading and compiling the WebAssembly binary.
+     * This setup will complete when needed regardless of whether you call this function.
+     * This function exists to allow you to do this work when it is of least impact to the user experiences (i.e. while you're loading something else). */
+    setup(): Promise<void>;
+    /** Lint the provided text. */
+    lint(text: string): Promise<Lint[]>;
+    /** Apply a suggestion to the given text, returning the transformed result. */
+    applySuggestion(text: string, suggestion: Suggestion, span: Span): Promise<string>;
+    /** Determine if the provided text is likely to be intended to be English.
+     * The algorithm can be described as "proof of concept" and as such does not work terribly well.*/
+    isLikelyEnglish(text: string): Promise<boolean>;
+    /** Determine which parts of a given string are intended to be English, returning those bits.
+     * The algorithm can be described as "proof of concept" and as such does not work terribly well.*/
+    isolateEnglish(text: string): Promise<string>;
+    /** Get the linter's current configuration. */
+    getLintConfig(): Promise<LintConfig>;
+    /** Set the linter's current configuration. */
+    setLintConfig(config: LintConfig): Promise<void>;
+    /** Get the linter's current configuration as JSON. */
+    getLintConfigAsJSON(): Promise<string>;
+    /** Set the linter's current configuration from JSON. */
+    setLintConfigWithJSON(config: string): Promise<void>;
+    /** Convert a string to Chicago-style title case. */
+    toTitleCase(text: string): Promise<string>;
+}
+
+/** A Linter that runs in the current JavaScript context (meaning it is allowed to block the event loop). */
+export declare class LocalLinter implements Linter {
+    private inner;
+    /** Initialize the WebAssembly and construct the inner Linter. */
+    private initialize;
+    setup(): Promise<void>;
+    lint(text: string): Promise<Lint[]>;
+    applySuggestion(text: string, suggestion: Suggestion, span: Span): Promise<string>;
+    isLikelyEnglish(text: string): Promise<boolean>;
+    isolateEnglish(text: string): Promise<string>;
+    getLintConfig(): Promise<LintConfig>;
+    setLintConfig(config: LintConfig): Promise<void>;
+    getLintConfigAsJSON(): Promise<string>;
+    setLintConfigWithJSON(config: string): Promise<void>;
+    toTitleCase(text: string): Promise<string>;
+}
+
+export { Span }
+
+export { Suggestion }
+
+export declare enum SuggestionKind {
+    Replace = 0,
+    Remove = 1
+}
+
+/** A Linter that spins up a dedicated web worker to do processing on a separate thread.
+ * Main benefit: this Linter will not block the event loop for large documents.
+ *
+ * NOTE: This class will not work properly in Node. In that case, just use `LocalLinter`.
+ * Also requires top-level await to work. */
+export declare class WorkerLinter implements Linter {
+    private worker;
+    private requestQueue;
+    private working;
+    constructor();
+    private setupMainEventListeners;
+    setup(): Promise<void>;
+    lint(text: string): Promise<Lint[]>;
+    applySuggestion(text: string, suggestion: Suggestion, span: Span): Promise<string>;
+    isLikelyEnglish(text: string): Promise<boolean>;
+    isolateEnglish(text: string): Promise<string>;
+    getLintConfig(): Promise<LintConfig>;
+    setLintConfig(config: LintConfig): Promise<void>;
+    getLintConfigAsJSON(): Promise<string>;
+    setLintConfigWithJSON(config: string): Promise<void>;
+    toTitleCase(text: string): Promise<string>;
+    /** Run a procedure on the remote worker. */
+    private rpc;
+    private submitRemainingRequests;
+}
+
+export { }