Skip to main content
Module

x/denops_std/function/mod.ts>spellsuggest

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

Return a List with spelling suggestions to replace {word}. When {max} is given up to this number of suggestions are returned. Otherwise up to 25 suggestions are returned.

When the {capital} argument is given and it's non-zero only suggestions with a leading capital will be given. Use this after a match with 'spellcapcheck'.

{word} can be a badly spelled word followed by other text. This allows for joining two words that were split. The suggestions also include the following text, thus you can replace a line.

{word} may also be a good word. Similar words will then be returned. {word} itself is not included in the suggestions, although it may appear capitalized.

The spelling information for the current window is used. The values of 'spelllang' and 'spellsuggest' are used.

Can also be used as a method:

GetWord()->spellsuggest()

Parameters

denops: Denops
word: unknown
optional
max: unknown
optional
capital: unknown

Returns

Promise<unknown[]>