@unglish/word-generator
Version:
A simple generator for creating unglish words.
19 lines • 991 B
TypeScript
import { WordGenerationContext } from "../types.js";
/**
* Converts an array of syllables into written forms of a word.
*
* @param syllables - An array of Syllable objects representing the phonetic structure of a word.
* @returns A WrittenForm object containing 'clean' and 'hyphenated' versions of the word.
*
* Key features:
* - Handles phoneme-to-grapheme conversion considering position in word and syllable.
* - Applies syllable adjustments (e.g., reduction rules, castling) for more natural spellings.
* - Manages character duplication at segment and syllable boundaries.
* - Inserts soft hyphens (­) between syllables in the hyphenated version.
*
* The resulting WrittenForm object provides both a standard spelling (clean)
* and a version with syllable breaks marked for potential hyphenation (hyphenated).
*/
export declare const generateWrittenForm: (context: WordGenerationContext) => void;
export default generateWrittenForm;
//# sourceMappingURL=write.d.ts.map