retext-contractions/lib/index.d.ts

retext plugin to check apostrophes in elided contractions

/**
 * Check apostrophes in contractions.
 *
 * @param {Readonly<Options> | null | undefined} [options]
 *   Configuration (optional).
 * @returns
 *   Transform.
 */
export default function retextContractions(options?: Readonly<Options> | null | undefined): (tree: Root, file: VFile) => undefined;
export type Root = import('nlcst').Root;
export type VFile = import('vfile').VFile;
/**
 * Configuration.
 */
export type Options = {
    /**
     * Include literal phrases (default: `false`);
     * normally they are ignored.
     */
    allowLiterals?: boolean | null | undefined;
    /**
     * Suggest straight (`'`) instead of smart (`’`) apostrophes (default:
     * `false`);
     * see `retext-quotes` if you want to properly check that though.
     */
    straight?: boolean | null | undefined;
};