aboutsummaryrefslogtreecommitdiff
path: root/types/ext/mecab.d.ts
blob: fb2475784c94a5eb71a8184786857ec6863562ef (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
/*
 * 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/>.
 */

export type ParseResultRaw = {
    [key: string]: ParseResultLineRaw[];
};

export type ParseResultLineRaw = ParseResultTermRaw[];

export type ParseResultTermRaw = {
    expression?: string;
    reading?: string;
    source?: string;
};

/** The resulting data from an invocation of `parseText`. */
export type ParseResult = {
    /** The dictionary name for the parsed result. */
    name: string;
    /** The resulting parsed terms. */
    lines: ParseFragment[][];
};

/** A fragment of the parsed text. */
export type ParseFragment = {
    /** The term. */
    term: string;
    /** The reading of the term. */
    reading: string;
    /** The source text. */
    source: string;
};