Skip to main content
Module

x/denops_std/function/mod.ts>spellbadword

📚 Standard module for denops.vim
Go to Latest
function spellbadword
import { spellbadword } from "https://deno.land/x/denops_std@v6.4.0/function/mod.ts";

Without argument: The result is the badly spelled word under or after the cursor. The cursor is moved to the start of the bad word. When no bad word is found in the cursor line the result is an empty string and the cursor doesn't move.

With argument: The result is the first word in {sentence} that is badly spelled. If there are no spelling mistakes the result is an empty string.

The return value is a list with two items:

  • The badly spelled word or an empty string.

  • The type of the spelling error: "bad" spelling mistake "rare" rare word "local" word only valid in another region "caps" word should start with Capital Example:

    echo spellbadword("the quik brown fox")

      ['quik', 'bad']
    

The spelling information for the current window and the value of 'spelllang' are used.

Can also be used as a method:

GetText()->spellbadword()

Parameters

denops: Denops
optional
sentence: unknown

Returns

Promise<string>