@unglish/word-generator/src/types.ts

A simple generator for creating unglish words.

import { RandomFunction } from "./utils/random";

export interface Phoneme {
  sound: string;
  type: "highVowel" | "midVowel" | "lowVowel" | "glide" | "liquid" | "nasal" | "sibilant" | "voicedFricative" | "voicelessFricative" | "affricate" | "voicedStop" | "voicelessStop";
  // weightings of the phoneme appearing in the respective position
  nucleus?: number; 
  onset?: number;
  coda?: number;
  tense?: boolean;
  // weighting of appearing at the start or end of a word
  startWord: number;
  midWord: number;
  endWord: number;
}

export interface Grapheme {
  phoneme: string;
  form: string;
  origin: number;
  frequency: number;
  onset?: number;
  coda?: number;
  nucleus?: number;
  cluster?: number;
  // weighting of appearing at the start or end of a word
  startWord: number;
  midWord: number;
  endWord: number;
}

export interface WrittenForm {
  clean: string;
  hyphenated: string;
}

export interface Word {
  syllables: Syllable[];
  pronunciation: string;
  written: WrittenForm;
}

export interface Syllable {
  onset: Phoneme[];
  nucleus: Phoneme[];
  coda: Phoneme[];
}

export interface WordGenerationOptions {
  word?: Word;
  seed?: number;
  syllableCount?: number;
  rand?: RandomFunction;
}

export interface WordGenerationContext {
  word: Word;
  syllableCount: number;
  currSyllableIndex: number;
}