Interface Voikko

interface Voikko {
    analyze: (word: string) => Analysis[];
    getHyphenationPattern: (word: string) => string;
    grammarErrors: (text: string, language?: string) => GrammarError[];
    hyphenate: (
        word: string,
        separator?: string,
        allowContextChanges?: boolean,
    ) => string;
    sentences: (text: string) => Sentence[];
    setAcceptAllUppercase: (value: boolean) => void;
    setAcceptBulletedListsInGc: (value: boolean) => void;
    setAcceptExtraHyphens: (value: boolean) => void;
    setAcceptFirstUppercase: (value: boolean) => void;
    setAcceptMissingHyphens: (value: boolean) => void;
    setAcceptTitlesInGc: (value: boolean) => void;
    setAcceptUnfinishedParagraphsInGc: (value: boolean) => void;
    setHyphenateUnknownWords: (value: boolean) => void;
    setIgnoreDot: (value: boolean) => void;
    setIgnoreNonwords: (value: boolean) => void;
    setIgnoreNumbers: (value: boolean) => void;
    setIgnoreUppercase: (value: boolean) => void;
    setMinHyphenatedWordLength: (value: boolean) => void;
    setNoUglyHyphenation: (value: boolean) => void;
    setSuggestionStrategy: (suggestionStrategy: SuggestionStrategy) => void;
    spell: (word: string) => boolean;
    suggest: (word: string) => string[];
    terminate: () => void;
    tokens: (text: string) => Token[];
}

Properties

analyze getHyphenationPattern grammarErrors hyphenate sentences setAcceptAllUppercase setAcceptBulletedListsInGc setAcceptExtraHyphens setAcceptFirstUppercase setAcceptMissingHyphens setAcceptTitlesInGc setAcceptUnfinishedParagraphsInGc setHyphenateUnknownWords setIgnoreDot setIgnoreNonwords setIgnoreNumbers setIgnoreUppercase setMinHyphenatedWordLength setNoUglyHyphenation setSuggestionStrategy spell suggest terminate tokens

Properties

analyze

analyze: (word: string) => Analysis[]

Analyze the morphology of given word and return the list of analysis results.

getHyphenationPattern

getHyphenationPattern: (word: string) => string

Return a character pattern that describes the hyphenation of given word.

' ' = no hyphenation at this character, '-' = hyphenation point (character at this position is preserved in the hyphenated form), '=' = hyphentation point (character at this position is replaced by the hyphen.)

grammarErrors

grammarErrors: (text: string, language?: string) => GrammarError[]

Check the given text for grammar errors and return a list of GrammarError objects representing the errors that were found. Unlike the C based API this method accepts multiple paragraphs separated by newline characters.

hyphenate

hyphenate: (
    word: string,
    separator?: string,
    allowContextChanges?: boolean,
) => string

Returns the given word in fully hyphenated form.

sentences

sentences: (text: string) => Sentence[]

Split the given natural language text into a list of Sentence objects.

setAcceptAllUppercase

setAcceptAllUppercase: (value: boolean) => void

Accept words even when all of the letters are in uppercase. Note that this is not the same as setIgnoreUppercase: with this option the word is still checked, only case differences are ignored. Default: true

setAcceptBulletedListsInGc

setAcceptBulletedListsInGc: (value: boolean) => void

(Grammar checking only): Accept paragraphs if they would be valid within bulleted lists. Default: false

setAcceptExtraHyphens

setAcceptExtraHyphens: (value: boolean) => void

(Spell checking only): Allow some extra hyphens in words. This option relaxes hyphen checking rules to work around some unresolved issues in the underlying morphology, but it may cause some incorrect words to be accepted. The exact behaviour (if any) of this option is not specified. Default: false

setAcceptFirstUppercase

setAcceptFirstUppercase: (value: boolean) => void

Accept words even when the first letter is in uppercase (start of sentence etc.) Default: true

setAcceptMissingHyphens

setAcceptMissingHyphens: (value: boolean) => void

(Spell checking only): Accept missing hyphens at the start and end of the word. Some application programs do not consider hyphens to be word characters. This is reasonable assumption for many languages but not for Finnish. If the application cannot be fixed to use proper tokenization algorithm for Finnish, this option may be used to tell libvoikko to work around this defect. Default: false

setAcceptTitlesInGc

setAcceptTitlesInGc: (value: boolean) => void

(Grammar checking only): Accept incomplete sentences that could occur in titles or headings. Set this option to true if your application is not able to differentiate titles from normal text paragraphs, or if you know that you are checking title text. Default: false

setAcceptUnfinishedParagraphsInGc

setAcceptUnfinishedParagraphsInGc: (value: boolean) => void

(Grammar checking only): Accept incomplete sentences at the end of the paragraph. These may exist when text is still being written. Default: false

setHyphenateUnknownWords

setHyphenateUnknownWords: (value: boolean) => void

(Hyphenation only): Hyphenate unknown words. Default: true

setIgnoreDot

setIgnoreDot: (value: boolean) => void

Ignore dot at the end of the word (needed for use in some word processors). If this option is set and input word ends with a dot, spell checking and hyphenation functions try to analyze the word without the dot if no results can be obtained for the original form. Also with this option, string tokenizer will consider trailing dot of a word to be a part of that word. Default: false

setIgnoreNonwords

setIgnoreNonwords: (value: boolean) => void

(Spell checking only): Ignore non-words such as URLs and email addresses. Default: true

setIgnoreNumbers

setIgnoreNumbers: (value: boolean) => void

Ignore words containing numbers. Default: false

setIgnoreUppercase

setIgnoreUppercase: (value: boolean) => void

Accept words that are written completely in uppercase letters without checking them at all. Default: false

setMinHyphenatedWordLength

setMinHyphenatedWordLength: (value: boolean) => void

The minimum length for words that may be hyphenated. This limit is also enforced on individual parts of compound words. Default: 2

setNoUglyHyphenation

setNoUglyHyphenation: (value: boolean) => void

Do not insert hyphenation positions that are considered to be ugly but correct Default: false

setSuggestionStrategy

setSuggestionStrategy: (suggestionStrategy: SuggestionStrategy) => void

Set the suggestion strategy to be used when generating spelling suggestions. Default: TYPO

spell

spell: (word: string) => boolean

Check the spelling of given word. Return true if the word is correct, false if it is incorrect.

suggest

suggest: (word: string) => string[]

a list of suggested spellings for given (misspelled) word. If the given word is correct, the list contains only the word itself

terminate

terminate: () => void

Releases the resources allocated by libvoikko for this instance.

tokens

tokens: (text: string) => Token[]

Split the given natural language text into a list of Token objects.

Settings

Member Visibility

On This Page

Properties