aboutsummaryrefslogtreecommitdiff
path: root/types/ext/dictionary-data-util.d.ts
blob: ddf31e4e286c8eb2474f48fd273c44acb27cfbdf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/*
 * Copyright (C) 2023-2024  Yomitan Authors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

import type * as Dictionary from './dictionary';

export type FrequencyData = {
    frequency: number;
    displayValue: string | null;
};

export type KanjiFrequenciesMap3 = Map<string, FrequencyData>;

export type TermFrequenciesMap1 = Map<string, TermFrequenciesMap2>;

export type TermFrequenciesMap2 = Map<string, TermFrequenciesMap2Data>;

export type TermFrequenciesMap2Data = {
    term: string;
    reading: string | null;
    values: TermFrequenciesMap3;
};

export type KanjiFrequenciesMap1 = Map<string, KanjiFrequenciesMap2>;

export type KanjiFrequenciesMap2 = Map<string, KanjiFrequenciesMap2Data>;

export type KanjiFrequenciesMap2Data = {
    character: string;
    values: KanjiFrequenciesMap3;
};

export type TermFrequenciesMap3 = Map<string, FrequencyData>;

export type DictionaryFrequency<T = unknown> = {
    dictionary: string;
    frequencies: T[];
};

export type TermFrequency = {
    term: string;
    reading: string | null;
    values: FrequencyData[];
};

export type KanjiFrequency = {
    character: string;
    values: FrequencyData[];
};

export type TermFrequencyType = 'popular' | 'rare' | 'normal';

export type GroupedPronunciationInternal = {
    pronunciation: Dictionary.Pronunciation;
    terms: Set<string>;
    reading: string;
};

export type GroupedPronunciation = {
    pronunciation: Dictionary.Pronunciation;
    terms: string[];
    reading: string;
    exclusiveTerms: string[];
    exclusiveReadings: string[];
};

export type DictionaryGroupedPronunciations = {
    dictionary: string;
    pronunciations: GroupedPronunciation[];
};

export type TagGroup = {
    tag: Dictionary.Tag;
    headwordIndices: number[];
};