-
Notifications
You must be signed in to change notification settings - Fork 15
/
index.d.ts
159 lines (133 loc) · 3.26 KB
/
index.d.ts
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
// Type definitions for The Unofficial Jisho API
// Project: The Unofficial Jisho API
// Definitions by: Damien McMahon https://macoto.co.uk
export interface Radical {
symbol: string;
meaning: string;
}
export interface YomiExample {
example: string;
reading: string;
meaning: string;
}
export interface Piece {
lifted: string;
unlifted: string;
}
export interface Result {
english: string;
kanji: string;
kana: string;
pieces: Piece[];
}
export interface QueryResult {
query: string;
found: boolean;
uri: string;
}
export interface ExampleParseResult extends QueryResult {
results: Result[];
phrase: string;
}
export interface KanjiParseResult extends QueryResult {
taughtIn: string;
jlptLevel: string;
newspaperFrequencyRank: string;
strokeCount: string;
meaning: string;
kunyomi: string[];
onyomi: string[];
onyomiExamples: YomiExample[];
kunyomiExamples: YomiExample[];
radical: Radical;
parts: string[];
strokeOrderDiagramUri: string;
strokeOrderSvgUri: string;
strokeOrderGifUri: string;
}
export interface PhraseScrapeSentence {
english: string;
japanese: string;
pieces: Piece[];
}
export interface PhaseScrapeMeaning {
seeAlsoTerms: string[];
definition: string;
supplemental: string[];
definitionAbstract: string;
tags: string[];
sentences: PhraseScrapeSentence[];
}
export interface PhraseScrapeJapaneseWord {
kanji: string;
kana: string;
}
export interface AudioFile {
uri: string;
mimetype: string;
}
export interface ScrapeParseResult extends QueryResult {
tags: string[];
meanings: PhaseScrapeMeaning[];
otherForms: PhraseScrapeJapaneseWord[];
audio: AudioFile[];
notes: string[];
}
export interface JishoJapaneseWord {
word: string;
reading: string;
}
export interface JishoSenseLink {
text: string;
url: string;
}
export interface JishoWordSource {
language: string;
word: string;
}
export interface JishoWordSense {
english_definitions: string[];
parts_of_speech: string[];
links: JishoSenseLink[];
tags: string[];
see_also: string[];
antonyms: string[];
source: JishoWordSource[];
info: string[];
restrictions: string[];
}
export interface JishoAttribution {
jmdict: boolean;
jmnedict: boolean;
dbpedia: boolean;
}
export interface JishoResult {
slug: string;
is_common: boolean;
tags: string[];
jlpt: string[];
japanese: JishoJapaneseWord[];
senses: JishoWordSense[];
attribution: JishoAttribution;
}
export interface JishoAPIResult {
meta: {
status: number
};
data: JishoResult[];
}
declare class JishoAPI {
constructor ();
getUriForExampleSearch(phrase: string): string;
getUriForKanjiSearch(kanji:string): string;
getUriForPhraseScrape(searchTerm: string): string;
getUriForPhraseSearch(phrase: string): string;
parseExamplePageHtml(pageHtml: string, phrase: string): ExampleParseResult;
parseKanjiPageHtml(pageHtml: string, kanji: string): KanjiParseResult;
parsePhraseScrapeHtml(pageHtml: string, query: string): ScrapeParseResult;
scrapeForPhrase(phrase: string): Promise<ScrapeParseResult>
searchForExamples(phrase: string): Promise<ExampleParseResult>
searchForKanji(kanji: string): Promise<KanjiParseResult>;
searchForPhrase(phrase: string): Promise<JishoAPIResult>
}
export default JishoAPI;