@keyfox/pochi v0.5.6

pochi

The MS-IME Japanese Input emulation library for JavaScript.

• Documentation

Examples

Keystrokes → text conversion

import { getFirstKeyCombos } from "@keyfox/pochi";

// Which keys should I type to make the text "にっか"?
console.log(getFirstKeyCombos("にっか"));
// [
//   [ { chars: "に", strokes: "ni", attrs: 8 } ]
// ]
// // the return value above indicates there is one solution
// // which is to type "ni" to resolve "に".

// After hitting the key "n" and "i", which key should I type next?
console.log(getNextKeysequencesList("っか"));
// [
//   [ { chars: "っ", strokes: "ltu", attrs: 8 } ],
//   [ { chars: "っ", strokes: "xtu", attrs: 8 } ],
//   [ { chars: "っ", strokes: "ltsu", attrs: 8 } ],
//   [
//     { chars: "っ", strokes: "c", attrs: 2 },
//     { chars: "か", strokes: "ca", attrs: 2 },
//   ],
//   [
//     { chars: "っ", strokes: "k", attrs: 2 },
//     { chars: "か", strokes: "ka", attrs: 2 },
//   ],
// ]
// TL;DR: You have 5 options. Type "ltu", "xtu" or "ltsu" to resolve "っ",
//        or type "kka" or "cca" to resolve "っか".

Typing state machine

import { TypingStateMachine } from "@keyfox/pochi";
const stateMachine = new TypingStateMachine();

// Supply one keystroke
stateMachine.supplyKeystrokes("a");
console.log(stateMachine.text); // "あ"

// MS-IME input keystrokes are available
stateMachine.supplyKeystrokes("yi"); // "yi" resolves into "い"
console.log(stateMachine.text);     // "あい"

// Supply several keystrokes
stateMachine.supplyKeystrokes("shite");
console.log(stateMachine.text); // "あいして"

// Supply an indeterministic keystroke
stateMachine.supplyKeystrokes("r");
console.log(stateMachine.text);               // "あいしてr"
console.log(stateMachine.resolvedText);       // "あいして"
console.log(stateMachine.resolvedKeystrokes); // "ayishite"
console.log(stateMachine.pendingKeystroke);   // "r"

// Keystrokes can be tracked anytime
stateMachine.supplyKeystroke("u");
console.log(stateMachine.text); // "あいしてる"
console.log(stateMachine.keyCombos);
// [
//   [ { chars: "あ", strokes: "a" } ],
//   [ { chars: "い", strokes: "yi" } ],
//   [ { chars: "し", strokes: "shi" } ],
//   [ { chars: "て", strokes: "te" } ],
//   [ { chars: "る", strokes: "ru" } ],
// ]