Skip to content

spellcheckContent

Spellchecks content that is not on disk, with the configuration spellcheck would have used for it.

Import:

import { spellcheckContent } from 'obsidian-dev-utils/script-utils/linters/cspell-content';

Signature:

function spellcheckContent(params: SpellcheckContentParams): Promise<string[]>

Parameters:

Parameter Type Description
params SpellcheckContentParams The SpellcheckContentParams.

Returns: Promise<string[]> — A Promise that resolves to the findings, each one the line the spellcheck output would have carried — \<path\>:\<line\>:\<column\> - Unknown word (\<word\>) — or an empty array when there are none.


Links to this page: