@openvanilla/mcbopomofoweb
    Preparing search index...

    Class Service

    The text conversion service used in the Chrome Extension and the MCP server.

    The service provides the following functions:

    • Convert Taiwanese Braille to text
    • Convert ASCII Braille to text
    • Convert text to Bopomofo readings
    • Convert text to Hanyu Pinyin
    • Convert text to HTML Ruby
    • Convert text to Taiwanese Braille
    • Convert text to ASCII Braille
    • Convert text to Bopomofo annotated text (for Bopomofo annotation fonts)
    • Annotate a single character with its Bopomofo reading
    const service = new Service();
    const braille = service.convertTextToBraille("小麥注音");
    const pinyin = service.convertTextToPinyin("中文");
    const ruby = service.convertTextToHtmlRuby("注音");
    Index

    Constructors

    constructor

    Methods

    annotateSingleCharacter appendBpmfReadingsToText convertAsciiBrailleToText convertBpmfToText convertBrailleToText convertTextToAsciiBraille convertTextToBpmfAnnotatedText convertTextToBpmfReadings convertTextToBpmfReadingsWithSpaces convertTextToBraille convertTextToHtmlRuby convertTextToPinyin convertTextToRawReadings generateMermaidGraph getWalkResult setExcludedPhrases setUserPhrases

    Constructors

    Methods

    • Annotates a single character with its Bopomofo reading.

      Parameters

      • input: string

        The character to be annotated.

      • reading: string

        The Bopomofo reading for the character.

      Returns string

      The annotated string representation of the character.

    • Appends Bopomofo readings to the input text.

      Parameters

      • input: string

        The input text.

      Returns string

      The text with Bopomofo readings appended.

      let service = new Service();
      let input = "小麥注音輸入法";
      let output = service.appendBpmfReadingsToText(input);

    • Converts ASCII Braille to text.

      Parameters

      • input: string

        The ASCII Braille input.

      Returns string

      The text output

      const service = new Service();
      const input = "e{`mw\"a/\"?'i/'g/\"q>`";
      const output = service.convertAsciiBrailleToText(input);

    • Converts Taiwanese Braille to text.

      Parameters

      • input: string

        The Unicode Braille input.

      Returns string

      The text output

      const service = new Service();
      const input = "⠑⠪⠈⠍⠺⠐⠁⠌⠐⠹⠄⠊⠌⠄⠛⠌⠐⠟⠜⠈";
      const output = service.convertBrailleToText(input);

    • Converts text to ASCII Braille.

      Parameters

      • input: string

        The text input

      Returns string

      The Braille output

      const service = new Service();
      const input = "小麥注音輸入法";
      const output = service.convertTextToAsciiBraille(input);

    • Converts text to Bopomofo annotated text.

      Parameters

      • input: string

        The text input

      Returns string

      The annotated text output

      let service = new Service();
      let input = "小麥注音輸入法";
      let output = service.convertTextToBpmfAnnotatedText(input);

    • Converts text to Bopomofo readings.

      Parameters

      • input: string

        The text input

      Returns string

      The Bopomofo output

      let service = new Service();
      let input = "小麥注音輸入法";
      let output = service.convertTextToBpmfReadings(input);

    • Converts text to Bopomofo readings with spaces between Chinese characters.

      Parameters

      • input: string

        The text input

      Returns string

      The Bopomofo output with spaces

      let service = new Service();
      let input = "小麥注音";
      let output = service.convertTextToBpmfReadingsWithSpaces(input);
      // Returns: "ㄒㄧㄠˇ ㄇㄞˋ ㄓㄨˋ ㄧㄣ"

    • Converts text to Taiwanese Braille.

      Parameters

      • input: string

        The text input

      Returns string

      The Braille output

      const service = new Service();
      const input = "小麥注音輸入法";
      const output = service.convertTextToBraille(input);

    • Converts text to HTML Ruby

      Parameters

      • input: string

        The text input

      Returns string

      The HTML Ruby output

      let service = new Service();
      let input = "小麥注音輸入法";
      let output = service.convertTextToHtmlRuby(input);

    • Converts Chinese text to Hanyu Pinyin representation.

      This method takes Chinese text as input and returns its romanized form in Hanyu Pinyin. The conversion processes each character individually, converting Bopomofo readings to Pinyin syllables.

      Parameters

      • input: string

        The Chinese text string to be converted to Pinyin

      Returns string

      A string containing the Hanyu Pinyin representation of the input text, with syllables separated by spaces

      const service = new Service();
      const pinyin = service.convertTextToPinyin("中文");
      // Returns: "zhong wen"

    • Converts text to raw Bopomofo readings.

      Parameters

      • input: string

        The text input

      Returns string

      The raw Bopomofo output

      let service = new Service();
      let input = "小麥注音";
      let output = service.convertTextToRawReadings(input);

    • Returns the Viterbi-selected text and its total log-probability score for the given Bopomofo (or keyboard-sequence) input.

      Parameters

      • input: string

        Bopomofo syllables or keyboard sequences.

      • keyboardLayout: BopomofoKeyboardLayout = BopomofoKeyboardLayout.StandardLayout

        The layout used to parse keyboard-sequence tokens.

      Returns { score: number; text: string }

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods