Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "msime-ja/index"

Index

References

Classes

Interfaces

Type aliases

Variables

Functions

References

Attrs

Re-exports Attrs

MSIMESolver

Re-exports MSIMESolver

Type aliases

KeyComboChooser

KeyComboChooser: (keyCombos: MSIMEKeyCombo[]) => MSIMEKeyCombo

A reducer function that chooses the one key combo from the given key combos and returns it.

Type declaration

Variables

Const DEFAULT_PREFS

DEFAULT_PREFS: Readonly<Preferences> = Object.freeze<Preferences>({acceptSingleN: true,acceptDependentConsonant: true,})

The default preferences of typing.

  • Accepts the key combo of single n to resolve ん.
  • Accepts consonants input depending the next keystrokes.

Functions

getFirstKeyCombos

  • Returns a list of the first possible key combos.

    Parameters

    • goal: string

      A text to be typed.

    Returns MSIMEKeyCombo[]

    A list of key combos for the head of the given text.

keyComboChooser

  • Returns a function that chooses a key combo based on the given preferences.

    A chooser function keeps the reference to the given preferences object, thus any changes in the preference will take effect.

    Parameters

    • Default value prefs: {} = DEFAULT_PREFS

      Preferences of typing.

    Returns KeyComboChooser

    A function that that chooses a key combo from the given list of key combos.

parseKeystrokes

  • parseKeystrokes(keystrokes: string, __namedParameters?: { terminatePending: boolean }): ParsedKeystrokes

  • Parse the given keystrokes.

    Parameters

    • keystrokes: string

      Keystrokes to parse.

    • Default value __namedParameters: { terminatePending: boolean } = {}
      • terminatePending: boolean

        Whether to solve the pending keystrokes anyway.

    Returns ParsedKeystrokes

    Keystrokes of resolved part and pending part.

Generated using TypeDoc