@types/typopo

Installation

npm install --save @types/typopo

Summary

This package contains type definitions for typopo (https://github.com/surfinzap/typopo#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/typopo.

index.d.ts

/**
 * Correct typos
 * @param string - input text for correction
 * @param [locale=en-us] - supported languages: en, sk, cs, rue.
 * @param [configuration] - configuration
 * @returns corrected output
 */
export function fixTypos(string: string, locale?: Locale, configuration?: Configuration): string;

export type Locale = "en-us" | "de-de" | "cs" | "rue" | "sk";

export interface Configuration {
    /**
     * keep Markdown code blocks in your Markdown files
     */
    keepMarkdownCodeBlocks?: boolean | undefined;
    removeLines?: boolean | undefined;
    removeWhitespacesBeforeMarkdownList?: boolean | undefined;
}

export as namespace typopo;

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: none

Credits

These definitions were written by Piotr Błażejewicz.