harper.js 0.72.0 → 1.0.0

package/dist/harper.d.ts

@@ -1,32 +1,26 @@
+/** A version of the Harper WebAssembly binary stored inline as a data URL.
+ * Can be tree-shaken if unused. */
 export declare const binary: BinaryModule;
 
+/** A version of the Harper WebAssembly binary stored inline as a data URL.
+ * Can be tree-shaken if unused. */
 export declare const binaryInlined: BinaryModule;
 
-/** This class aims to define the communication protocol between the main thread and the worker.
- * Note that much of the complication here comes from the fact that we can't serialize function calls or referenced WebAssembly memory.*/
+/** A wrapper around the underlying WebAssembly module that contains Harper's core code. Used to construct a `Linter`, as well as access some miscellaneous other functions. */
 export declare class BinaryModule {
     url: string | URL;
     private inner;
-    constructor(url: string | URL);
+    /** Load a binary from a specified URL. This is the only recommended way to construct this type. */
+    static create(url: string | URL): BinaryModule;
     getDefaultLintConfigAsJSON(): Promise<string>;
     getDefaultLintConfig(): Promise<LintConfig>;
     toTitleCase(text: string): Promise<string>;
     setup(): Promise<void>;
-    createLinter(dialect?: Dialect): Promise<Linter_2>;
-    serializeArg(arg: any): Promise<RequestArg>;
-    serialize(req: DeserializedRequest): Promise<SerializedRequest>;
-    deserializeArg(requestArg: RequestArg): Promise<any>;
-    deserialize(request: SerializedRequest): Promise<DeserializedRequest>;
-}
-
-/** An object that is received by the web worker to request work to be done. */
-export declare interface DeserializedRequest {
-    /** The procedure to be executed. */
-    procName: string;
-    /** The arguments to the procedure */
-    args: any[];
 }
 
+/**
+ * Specifies an English Dialect, often used for linting.
+ */
 export declare enum Dialect {
     American = 0,
     British = 1,
@@ -34,8 +28,6 @@ export declare enum Dialect {
     Canadian = 3,
 }
 
-export declare function isSerializedRequest(v: unknown): v is SerializedRequest;
-
 declare enum Language {
     Plain = 0,
     Markdown = 1,
@@ -125,11 +117,14 @@ export declare interface Linter {
     getLintDescriptionsAsJSON(): Promise<string>;
     /** Get the linting rule descriptions as an object, formatted in Markdown. */
     getLintDescriptions(): Promise<Record<string, string>>;
-    /** Get the linting rule descriptions as a JSON map, formatted in HTML. */
+    /** Get the linting rule descriptions as a JSON map, formatted in HTML.
+     * Wraps the function on the BinaryModule by the same name. */
     getLintDescriptionsHTMLAsJSON(): Promise<string>;
-    /** Get the linting rule descriptions as an object, formatted in HTML */
+    /** Get the linting rule descriptions as an object, formatted in HTML.
+     * Wraps the function on the BinaryModule by the same name. */
     getLintDescriptionsHTML(): Promise<Record<string, string>>;
-    /** Convert a string to Chicago-style title case. */
+    /** Convert a string to Chicago-style title case.
+     Wraps the function on the BinaryModule by the same name. */
     toTitleCase(text: string): Promise<string>;
     /** Ignore future instances of a lint from a previous linting run in future invocations. */
     ignoreLint(source: string, lint: Lint): Promise<void>;
@@ -253,6 +248,7 @@ declare class Linter_2 {
     lint(text: string, language: Language): Lint[];
 }
 
+/** The properties and information needed to construct a Linter. */
 export declare interface LinterInit {
     /** The module or path to the WebAssembly binary. */
     binary: BinaryModule;
@@ -260,15 +256,16 @@ export declare interface LinterInit {
     dialect?: Dialect;
 }
 
-/** The option used to configure the parser for an individual linting operation. */
+/**  Options available to configure Harper's parser for an individual linting operation. */
 export declare interface LintOptions {
     /** The markup language that is being passed. Defaults to `markdown`. */
     language?: 'plaintext' | 'markdown';
 }
 
-/** A Linter that runs in the current JavaScript context (meaning it is allowed to block the event loop).  */
+/** A Linter that runs in the current JavaScript context (meaning it is allowed to block the event loop).
+ * See the interface definition for more details. */
 export declare class LocalLinter implements Linter {
-    binary: BinaryModule;
+    binary: SuperBinaryModule;
     private inner;
     constructor(init: LinterInit);
     private createInner;
@@ -315,22 +312,6 @@ declare class OrganizedGroup {
     lints: Lint[];
 }
 
-/** Serializable argument to a procedure to be run on the web worker. */
-export declare interface RequestArg {
-    json: string;
-    type: SerializableTypes;
-}
-
-export declare type SerializableTypes = 'string' | 'number' | 'boolean' | 'object' | 'Suggestion' | 'Lint' | 'Span' | 'Array' | 'undefined' | 'bigint';
-
-/** An object that is sent to the web worker to request work to be done. */
-export declare interface SerializedRequest {
-    /** The procedure to be executed. */
-    procName: string;
-    /** The arguments to the procedure */
-    args: RequestArg[];
-}
-
 /**
  * A struct that represents two character indices in a string: a start and an end.
  */
@@ -382,7 +363,8 @@ export declare enum SuggestionKind {
 }
 
 /**
- * Represents the summary of linting results.
+ * Represents the summary of linting results and history.
+ * Useful to show linting statistics or insights to the user.
  */
 export declare interface Summary {
     /**
@@ -401,12 +383,18 @@ export declare interface Summary {
     misspelled: Record<string, number>;
 }
 
+declare class SuperBinaryModule extends BinaryModule {
+    createLinter(dialect?: Dialect): Promise<Linter_2>;
+    getBinaryModule(): Promise<any>;
+}
+
 /** 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`. */
 export declare class WorkerLinter implements Linter {
     private binary;
+    private serializer;
     private dialect?;
     private worker;
     private requestQueue;