Class VocabularyAnalyzer

Index

Constructors

Methods

analyze calculateCoverage getWordEffort hasWord

Constructors

constructor

new VocabularyAnalyzer(referenceLoader?: ReferenceLoader): VocabularyAnalyzer
Parameters
- OptionalreferenceLoader: ReferenceLoader
Returns VocabularyAnalyzer
- Defined in src/utilities/analytics/metrics/vocabulary.ts:42

Methods

analyze

analyze(
    metrics: MetricsResult,
    options?: {
        highEffortThreshold?: number;
        locale?: string;
        lowEffortThreshold?: number;
    },
): VocabularyAnalysis
Analyze vocabulary coverage against core lists
Parameters
- metrics: MetricsResult
- Optionaloptions: { highEffortThreshold?: number; locale?: string; lowEffortThreshold?: number }
Returns VocabularyAnalysis
- Defined in src/utilities/analytics/metrics/vocabulary.ts:49

calculateCoverage

calculateCoverage(
wordList: string[],
metrics: MetricsResult,
): { coverage_percent: number; covered: string[]; missing: string[] }
Calculate coverage percentage for a specific word list
Parameters
- wordList: string[]
- metrics: MetricsResult
Returns { coverage_percent: number; covered: string[]; missing: string[] }
- Defined in src/utilities/analytics/metrics/vocabulary.ts:160

getWordEffort

getWordEffort(word: string, metrics: MetricsResult): number
Get effort for a word, or calculate spelling effort if missing
Parameters
- word: string
- metrics: MetricsResult
Returns number
- Defined in src/utilities/analytics/metrics/vocabulary.ts:191

hasWord

hasWord(word: string, metrics: MetricsResult): boolean
Check if a word is in the board set
Parameters
- word: string
- metrics: MetricsResult
Returns boolean
- Defined in src/utilities/analytics/metrics/vocabulary.ts:202